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.

Sign up for GitHub

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

Jump to bottom

Autogenerate CHANGELOG.md from conventional commits #872

Closed
liangyuanruo opened this issue Nov 9, 2020 · 0 comments · Fixed by #891
Closed

Autogenerate CHANGELOG.md from conventional commits #872

liangyuanruo opened this issue Nov 9, 2020 · 0 comments · Fixed by #891
Labels
P2 Not urgent, but work on it once you're done with current tasks

Comments

@liangyuanruo
Copy link
Contributor

liangyuanruo commented Nov 9, 2020 •
edited
Loading

Is your feature request related to a problem? Please describe.

A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. Not having a changelog makes it difficult for developers and open source users to understand the major changes during each release.

Additionally, the use of conventional commit messages are hidden away in the git logs, with some effort required for manual release tagging.

Describe the solution you'd like
Use auto-changelog to automatically generate a CHANGELOG.md file each time npm version bump is run

Additional context
One may reference the Form implementation here
@liangyuanruo liangyuanruo added the P2 Not urgent, but work on it once you're done with current tasks label Nov 9, 2020
@LoneRifle LoneRifle mentioned this issue Nov 12, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P2 Not urgent, but work on it once you're done with current tasks
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(changelog): add auto-changelog, npm version hook opengovsg/GoGovSG
1 participant
@liangyuanruo