@dotbase/safe-frame-sync 1.2.2 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -80,3 +80,14 @@ We are using [Semantic Release](https://semantic-release.gitbook.io/semantic-rel
|
|
|
80
80
|
We do not rely on a `NPM_TOKEN` as this is phased out by NPM. Instead we use [Trusted Publishing](https://www.npmjs.com/package/@dotbase/safe-frame-sync/access), which is set up between our npm package and this repository and the publishing Github Action.
|
|
81
81
|
|
|
82
82
|
See `.github/workflows/semantic-release.yml` for the detailed implementation and the [`@dotbase/safe-frame-sync` npm package settings](https://www.npmjs.com/package/@dotbase/safe-frame-sync/access) for the Trusted Publishing settings.
|
|
83
|
+
|
|
84
|
+
## Commit Message Format
|
|
85
|
+
|
|
86
|
+
Semantic Release inspects commit messages on `main` to decide which version bump to apply:
|
|
87
|
+
|
|
88
|
+
- `feat:` triggers a **minor** release.
|
|
89
|
+
- `fix:` triggers a **patch** release.
|
|
90
|
+
- Any commit that contains `BREAKING CHANGE:` (in the body or footer) triggers a **major** release, regardless of the type.
|
|
91
|
+
- Types such as `chore:`, `docs:`, `refactor:`, etc. do **not** trigger a release on their own.
|
|
92
|
+
|
|
93
|
+
Stick to the [Conventional Commits](https://semantic-release.gitbook.io/semantic-release#commit-message-format) format so releases stay automatic and predictable.
|
package/package.json
CHANGED