docs: Clarify stable and canary release processes in documentation #6206
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe documentation for the CI/CD workflow was updated to provide more detailed and structured explanations of both stable and canary release processes. The stable release section now explicitly lists the automated actions performed after merging the version bump PR, including publishing SDKs, updating the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/CICD.md (3)
12-18: Reduce repetition & improve readability in the bullet listThe phrase “A workflow dispatch will be triggered to update …” is repeated three times, making the list verbose. You can shorten each bullet to start with the affected repo while keeping the parallel structure.
- A workflow dispatch will be triggered to update the `clerkjs-proxy` worker in `clerk/sdk-infra-workers`. - A workflow dispatch will be triggered to update the `@clerk/nextjs` version in `clerk/dashboard`. - A workflow dispatch will be triggered to update the generated docs in `clerk/generated-typedoc`. + Dispatch workflows to: + - update the `clerkjs-proxy` worker (`clerk/sdk-infra-workers`) + - bump `@clerk/nextjs` in the dashboard (`clerk/dashboard`) + - regenerate and publish docs (`clerk/generated-typedoc`)This keeps the bullets concise while preserving the same meaning.
19-22: Link wording & private-repo reference“For details regarding the package versioning/publishing process” → “For details on package versioning and publishing”. Slight tightening avoids the double gerund.
Also, consider explicitly calling out that the linked worker docs are private, e.g. “(private, internal)”, so external contributors immediately know access is restricted.
25-29: Fix typos and duplicated sentence
- Missing article: “every time a PR is merged”.
- Word split: “fol lowing”.
- The first and second sentences convey the same trigger; merging them removes redundancy.
-A canary release will be triggered every time PR is merged into `main`. Every commit merged into main will trigger the fol lowing actions: +A canary release is triggered on every commit merged into `main`; it performs the following actions:This clarifies the trigger condition and fixes the typo.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/CICD.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.md`: Follow all instructions, patterns and conventions that are defined in these MD files.
**/*.md: Follow all instructions, patterns and conventions that are defined in these MD files.
⚙️ Source: CodeRabbit Configuration File
List of files the instruction was applied to:
docs/CICD.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: dstaley
PR: clerk/javascript#6116
File: .changeset/tangy-garlics-say.md:1-2
Timestamp: 2025-06-13T16:09:53.061Z
Learning: In the Clerk JavaScript repository, contributors create intentionally empty changeset files (containing only the YAML delimiters) when a PR touches only non-published parts of the codebase (e.g., sandbox assets). This signals that no package release is required, so such changesets should not be flagged as missing content.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-23T12:25:30.457Z
Learning: Follow the established PR template, include tests for all new features, update documentation for API changes, and ensure all CI checks pass before merging.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/monorepo.mdc:0-0
Timestamp: 2025-06-23T12:25:40.214Z
Learning: Release management is automated with Changesets, using semantic versioning and coordinated releases to maintain compatibility between packages.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/global.mdc:0-0
Timestamp: 2025-06-23T12:25:34.662Z
Learning: Development workflow requires making changes in the relevant package under packages/, using playground apps for testing, and following established testing and documentation requirements.
docs/CICD.md (9)
Learnt from: dstaley
PR: clerk/javascript#6116
File: .changeset/tangy-garlics-say.md:1-2
Timestamp: 2025-06-13T16:09:53.061Z
Learning: In the Clerk JavaScript repository, contributors create intentionally empty changeset files (containing only the YAML delimiters) when a PR touches only non-published parts of the codebase (e.g., sandbox assets). This signals that no package release is required, so such changesets should not be flagged as missing content.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/monorepo.mdc:0-0
Timestamp: 2025-06-23T12:25:40.214Z
Learning: Release management is automated with Changesets, using semantic versioning and coordinated releases to maintain compatibility between packages.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-23T12:25:30.457Z
Learning: Follow the established PR template, include tests for all new features, update documentation for API changes, and ensure all CI checks pass before merging.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/development.mdc:0-0
Timestamp: 2025-06-23T12:25:30.457Z
Learning: Maintain comprehensive JSDoc comments for all public APIs to improve documentation and developer experience.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/global.mdc:0-0
Timestamp: 2025-06-23T12:25:34.662Z
Learning: Development workflow requires making changes in the relevant package under packages/, using playground apps for testing, and following established testing and documentation requirements.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/monorepo.mdc:0-0
Timestamp: 2025-06-23T12:25:40.214Z
Learning: All packages are published under the @clerk namespace on npm, ensuring consistent naming and discoverability.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/global.mdc:0-0
Timestamp: 2025-06-23T12:25:34.662Z
Learning: All packages published from this repository must use the @clerk namespace.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/monorepo.mdc:0-0
Timestamp: 2025-06-23T12:25:40.214Z
Learning: Framework packages depend on @clerk/clerk-js for core functionality, while @clerk/shared and @clerk/types provide common utilities and TypeScript definitions used across packages.
Learnt from: CR
PR: clerk/javascript#0
File: .cursor/rules/monorepo.mdc:0-0
Timestamp: 2025-06-23T12:25:40.214Z
Learning: Environment variables prefixed with CLERK_* and NEXT_PUBLIC_CLERK_* are supported for configuration across different environments.
🪛 LanguageTool
docs/CICD.md
[uncategorized] ~16-~16: The official spelling of this programming framework is “Next.js”.
Context: ...ispatch will be triggered to update the @clerk/nextjs version in clerk/dashboard. - A work...
(NODE_JS)
[uncategorized] ~28-~28: The official spelling of this programming framework is “Next.js”.
Context: ...ng the most recent @canary version of @clerk/nextjs. This happens for testing purposes. F...
(NODE_JS)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep/ci
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
Description
Updates the CICD docs to reflect the latest state of the release process.
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit