feat(changelog): add tag message to release context

MeitarR commented 2 weeks ago

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)
[X] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[ ] Documentation (no code change)
[X] Refactor (refactoring production code)
[ ] Other

Checklist:

[x] My code follows the code style of this project.
[x] I have updated the documentation accordingly.
[x] I have formatted the code with rustfmt.
[x] I checked the lints with clippy.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.

welcome[bot] commented 2 weeks ago

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

codecov-commenter commented 2 weeks ago

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 :warning:
git-cliff-core/src/repo.rs	60.00%	8 Missing :warning:

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

Additional details and impacted files

```diff @@ 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](https://app.codecov.io/gh/orhun/git-cliff/pull/713/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Orhun+Parmaks%C4%B1z) | Coverage Δ | | |---|---|---| | [unit-tests](https://app.codecov.io/gh/orhun/git-cliff/pull/713/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Orhun+Parmaks%C4%B1z) | `36.67% <34.29%> (+0.16%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Orhun+Parmaks%C4%B1z#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

orhun commented 2 weeks ago

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

MeitarR commented 1 week ago

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

chrichrichri commented 1 week ago

Thanks everybody for implementing this!

orhun / git-cliff