Skip to content

Commit ec3a946

Browse files
authored
docs: clarify prerelease testing (#942)
1 parent c6e8165 commit ec3a946

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

Diff for: CONTRIBUTING.md

+1
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ To release packages to NPM:
7777
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)
7878
2. When release is published the Github action is triggered. It builds and publishes `#.#.#-prerelease` prereleases (for both packages).
7979
3. Test the prerelease version to make sure that it's working.
80+
* 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.
8081
4. A `production` deployment will be waiting for approval. After it's approved, the `#.#.#` version will be published and set as `latest`
8182

8283
### Catching issues in prerelease

0 commit comments

Comments
 (0)