Skip to content

Commit

Permalink
docs(configuration): add micromatch note for branches configuration key
Browse files Browse the repository at this point in the history
  • Loading branch information
kilianpaquier committed May 6, 2024
1 parent e3a3a38 commit c9355e8
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/usage/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ The branches on which releases should happen. By default **semantic-release** wi
- pre-releases to the `beta` distribution channel from the branch `beta` if it exists
- pre-releases to the `alpha` distribution channel from the branch `alpha` if it exists

**Note**: Branches configuration key accepts [**micromatch**](https://github.com/micromatch/micromatch?tab=readme-ov-file#matching-features) globs.

**Note**: If your repository does not have a release branch, then **semantic-release** will fail with an `ERELEASEBRANCHES` error message. If you are using the default configuration, you can fix this error by pushing a `master` branch.

**Note**: Once **semantic-release** is configured, any user with the permission to push commits on one of those branches will be able to publish a release. It is recommended to protect those branches, for example with [GitHub protected branches](https://docs.github.com/github/administering-a-repository/about-protected-branches).
Expand Down

0 comments on commit c9355e8

Please sign in to comment.