feat(changelog): allow adding custom context

[MarcoIeni]

Description

This allows to add custom context from the users of git_cliff_core.

Motivation and Context

I need this in release-plz to inject the crate name in the changelog.
I protyped this in release-plz/release-plz#1399

I guess other people would benefit from this kind of feature as well :)

How Has This Been Tested?

Locally on the branch I showed you.
Not sure if you want to add the method add_context (or a similar approach) to the Changelog struct.
Lmk if you prefer to inject the context in another way 👍

Screenshots / Logs (if applicable)

release-plz/release-plz#916 (comment)

It contains multiple changelog updates (one for each package) in the same changelog file 🤯

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]

Overall LGTM! Can you update one of the tests to verify the behavior of add_context?

[MarcoIeni]

feedback from doing this pr:

• working with cargo nightly for cargo fmt is painful :( consider switching to stable to make the experience of contributors a bit better
• the test git_log was failing with the last commit is not conventional. It took me a while to figure out the issues were my own commits D: I will now force-push, trying to not loose stuff 😅 Usually in PRs I don't respect conventional commits, and then I just squash.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41.90%. Comparing base (d53b905) to head (2f6b1df).
Report is 4 commits behind head on main.

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

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #613      +/-   ##
==========================================
+ Coverage   41.52%   41.90%   +0.38%     
==========================================
  Files          15       15              
  Lines        1072     1079       +7     
==========================================
+ Hits          445      452       +7     
  Misses        627      627              

Flag	Coverage Δ
unit-tests	41.90% <100.00%> (+0.38%)	⬆️

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]

Thanks for the feedback!

• working with cargo nightly for cargo fmt is painful :( consider switching to stable to make the experience of contributors a bit better

I'm curious if there will be a lot of formatting changes, but I guess it is worth a shot. Can you submit an issue for it?

• the test git_log was failing with the last commit is not conventional. It took me a while to figure out the issues were my own commits D: I will now force-push, trying to not loose stuff 😅 Usually in PRs I don't respect conventional commits, and then I just squash.

Yeah, I guess it is better to use a fixed commit instead of last commit for the conventional commit tests.

[MarcoIeni]

Can you submit an issue for it?

Done #618

Yeah, I guess it is better to use a fixed commit instead of last commit for the conventional commit tests.

I decided to delete that check entirely. Let me know if it's fine in #619

Are we ready to merge this in the meantime? 🚀

[orhun]

LGTM!