From 0d91027e9f4e655de95cb3b5b1f71b87f07308d8 Mon Sep 17 00:00:00 2001 From: Pierre Vanduynslager Date: Mon, 31 Dec 2018 03:20:13 -0500 Subject: [PATCH] docs: update release triggering section in README --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a50b090e..c8aa2ec5 100644 --- a/README.md +++ b/README.md @@ -77,11 +77,12 @@ Here is an example of the release type that will be done based on a commit messa ### 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: -- 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. -- 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. +**semantic-release** offers various ways to control the timing, the content and the audience of published releases. See example workflows in the following recipes: +- [Using distribution channels](docs/recipes/distribution-channels.md#publishing-on-distribution-channels) +- [Maintenance releases](docs/recipes/maintenance-releases.md#publishing-maintenance-releases) +- [Pre-releases](docs/recipes/pre-releases.md#publishing-pre-releases) ### Release steps