You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> TL;DR: Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`. Read on for more details...
191
+
This repo is configured to use `semantic-release`. Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`.
192
192
193
-
The [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) is called from the `release.yml` GitHub Action workflow to handle version changes and releasing.
194
-
195
-
### Version Changes
196
-
197
-
All version changes should obey [semantic versioning](https://semver.org/) rules:
198
-
1.**MAJOR** version when you make incompatible API changes,
199
-
2.**MINOR** version when you add functionality in a backwards compatible manner, and
200
-
3.**PATCH** version when you make backwards compatible bug fixes.
201
-
202
-
The next version number will be determined from the commit messages since the previous release. Our semantic-release configuration uses the [Angular convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) when analyzing commits:
203
-
* Commits which are prefixed with `fix:` or `perf:` will trigger a `patch` release. Example: `fix: validate input before using`
204
-
* Commits which are prefixed with `feat:` will trigger a `minor` release. Example: `feat: add toggle() method`
205
-
* To trigger a MAJOR release, include `BREAKING CHANGE:` with a space or two newlines in the footer of the commit message
206
-
* Other suggested prefixes which will **NOT** trigger a release: `build:`, `ci:`, `docs:`, `style:`, `refactor:` and `test:`. Example: `docs: adding README for new component`
207
-
208
-
To revert a change, add the `revert:` prefix to the original commit message. This will cause the reverted change to be omitted from the release notes. Example: `revert: fix: validate input before using`.
209
-
210
-
### Releases
211
-
212
-
When a release is triggered, it will:
213
-
* Update the version in `package.json`
214
-
* Tag the commit
215
-
* Create a GitHub release (including release notes)
216
-
* Deploy a new package to NPM
217
-
218
-
### Releasing from Maintenance Branches
219
-
220
-
Occasionally you'll want to backport a feature or bug fix to an older release. `semantic-release` refers to these as [maintenance branches](https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#maintenance-branches).
221
-
222
-
Maintenance branch names should be of the form: `+([0-9])?(.{+([0-9]),x}).x`.
223
-
224
-
Regular expressions are complicated, but this essentially means branch names should look like:
225
-
*`1.15.x` for patch releases on top of the `1.15` release (after version `1.16` exists)
226
-
*`2.x` for feature releases on top of the `2` release (after version `3` exists)
193
+
To learn how to create major releases and release from maintenance branches, refer to the [semantic-release GitHub Action](https://github.com/BrightspaceUI/actions/tree/main/semantic-release) documentation.
0 commit comments