Skip to content

Commit b88b69b

Browse files
committed
docs: update releasing section in README.md
1 parent 50bcccc commit b88b69b

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,9 +166,11 @@ fi
166166

167167
## Releasing
168168

169-
This project uses [release-please](https://github.com/googleapis/release-please) to automate releases. Commits merged to `main` with `fix:` trigger patch releases, `feat:` triggers minor releases, and `feat!:` or `fix!:` triggers major releases.
169+
This project uses [`semantic-release`](https://github.com/semantic-release/semantic-release) for fully automated releases. When commits following the [Conventional Commits](https://www.conventionalcommits.org/) specification are pushed to `main`, semantic-release automatically determines the next version, updates the changelog, publishes to npm and GitHub Packages, and creates a GitHub release.
170170

171-
When commits land on `main`, release-please creates a release PR. Merging it publishes to npm and GitHub Packages.
171+
- `fix:` commits trigger a **patch** release
172+
- `feat:` commits trigger a **minor** release
173+
- `feat!:` or `fix!:` commits (or commits with a `BREAKING CHANGE:` footer) trigger a **major** release
172174

173175
## License
174176

release.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ export default {
1212
'@semantic-release/git',
1313
{
1414
assets: ['CHANGELOG.md', 'package.json', 'package-lock.json'],
15-
message:
16-
'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
15+
// biome-ignore lint/suspicious/noTemplateCurlyInString: semantic-release template syntax
16+
message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
1717
},
1818
],
1919
'@semantic-release/github',

0 commit comments

Comments
 (0)