feat(core): add remote to commit and deprecate fields

[MarcoIeni]

Description

Close #803

Add the remote field so that libraries using git-cliff-core can fill it. git-cliff can later use it after a refactoring.

Motivation and Context

#803 (comment)

How Has This Been Tested?

It's a trivial change, so I haven't tested it.

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.

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 69.23077% with 4 lines in your changes missing coverage. Please review.

Project coverage is 40.48%. Comparing base (08e761c) to head (1f90786).
Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
git-cliff-core/src/contributor.rs	0.00%	2 Missing ⚠️
git-cliff-core/src/changelog.rs	87.50%	1 Missing ⚠️
git-cliff-core/src/commit.rs	50.00%	1 Missing ⚠️

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

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #822      +/-   ##
==========================================
+ Coverage   40.13%   40.48%   +0.36%     
==========================================
  Files          20       21       +1     
  Lines        1645     1648       +3     
==========================================
+ Hits          660      667       +7     
+ Misses        985      981       -4     

Flag	Coverage Δ
unit-tests	40.48% <69.24%> (+0.36%)	⬆️

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.

[MarcoIeni]

I moved the RemoteContributor from the remote module because the remote module is under the remote feature flag.

[orhun]

Thanks for the PR!

I think there are still a couple of steps that we should take to achieve this:

1. Deprecate the github, gitlab, gitea, and bitbucket fields.

This is necessary to avoid confusion between commit.remote and commit.github. Additionally, I'm not certain if the current state of the PR will work well with the integrations.

For deprecation, we can use the #[deprecated()] annotation along with log::warn statements in the application code.

2. Update the feature gates for remote so that the types can be exposed without requiring the integration to be enabled.

This is a good start toward cleaning up the remote module and improving the core API. I'd be fully on board with incorporating these changes along with the suggested improvements!

[MarcoIeni]

Oh, I didn't get you wanted to move from commit.github to commit.remote in git-cliff as well. Cool 😁

Then, I'll work on this 👍

[MarcoIeni]

Update the feature gates for remote so that the types can be exposed without requiring the integration to be enabled.

I extracted the RemoteContributor into git-cliff-core/src/remote_contributor.rs already. Do you think something else is necessary?

Also, please have another look at the PR and let me know there's something else I should do 👍

[orhun]

Thanks for the update on the PR! A couple of points:

1. We should either tune down the log level or check the config once and print warnings to avoid flooding the logs:

2. We need to check for the presence of commit.remote variable alongside of e.g. github::TEMPLATE_VARIABLES constants.

3. I don't like the place where remote_contributor.rs is sitting right now. Maybe we can rename it to contributor.rs or move it somewhere else. (I'm open to other ideas).

4. Would be nice to update the existing examples/configs 🙂

[MarcoIeni]

I addressed all points except 2. Could you handle it since it might be a bit involved? 👀

[orhun]

Looks good! Just needs a bit of tweaks ⚙️

[MarcoIeni]

We are still missing point 2 you mentioned before:

We need to check for the presence of commit.remote variable alongside of e.g. github::TEMPLATE_VARIABLES constants.

The tests are failing because we are not serializing the remote field.

How do you suggest to do this? (feel free to push to the branch if you prefer)

[orhun]

Hmm, that's not good. Why are we not serializing it? I didn't get why the fixtures are failing because using commit.remote.* locally works for me.

[MarcoIeni]

Imo the issue is that the git-cliff cli never sets the remote field of the Commit struct here:
https://github.com/MarcoIeni/git-cliff/blob/aee8952fbdc191aca5663205bf3cd3e76f5f066d/git-cliff-core/src/release.rs#L64

but maybe that is only for the releases, not for the commits.

[MarcoIeni]

CI is green now. Yeah 😎

[orhun]

Perfect, thanks for your contribution @MarcoIeni ❤️

Can you also shoot me an issue about removing the github/gitlab etc. fields for the next release? Currently there is quite a bit of duplication in the context which leads to more memory usage and it would be better to get rid of those things after the next release :)

[MarcoIeni]

Thanks for reviewing and merging. Looking forward for the release!

I created the issue as you asked #856 👍