feat(profiler): support performance profiling via pprof

[aminya]

Description

This adds support for performance profiling, allowing for finding bottlenecks and performance optimizations.

It can be enabled via profiler feature and the bench build profile.

cargo build --profile=bench --features=profiler

Motivation and Context

This allows for debugging performance issues such as #767

How Has This Been Tested?

I tested on the repo mentioned in #767

Screenshots / Logs (if applicable)

This screenshot shows that Git Cliff doesn't have any caching, and it goes over the whole history every time no matter what in the subsequent calls.

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 0% with 23 lines in your changes missing coverage. Please review.

Project coverage is 36.34%. Comparing base (c791418) to head (7c52bb3).
Report is 1 commits behind head on main.

Files	Patch %	Lines
git-cliff/src/profiler.rs	0.00%	16 Missing ⚠️
git-cliff/src/main.rs	0.00%	7 Missing ⚠️

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

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #768      +/-   ##
==========================================
- Coverage   36.89%   36.34%   -0.55%     
==========================================
  Files          19       20       +1     
  Lines        1502     1522      +20     
==========================================
- Hits          554      553       -1     
- Misses        948      969      +21     

Flag	Coverage Δ
unit-tests	36.34% <0.00%> (-0.55%)	⬇️

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]

Loved this PR, thanks a lot! <3

I cleaned up the implementation in 88f93dd, can you take a look and let me know how it looks?

Also, I'm thinking of adding documentation for how to run the profiler. I'm guessing it will be just running cargo run with the profiler features, right?

[orhun]

Also added a CI step so the profiler reports are downloadable for each run. e.g. https://github.com/orhun/git-cliff/actions/runs/10131242627/artifacts/1748030753

[aminya]

Loved this PR, thanks a lot! <3

You're welcome!

The changes look good to me. The CI step would help catching performance regressions in future.

As for the documentation, I suggest the following:

Performance Profiling

Git-cliff can be built with performance profiling instrumentation, which helps with finding bottlenecks. The profiler can be enabled via the profiler feature and the bench build profile.

cargo build --profile=bench --features=profiler

[orhun]

Awesome, thanks!