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

Automatic CHANGELOG #177

Closed
akshay196 opened this issue Mar 19, 2023 · 1 comment · Fixed by #209
Closed

Automatic CHANGELOG #177

akshay196 opened this issue Mar 19, 2023 · 1 comment · Fixed by #209
Assignees
Labels
enhancement New feature or request triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@akshay196
Copy link
Member

Describe the issue you're facing

Current CHANGELOG.md is manually written file which adds an extra work of maintaining it for contributors and maintainers. This is a request to add workflow that automatically generate the CHANGELOG based on git commits (or something else). It reduces the burden out of maintainers' shoulders.

Some well-known tools like conventional-changelog-cli can be used, which is based on Conventional Commits conventions. It is a popular changelog generator option with user-defined customization (for example, ory's changelog) and it follows SemVer practice.

The challenge could be following commit message conventions which itself can be good practice to follow as it keeps the git log clean and easy for everyone.

@meain @niravparikh05 Feel free to know if any other tools available that you've used.

@akshay196 akshay196 added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Mar 19, 2023
@akshay196
Copy link
Member Author

Let me give conventional-changelog-cli a shot.

@akshay196 akshay196 self-assigned this Mar 23, 2023
@akshay196 akshay196 added enhancement New feature or request triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Mar 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant