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): add tag message to release context #713

Merged
merged 6 commits into from
Jun 22, 2024

Conversation

MeitarR
Copy link
Contributor

@MeitarR MeitarR commented Jun 17, 2024

Description

added to the release context the tag's message if it exists

Motivation and Context

closes #623

How Has This Been Tested?

Screenshots / Logs (if applicable)

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.

@MeitarR MeitarR requested a review from orhun as a code owner June 17, 2024 21:18
Copy link

welcome bot commented Jun 17, 2024

Thanks for opening this pull request! Please check out our contributing guidelines! ⛰️

@codecov-commenter
Copy link

codecov-commenter commented Jun 17, 2024

Codecov Report

Attention: Patch coverage is 34.28571% with 23 lines in your changes missing coverage. Please review.

Project coverage is 36.67%. Comparing base (4a3edca) to head (2272b3a).
Report is 4 commits behind head on main.

Files Patch % Lines
git-cliff/src/lib.rs 0.00% 15 Missing ⚠️
git-cliff-core/src/repo.rs 60.00% 8 Missing ⚠️

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

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #713      +/-   ##
==========================================
+ Coverage   36.52%   36.67%   +0.16%     
==========================================
  Files          19       19              
  Lines        1468     1489      +21     
==========================================
+ Hits          536      546      +10     
- Misses        932      943      +11     
Flag Coverage Δ
unit-tests 36.67% <34.29%> (+0.16%) ⬆️

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.

@MeitarR MeitarR marked this pull request as draft June 17, 2024 21:27
@orhun
Copy link
Owner

orhun commented Jun 18, 2024

Looks good at first glance, I can add a proper review if you can fix the CI & polish the implementation 🐻

@MeitarR MeitarR force-pushed the add-tag-message-to-context branch 6 times, most recently from 334931c to bd79b22 Compare June 21, 2024 13:21
@MeitarR MeitarR marked this pull request as ready for review June 21, 2024 14:49
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.

Very nice! I had some comments.

Can you also add a little documentation under website/docs/usage/adding-tag-messages.md?

git-cliff/src/args.rs Outdated Show resolved Hide resolved
git-cliff-core/src/tag.rs Outdated Show resolved Hide resolved
git-cliff-core/src/repo.rs Outdated Show resolved Hide resolved
git-cliff-core/src/repo.rs Outdated Show resolved Hide resolved
git-cliff-core/src/repo.rs Outdated Show resolved Hide resolved
- add to the release context the tag's message if it exists
- add message to the default config
to allow setting the message of the last release in the context
@MeitarR MeitarR force-pushed the add-tag-message-to-context branch from 1f41a6d to ec5d2a9 Compare June 21, 2024 20:39
@MeitarR
Copy link
Contributor Author

MeitarR commented Jun 21, 2024

Very nice! I had some comments.

Can you also add a little documentation under website/docs/usage/adding-tag-messages.md?

Thanks!

added the docs: eafe9b0

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.

LGTM, TYSM!

@orhun orhun changed the title feat: add tag message to release context feat(changelog): add tag message to release context Jun 22, 2024
@orhun orhun merged commit 3eb828e into orhun:main Jun 22, 2024
54 checks passed
@chrichrichri
Copy link

chrichrichri commented Jun 22, 2024

Thanks everybody for implementing this!

@hedon954
Copy link

hedon954 commented Jul 8, 2024

When will this feature be updated to git-cliff-action?

@MeitarR
Copy link
Contributor Author

MeitarR commented Jul 8, 2024

When will this feature be updated to git-cliff-action?

I don't use the github action (I use gitlab) so I'm not 100% sure. But, I guess it's already there and all you need is to use the message variable in the template. As described in the docs

@orhun
Copy link
Owner

orhun commented Jul 27, 2024

Just updated git-cliff-action to use git-cliff 2.4.0: https://github.com/orhun/git-cliff-action/releases/tag/v3.3.0

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.

Allow including tag-message in changelog
5 participants