Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatically populate changelog/tag message #13

Open
amyreese opened this issue Oct 27, 2020 · 0 comments
Open

Automatically populate changelog/tag message #13

amyreese opened this issue Oct 27, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@amyreese
Copy link
Member

Description

Currently, when running attribution tag, the tag message template will include a list of commits since the previous tag, but the actual message will be empty. Many projects will keep an ongoing record of release notes in their CHANGELOG.md file leading up to a release, often at the top under a section heading named "next", "upcoming", or whatever the next expected release name will be.

It would be nice for attribution to look at the changelog itself, before generating the tag message template, to look for these common heading names or patterns, and if they exist, copy the contents of that section into the message template. For projects that are diligent about updating the changelog ahead of time, this will make new releases much easier, or at least remove the need to copy/paste the relevant portion of the changelog into the commit message.

For now, this could be done with some basic regex or markdown parsing, but with the potential for configurable changelog templates in the future, using a configurable search mechanism would be useful for allowing users to better specify what attribution should be looking for. The easy way is good enough for now if the configurable method doesn't fit well in the existing workflow.

@amyreese amyreese added the enhancement New feature or request label Oct 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant