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(config): add changelog.render_always option #859

Merged
merged 8 commits into from
Sep 21, 2024
Merged

Conversation

orhun
Copy link
Owner

@orhun orhun commented Sep 15, 2024

Description

This PR adds a new option to the configuration file as follows:

[changelog]
render_always = true

The reasoning behind this is that some users might want to always render the changelog, even if there are no changes.

Implemented as a config option to avoid breaking changes.

Motivation and Context

closes #802

How Has This Been Tested?

Test fixtures / locally.

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.

@orhun orhun changed the title feat(config): add changelog.always_render option feat(config): add changelog.render_always option Sep 21, 2024
@codecov-commenter
Copy link

codecov-commenter commented Sep 21, 2024

Codecov Report

Attention: Patch coverage is 9.09091% with 10 lines in your changes missing coverage. Please review.

Project coverage is 39.96%. Comparing base (fbb643b) to head (5f64bc6).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
git-cliff/src/lib.rs 0.00% 6 Missing ⚠️
git-cliff-core/src/changelog.rs 20.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #859      +/-   ##
==========================================
- Coverage   40.15%   39.96%   -0.19%     
==========================================
  Files          21       21              
  Lines        1669     1677       +8     
==========================================
  Hits          670      670              
- Misses        999     1007       +8     
Flag Coverage Δ
unit-tests 39.96% <9.10%> (-0.19%) ⬇️

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 merged commit ad039d5 into main Sep 21, 2024
61 of 63 checks passed
@orhun orhun deleted the feat/always_render branch September 21, 2024 18:06
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.

Support a body template specifically for when there are no contributing commits
2 participants