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

feat(changelog): support splitting commits by lines #101

Merged
merged 8 commits into from
Aug 12, 2022

Conversation

AaronFriel
Copy link
Contributor

Description

Enables splitting commits by line, representing multiple changes in a single commit.

Motivation and Context

To be upfront: this violates "conventional commits". It should remain off by default if conventional commits is to be respected.

This change makes it easier for teams to gradually adopt conventional commits with less friction and a lower barrier to entry.

This also (as a side effect, but not intended) enables squash commits to behave much more nicely when they summarize a set of changes as a unit.

How Has This Been Tested?

This is being tested on the repo https://github.com/pulumi/pulumi-watch along with a GitHub Action that scans pull request bodies to render the eventual changelog.

Screenshots / Output (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@AaronFriel AaronFriel requested a review from orhun as a code owner July 22, 2022 22:40
@AaronFriel
Copy link
Contributor Author

@orhun please let me know if there are any code quality or reservations about merging. Perhaps it would need more warnings about how splitting commits or allowing multiple changes per commit violates the conventional commits standard?

I have an intent to use the feature whether as a fork or upstreamed.

@codecov-commenter
Copy link

Codecov Report

Merging #101 (71b581a) into main (f2968cd) will increase coverage by 1.70%.
The diff coverage is 93.48%.

@@            Coverage Diff             @@
##             main     #101      +/-   ##
==========================================
+ Coverage   42.89%   44.59%   +1.70%     
==========================================
  Files          15       15              
  Lines         998     1034      +36     
  Branches      258      265       +7     
==========================================
+ Hits          428      461      +33     
  Misses        442      442              
- Partials      128      131       +3     
Impacted Files Coverage Δ
git-cliff/src/changelog.rs 76.80% <91.67%> (+2.54%) ⬆️
git-cliff-core/src/config.rs 36.07% <100.00%> (+1.07%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging with some tweaks, thanks! 🐻

@orhun orhun changed the title feat: support splitting commits by lines feat(changelog): support splitting commits by lines Aug 12, 2022
@orhun orhun merged commit e3eae33 into orhun:main Aug 12, 2022
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request Sep 21, 2022
For pin@

## [0.9.0] - 2022-08-16

### Documentation

- Add test repository link to README.md

### Features

- Support splitting commits by lines ([#101](orhun/git-cliff#101))
- Support setting commit SHA while using `--with-commit`
- Add commit author and committer to the context ([#100](orhun/git-cliff#100))

### Miscellaneous Tasks

- Use an alternative method to fetch registry
- Enable building arm64 docker images
- Update the description on Docker Hub on push
- Disable updating the description on Docker Hub
- Add GitHub Sponsors option for funding
- Upgrade dependencies
- Update MSRV to 1.60.0
- Upgrade versions in Dockerfile
- Enable strip option for release profile

### Refactor

- Run clippy for tests
- Use a more concise conversion for string
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants