Skip to content

Commit

Permalink
chore(repo): Improve snapshot release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nikosdouvlis committed Nov 8, 2023
1 parent fcb91f6 commit cabcbab
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/PUBLISH.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ Snapshot releases are a way to release your changes for testing without updating
**Important:**
Before requesting a snapshot release, ensure that your Clerk organization membership status is set to "Public". Otherwise, the snapshot release will fail. To set your status to "Public", follow [these steps](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership).

**Important:**
When using a snapshot release, it's highly recommended you install a specific version directly (eg `npm i @clerk/[email protected]`). Do not use the `@snapshot` tag to get the most recent snapshot release, as this will result in unexpected behavior when another member publishes their own snapshot.

To perform a snapshot release, simply comment `!snapshot` in your PR. Once the packages are built and published (~2mins), [clerk-cookie](https://github.com/clerk-cookie) will post a reply with the published versions ([example](https://github.com/clerk/javascript/pull/1329#issuecomment-1586970784)). Simply install the snap version using `npm install` as usual.

Notes:
Expand Down

0 comments on commit cabcbab

Please sign in to comment.