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): improve skipping via .cliffignore and --skip-commit #413

Merged
merged 4 commits into from
Dec 31, 2023

Conversation

orhun
Copy link
Owner

@orhun orhun commented Dec 27, 2023

Description

This PR improves the skipping commits functionality.

  1. .cliffignore

You can now add a .cliffignore file at the root of your repository and list the commits that will be skipped:

# skip commits by their SHA1

4f88dda8c746173ea59f920b7579b7f6c74bd6c8
10c3194381f2cc4f93eb97404369568882ed8677
  1. --skip-commit

You can skip commits by using this argument as follows:

$ git cliff --skip-commit 10c3194381f2cc4f93eb97404369568882ed8677 \
            --skip-commit 4f88dda8c746173ea59f920b7579b7f6c74bd6c8

Motivation and Context

Closes #390

How Has This Been Tested?

Test fixtures.

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 formatted the code with rustfmt.
  • I checked the lints with clippy.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@codecov-commenter
Copy link

Codecov Report

Attention: 16 lines in your changes are missing coverage. Please review.

Comparison is base (0ca4cdb) 42.42% compared to head (bc60467) 41.75%.

Files Patch % Lines
git-cliff/src/lib.rs 0.00% 16 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #413      +/-   ##
==========================================
- Coverage   42.42%   41.75%   -0.67%     
==========================================
  Files          15       15              
  Lines         995     1011      +16     
==========================================
  Hits          422      422              
- Misses        573      589      +16     
Flag Coverage Δ
unit-tests 41.75% <0.00%> (-0.67%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@orhun orhun changed the title Improve skipping commits feat(changelog): improve skipping via .cliffignore and --skip-commit Dec 31, 2023
@orhun orhun merged commit faa00c6 into main Dec 31, 2023
42 checks passed
@orhun orhun deleted the chore/improve_skipping_commits branch December 31, 2023 14:34
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.

Add configuration option to ignore SHAs from a list file
2 participants