simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update release triggering section in README

Browse Source
This commit is contained in:
Pierre Vanduynslager 2018-12-31 03:20:13 -05:00
parent 2144f2064f
commit 0d91027e9f
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -77,11 +77,12 @@ Here is an example of the release type that will be done based on a commit messa
### Triggering a release ### Triggering a release
For each new commits added to the release branch (i.e. `master`) with `git push` or by merging a pull request or merging from another branch, a CI build is triggered and runs the `semantic-release` command to make a release if there are codebase changes since the last release that affect the package functionalities. For each new commits added to one of the release branches (for example `master`, `next`, `beta`), with `git push` or by merging a pull request or merging from another branch, a CI build is triggered and runs the `semantic-release` command to make a release if there are codebase changes since the last release that affect the package functionalities.
If you need more control over the timing of releases you have a couple of options: **semantic-release** offers various ways to control the timing, the content and the audience of published releases. See example workflows in the following recipes:
- Publish releases on a distribution channel (for example npm’s [dist-tags](https://docs.npmjs.com/cli/dist-tag)). This way you can keep control over what your users end up using by default, and you can decide when to make an automatically released version available to the stable channel, and promote it. - [Using distribution channels](docs/recipes/distribution-channels.md#publishing-on-distribution-channels)
- Develop on a `dev` branch and merge it to the release branch (i.e. `master`) once you are ready to publish. **semantic-release** will run only on pushes to the release branch. - [Maintenance releases](docs/recipes/maintenance-releases.md#publishing-maintenance-releases)
- [Pre-releases](docs/recipes/pre-releases.md#publishing-pre-releases)
### Release steps ### Release steps