Skip to content

Commit d5765d1

Browse files
Copiloticlanton
andcommitted
Document all published Rush plugins and note which ship built-in
- Add rush-buildxl-graph-plugin to first-party plugins table - Note rush-azure-interactive-auth-plugin secondary plugin - Mark rush-http-build-cache-plugin as built-in in descriptions - Mark rush-amazon-s3 and rush-azure-storage as built-in in descriptions - Update built-in note to include rush-http-build-cache-plugin Co-authored-by: iclanton <5010588+iclanton@users.noreply.github.com>
1 parent 1d6b7dc commit d5765d1

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

websites/rushjs.io/docs/pages/maintainer/using_rush_plugins.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,17 +108,18 @@ The config filename will have the same as the `pluginName`, for example:
108108

109109
| NPM Package | Description |
110110
| :------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------- |
111-
| [@rushstack/rush-amazon-s3-build-cache-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-amazon-s3-build-cache-plugin) | Cloud build cache provider for Amazon S3 |
112-
| [@rushstack/rush-azure-storage-build-cache-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-azure-storage-build-cache-plugin) | Cloud build cache provider for Azure Storage |
111+
| [@rushstack/rush-amazon-s3-build-cache-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-amazon-s3-build-cache-plugin) | Cloud build cache provider for Amazon S3 (ships built-in) |
112+
| [@rushstack/rush-azure-storage-build-cache-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-azure-storage-build-cache-plugin) | Cloud build cache provider for Azure Storage (ships built-in); also provides `rush-azure-interactive-auth-plugin` |
113113
| [@rushstack/rush-bridge-cache-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-bridge-cache-plugin) | Bypasses command execution to populate or restore the build cache from an external orchestrator |
114-
| [@rushstack/rush-http-build-cache-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-http-build-cache-plugin) | Cloud build cache provider using a generic HTTP endpoint |
114+
| [@rushstack/rush-buildxl-graph-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-buildxl-graph-plugin) | Provides access to the Rush build graph for BuildXL integration |
115+
| [@rushstack/rush-http-build-cache-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-http-build-cache-plugin) | Cloud build cache provider using a generic HTTP endpoint (ships built-in) |
115116
| [@rushstack/rush-redis-cobuild-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-redis-cobuild-plugin) | Cobuild lock provider using Redis for distributed builds |
116117
| [@rushstack/rush-resolver-cache-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-resolver-cache-plugin) | Generates a resolver cache file to optimize Node.js module resolution |
117118
| [@rushstack/rush-serve-plugin](https://github.com/microsoft/rushstack/tree/main/rush-plugins/rush-serve-plugin) | Hooks into action execution and runs an Express server to serve project outputs in watch mode |
118119

119-
> **NOTE:** The `@rushstack/rush-amazon-s3-build-cache-plugin` and `@rushstack/rush-azure-storage-build-cache-plugin`
120-
> packages are currently built-in to Rush and enabled automatically. For now, you should NOT register them
121-
> in **rush-plugins.json**.
120+
> **NOTE:** The `@rushstack/rush-amazon-s3-build-cache-plugin`, `@rushstack/rush-azure-storage-build-cache-plugin`,
121+
> and `@rushstack/rush-http-build-cache-plugin` packages currently ship built-in to Rush and are enabled
122+
> automatically. For now, you should NOT register them in **rush-plugins.json**.
122123
>
123124
> This is a temporary accommodation while the plugin framework is still experimental.
124125
> In the next major release of Rush, the build cache packages will need to be configured in standard way.

0 commit comments

Comments
 (0)