Skip to content

Commit

Permalink
ci(release): simplify semantic-release config
Browse files Browse the repository at this point in the history
The `releaseCommitMessageFormat` property is useless in the context of the `@semantic-release/release-notes-generator` plugin. The role of the plugin is to generate release notes only. More concretely speaking, we can see the plugin's behavior as generating and storing a value in a variable which will then be reusable by the other plugins later. No commit will be created nor pushed. That's the role of the plugin `semantic-release-github-pullrequest` (https://github.com/asbiin/semantic-release-github-pullrequest) which will create a PR for the changes made to the `CONTRIBUTING.md` file by the plugin `@semantic-release/changelog` (https://github.com/semantic-release/changelog).

The README file of the plugin can be found here: https://github.com/semantic-release/release-notes-generator. The specific documentation regarding the `releaseCommitMessageFormat` property can be found here: https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/master/versions/2.0.0/README.md#releasecommitmessageformat-string. If new with the `semantic-release` tool, this documentation will be useful: https://semantic-release.gitbook.io/semantic-release/.
  • Loading branch information
Djaytan committed Feb 7, 2024
1 parent 71fff70 commit fc9e9d9
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions .github/release.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ module.exports = {
{type: 'test', section: '✅ Tests'},
{type: 'ci', section: '📦 Continuous Integration'},
{type: 'docs', section: '📖 Documentation'}
],
releaseCommitMessageFormat: 'docs(changelog): release {{currentTag}}',
]
}
}
],
Expand Down

0 comments on commit fc9e9d9

Please sign in to comment.