diff --git a/README.md b/README.md index 9d6b4a250..f6098828e 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ rules_js is just a part Aspect's monorepo developer platform: - _Need help?_ - Best-effort community support is available on the #javascript channel on [Bazel Slack](https://slack.bazel.build/) - Commercial support as a Slack Connect channel is offered by https://aspect.build/services. -- See our other Bazel rules, especially those built for rules_js: +- See [Aspect's Bazel rules](https://docs.aspect.build/rules), especially those built for rules_js: - [rules_ts](https://github.com/aspect-build/rules_ts) - Bazel rules for [TypeScript](http://typescriptlang.org) - [rules_swc](https://github.com/aspect-build/rules_swc) - Bazel rules for [swc](https://swc.rs) - [rules_jest](https://github.com/aspect-build/rules_jest) - Bazel rules to run tests using [Jest](https://jestjs.io) @@ -49,20 +49,6 @@ The ruleset is known to work with: Follow instructions from the release you wish to use: . -To use a commit rather than a release, you can point at any SHA of the repo. - -For example, to use commit `abc123` with `WORKSPACE`: - -1. Replace `url = "https://github.com/aspect-build/rules_js/releases/download/v0.1.0/rules_js-v0.1.0.tar.gz"` - with a GitHub-provided source archive like - `url = "https://github.com/aspect-build/rules_js/archive/abc123.tar.gz"` -1. Replace `strip_prefix = "rules_js-0.1.0"` with `strip_prefix = "rules_js-abc123"` -1. Update the `sha256`. The easiest way to do this is to comment out the line, then Bazel will - print a message with the correct value. - -> Note that GitHub source archives don't have a strong guarantee on the sha256 stability, see -> - ## Usage See the documentation in the [docs](docs/) folder. diff --git a/docs/faq.md b/docs/faq.md index cc104e958..628b65bb6 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -152,4 +152,4 @@ my-workspace/ Note that when following option 2, it might require updating some configuration files which refer to the original output locations. For example, your `tsconfig.json` file might have a `paths` section which points to the `../../dist` folder. -To keep your legacy build system working during the migration, you might want to avoid changing those configuration files in-place. For this purpose, you can use [the `jq` rule](https://docs.aspect.build/bazel-contrib/bazel-lib/v1.0.0/docs/jq-docgen.html#jq) in place of `copy_to_bin`, using a `filter` expression so the copy of the configuration file in `bazel-bin` that's used by the Bazel build can have a different path than the configuration file in the source tree. +To keep your legacy build system working during the migration, you might want to avoid changing those configuration files in-place. For this purpose, you can use [the `jq` rule](https://github.com/bazel-contrib/bazel-lib/blob/main/docs/jq.md) in place of `copy_to_bin`, using a `filter` expression so the copy of the configuration file in `bazel-bin` that's used by the Bazel build can have a different path than the configuration file in the source tree.