ci(release): simplify semantic-release config #529
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jeanbaptisten
approved these changes
Feb 7, 2024
Djaytan
force-pushed
the
ci/simplify-config
branch
from
da01bf9 to
fc9e9d9
Compare
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/.
Djaytan
force-pushed
the
ci/simplify-config
branch
from
fc9e9d9 to
ae0b0b0
Compare
|
|
🎉 This PR is included in version 3.0.3 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 3.0.3 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 3.0.3 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
releaseCommitMessageFormatproperty is useless in the context of the@semantic-release/release-notes-generatorplugin. 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 pluginsemantic-release-github-pullrequest(https://github.com/asbiin/semantic-release-github-pullrequest) which will create a PR for the changes made to theCONTRIBUTING.mdfile 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
releaseCommitMessageFormatproperty 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 thesemantic-releasetool, this documentation will be useful: https://semantic-release.gitbook.io/semantic-release/.