Skip to content

Commit

Permalink
Merge pull request #847 from chromaui/fix-auto-config-2
Browse files Browse the repository at this point in the history
Configure auto with `prerelease` setting and update readme
  • Loading branch information
ghengeveld authored Oct 26, 2023
2 parents ee8cce1 + 1a164bf commit 60cac35
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,14 @@ We use `auto` to automate the release process. Versions are bumped, tags are cre

Additionally, a PR **may** have exactly one of these labels:

- `release` creates a `latest` rather than a `next` release (see below)
- `release` creates a `latest` rather than a `next` release on npm
- `next-release` creates a `next` rather than a `latest` release on npm
- `skip-release` does not create a release at all

We have three types of releases:

- `latest` releases are the general audience production releases, used by most people. Automatically created when merging a PR with the `release` label.
- `next` releases should be valid, working releases that can potentially be used by early adopters of new features, for example to handle a support request. Automatically created when merging a PR without the `release` and `skip-release` labels.
- `next` releases should be valid, working releases that can potentially be used by early adopters of new features, for example to handle a support request. Automatically created when merging a PR with the `next-release` label.
- `canary` releases are intended for testing purposes and should not be used in production, as they may only work against a staging or dev environment. Automatically created on every PR, but does not auto-publush the GitHub Action.

> For GitHub Actions, we publish `chromaui/action-next` and `chromaui/action-canary`. The latter is only published manually, rather than for every PR.
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,8 @@
"released"
],
"shipit": {
"onlyGraduateWithReleaseLabel": true
"onlyGraduateWithReleaseLabel": true,
"prerelease": true
}
},
"docs": "https://www.chromatic.com/docs/cli",
Expand Down

0 comments on commit 60cac35

Please sign in to comment.