Skip to content

Commit a732143

Browse files
authored
docs(repo): Clarify stable and canary release processes in documentation (#6206)
1 parent 22be9f0 commit a732143

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/CICD.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,23 @@ Every time a PR is merged into `main`, an automated canary release will happen.
99

1010
## Stable releases
1111

12-
A stable release will be triggered every time the "ci(repo): Version packages" PR is merged. Once versioning and publishing is done, the `clerk/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.
12+
A stable release will be triggered every time the "ci(repo): Version packages" PR is merged. Once the PR is merged, the following actions will take place:
1313

14-
Actions that will be triggered:
14+
- All SDKs will be published to `npm`, except for those found in the excluded packages list in `.changeset/config.json`, or any packages with `private: true` set in their `package.json` file.
15+
- A workflow dispatch will be triggered to update the `clerkjs-proxy` worker in `clerk/sdk-infra-workers`.
16+
- A workflow dispatch will be triggered to update the `@clerk/nextjs` version in `clerk/dashboard`.
17+
- A workflow dispatch will be triggered to update the generated docs in `clerk/generated-typedoc`.
1518

16-
- `clerk/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated a PR will open. Follow the instructions in the PR to manually release a new `clerkjs-proxy` worker.
19+
For details regarding the package versioning/publishing process, refer to the [Publishing docs](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).
1720

18-
For more details, refer to the [Publishing docs](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).
21+
Refer to the docs in the (private) `clerk/sdk-infra-workers` repo for more details about the `clerkjs-proxy` worker release process.
1922

2023
## Automated canary releases
2124

22-
A canary release will be triggered every time PR is merged into `main`. Once versioning and publishing is done, the `clerk/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.
25+
A canary release will be triggered every time PR is merged into `main`. Every commit merged into main will trigger the following actions:
2326

24-
Actions that will be triggered:
25-
26-
- `clerk/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated and directly committed to `main`. A second workflow will perform a canary release of the `clerkjs-proxy` worker.
27-
- `clerk/accounts`: A new Accounts deployment will take place, using the most recent canary `@clerk/nextjs` version. This change will not be committed to `main`.
27+
- A workflow dispatch will be triggered to update the `clerkjs-proxy` worker in `clerk/sdk-infra-workers`.
28+
- The canary Accounts project will be deployed using the most recent `@canary` version of `@clerk/nextjs`. This happens for testing purposes.
2829

2930
For more details about canary releases, refer to the [Publishing docs](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).
3031

0 commit comments

Comments
 (0)