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

Feature Request: Add a flag to generate just the CHANGELOG.md so it can be edited, and then included with the commit #563

Open
Chowarmaan opened this issue Jul 7, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@Chowarmaan
Copy link

It would be nice to be able to edit the CHANGELOG.md before it is committed as part of the semver process. For instance, I would like to be able to use the current tool to decide what everything should look like, and to write the CHANGELOG.md, but not commit the CHANGELOG.md or tags to the repository. This would allow me to edit the CHANGELOG.md, and correct spelling, or make any other changes. This could then be committed into Git.

Ideally, I could then re-run the command, use the --skipChangeLog flag to not generate the CHANGELOG.md (since it was already generated and subsequently edited) and then the normal tag process would run, and the edited CHANGELOG.md would be in the Git repository before the tag so it was clearly included in the release.

@edbzn edbzn added the enhancement New feature or request label Jul 16, 2022
@edbzn
Copy link
Member

edbzn commented Jul 16, 2022

This is more or less related to #513, I agree we need to be able to edit this file. Maybe we don't need to touch the commit logic as we can commit --amend the changes as a workaround.

@Chowarmaan
Copy link
Author

That would work, and I do use it right now. The only advantage I see in a flag is that you simply do this as part of the versioning process, without having to go back to do the edit and amend. Maybe a flag to simply generate the CHANGELOG.md only, so that it is just another file, then the versioning process could be done with the current flags to not generate a CHANGELOG.md?

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

2 participants