@brightspace-ui-labs/s-html
Advanced tools
Comparing version
@@ -17,3 +17,3 @@ { | ||
"name": "@brightspace-ui-labs/s-html", | ||
"version": "2.1.0", | ||
"version": "2.2.0", | ||
"author": "The StartPolymer Project Authors (https://github.com/StartPolymer/authors)", | ||
@@ -20,0 +20,0 @@ "license": "MIT", |
@@ -70,23 +70,6 @@ # @brightspace-ui-labs/s-html | ||
### Version Changes | ||
## Versioning and Releasing | ||
All version changes should obey [semantic versioning](https://semver.org/) rules: | ||
1. **MAJOR** version when you make incompatible API changes, | ||
2. **MINOR** version when you add functionality in a backwards compatible manner, and | ||
3. **PATCH** version when you make backwards compatible bug fixes. | ||
This repo is configured to use `semantic-release`. Commits prefixed with `fix:` and `feat:` will trigger patch and minor releases when merged to `main`. | ||
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: | ||
* Commits which are prefixed with `fix:` or `perf:` will trigger a `patch` release. Example: `fix: validate input before using` | ||
* Commits which are prefixed with `feat:` will trigger a `minor` release. Example: `feat: add toggle() method` | ||
* To trigger a MAJOR release, include `BREAKING CHANGE:` with a space or two newlines in the footer of the commit message | ||
* Other suggested prefixes which will **NOT** trigger a release: `build:`, `ci:`, `docs:`, `style:`, `refactor:` and `test:`. Example: `docs: adding README for new component` | ||
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`. | ||
### Releases | ||
When a release is triggered, it will: | ||
* Update the version in `package.json` | ||
* Tag the commit | ||
* Create a GitHub release (including release notes) | ||
* Deploy a new package to NPM | ||
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. |
4378
-20.99%75
-18.48%