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: remove spaces at beginning of commit messages when generating changelogs #1906

Merged
merged 1 commit into from
Aug 9, 2023

Conversation

SanchithHegde
Copy link
Member

Type of Change

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

Description

This PR updates the git-cliff templates to remove spaces at the beginning of the commit message.

Motivation and Context

Because of the leading spaces in some commit messages, the offending commits were not being included in the release notes. This PR fixes that.

How did you test it?

Verified that the changelog generated does include the offending commits. One such PR was #1804, which was included in the v1.15.0 tag. For verifying my fix, I generated the changelog using the command: git cliff --config .github/git-cliff-changelog.toml v1.14.1..v1.15.0.

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-bug Category: Bug S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels Aug 9, 2023
@SanchithHegde SanchithHegde requested a review from a team as a code owner August 9, 2023 11:15
@SanchithHegde SanchithHegde self-assigned this Aug 9, 2023
@inventvenkat inventvenkat added this pull request to the merge queue Aug 9, 2023
Merged via the queue into main with commit 7d13226 Aug 9, 2023
10 of 12 checks passed
@inventvenkat inventvenkat deleted the git-cliff-remove-spaces-at-beginning branch August 9, 2023 12:16
@SanchithHegde SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label Aug 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: Bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants