diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 27d3bd7d87..226e93083e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -148,4 +148,11 @@ On `main` branch, we automatically publish **canary** releases from CI to the `c Canary releases are useful to test early changes that should not be released yet to `next` or `latest`. They are automatically triggered and released after a Pull Request merged into `main`. +### Branch-specific canary releases + +To release a canary version for a specific branch other than the `main` branch, follow these steps: + +1. Create a PR with a branch name that starts with the prefix `preview/`  example: `preview/canary-branch` +2. To avoid creating versions every time we push, to trigger a canary version with your change, the commit message has to contain the trigger string `[publish_preview]` example: `git commit -m"chore(xxx): [publish_preview] test with a commit trigger"` . + Note that canary releases **will not create git tags and version bump commits**.