The way I understand the plugin right now are you required to edit the actual changelog.md file before merging to have any comments you want included in the final release (Or would it be editing the PR comment itself?).
I feel like it would be a more useful option to have the action simply include comments made in the Release Pull request.
To avoid abuse/spam should this be an option for the release-config.ts file. Something such as includedCommentAuthors: [<list of author names>] to define users who's comments should be included and maybe also a excludeCommentKey: "<text to exclude the comment for>" to exclude comments containing the provided key (Default could be a html comment like <!-- Ready-release EXCLUDE --> or similar).
Here a quick example with a Mockup GitHub repository called Example/Example with user Example being allowed as commenter.
Plugin creates a new PR with following changelog.md file:
# Changelog
## [1.0.0](https://github.com/Example/Example/releases/tag/1.0.0) - 2024-10-09
### ❤️ Thanks to all contributors! ❤️
@Example
### Enhancement
- Make first proper release! [[#1](https://github.com/Example/Example/pull/1)]
User Example adds the following comment.
Thanks to all Beta-Testers for testing this project. I'm happy to finally release a proper stable release for everyone to use.
As always, make sure to [report issues](https://github.com/Example/Example/issues) should you encounter any.
Ready-release-go would now edit the changelog.md file and PR comment:
# Changelog
## [1.0.0](https://github.com/Example/Example/releases/tag/1.0.0) - 2024-10-09
Thanks to all Beta-Testers for testing this project. I'm happy to finally release a proper stable release for everyone to use.
As always, make sure to [report issues](https://github.com/Example/Example/issues) should you encounter any.
### ❤️ Thanks to all contributors! ❤️
@Example
### Enhancement
- Make first proper release! [[#1](https://github.com/Example/Example/pull/1)]
Merging the PR would now use the changelog in the release itself.
This would help people who use the release's body for things such as releases on other sites, but don't want to first edit the file/comment to make sure the extra info is included.
The way I understand the plugin right now are you required to edit the actual changelog.md file before merging to have any comments you want included in the final release (Or would it be editing the PR comment itself?).
I feel like it would be a more useful option to have the action simply include comments made in the Release Pull request.
To avoid abuse/spam should this be an option for the
release-config.tsfile. Something such asincludedCommentAuthors: [<list of author names>]to define users who's comments should be included and maybe also aexcludeCommentKey: "<text to exclude the comment for>"to exclude comments containing the provided key (Default could be a html comment like<!-- Ready-release EXCLUDE -->or similar).Here a quick example with a Mockup GitHub repository called
Example/Examplewith userExamplebeing allowed as commenter.Plugin creates a new PR with following changelog.md file:
Ready-release-go would now edit the changelog.md file and PR comment:
This would help people who use the release's body for things such as releases on other sites, but don't want to first edit the file/comment to make sure the extra info is included.
I hope this is technically doable.