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

chore: add git-cliff configs for generating changelogs and release notes #1047

Merged
merged 2 commits into from
May 4, 2023

Conversation

SanchithHegde
Copy link
Member

@SanchithHegde SanchithHegde commented May 4, 2023

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

This PR adds configuration files for git-cliff for generating changelogs and release notes. In addition, this PR increases the heading levels for each heading in CHANGELOG.md file to align with the changelogs generated by git-cliff.

To update the CHANGELOG.md file with the unreleased commits, you can run:

git-cliff --config .github/git-cliff-changelog.toml --unreleased --prepend CHANGELOG.md

To generate release notes for a GitHub release with contributor mentions (you'll also need another tool (disclaimer: I built this) to substitute committer emails with their GitHub usernames):

git-cliff --config .github/git-cliff-release.toml --unreleased | changelog-gh-usernames

This would print the release notes to console, you can pipe it to a tool that copies it to your system clipboard as required.

For the release notes however, there are some cases where we can't consistently obtain GitHub usernames, in which case it would have to be done manually.

Refer to usage information of both of these tools for more complex use cases.

Motivation and Context

Better structured changelogs and release notes.

How did you test it?

Manually.

Checklist

  • I formatted the code cargo +nightly fmt --all
  • I addressed lints thrown by cargo clippy
  • I reviewed submitted code
  • I added unit tests for my changes where possible
  • I added a CHANGELOG entry if applicable

@SanchithHegde SanchithHegde added C-doc Category: Documentation updates S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels May 4, 2023
@SanchithHegde SanchithHegde self-assigned this May 4, 2023
@SanchithHegde SanchithHegde requested a review from a team as a code owner May 4, 2023 07:24
@jarnura jarnura removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label May 4, 2023
@jarnura jarnura merged commit 68360d4 into main May 4, 2023
@jarnura jarnura deleted the git-cliff-configs branch May 4, 2023 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-doc Category: Documentation updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants