Skip to content

Commit

Permalink
docs: clarify prerelease testing (#942)
Browse files Browse the repository at this point in the history
  • Loading branch information
clample committed Mar 12, 2024
1 parent c6e8165 commit ec3a946
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ To release packages to NPM:
1. Publish a Github Release with a valid tag `#.#.#` and click the `Generate release notes` button to auto-generate notes following format defined [here](https://github.com/checkly/checkly-cli/blob/main/.github/release.yml)
2. When release is published the Github action is triggered. It builds and publishes `#.#.#-prerelease` prereleases (for both packages).
3. Test the prerelease version to make sure that it's working.
* To test `npm create checkly`, run `CHECKLY_CLI_VERSION=4.6.2 npm create [email protected]` (substituting `4.6.2` and `4.6.2-prerelease` for your versions). `CHECKLY_CLI_VERSION` is needed since the `create-checkly` package looks up the corresponding tag on GitHub to pull project templates.
4. A `production` deployment will be waiting for approval. After it's approved, the `#.#.#` version will be published and set as `latest`

### Catching issues in prerelease
Expand Down

0 comments on commit ec3a946

Please sign in to comment.