orhun/git-cliff

`--prepend` cannot reliably identify the previous header

Open

#712 opened on Jun 17, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (308 forks)auto 404
bughelp wanted

Repository metrics

Stars
 (12,040 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there an existing issue for this?

  • I have searched the existing issues

Description of the bug

The CLI argument --prepend is supposed to result in git-cliff injecting the changelog for recent releases into an existing changelog.

  1. Remove the old header.
  2. Prepend the new releases' bodies.
  3. Prepend the new header.

Step 1 relied on the header being static between runs of git-cliff. It performed a simple string comparison between the existing CHANGELOG.md and the current value in the changelog.header variable. Since #697, changelog.header contains a template. Thus its value might change between runs and thus prevent detecting the old header.

Steps To Reproduce

  1. Set changelog.header to a template such that the output after rendering changes between releases.
  2. Create a new release.
  3. Run git-cliff with the --prepend flag.

Expected behavior

git-cliff should properly detect and replace the old header.

Screenshots / Logs

No response

Software information

  • After PR #698

Additional context

No response

Contributor guide

Research direction
Examine the prepend implementation in the main changelog generation logic. Identify how the header is currently matched and understand the impact of templating on static header comparison. Consider alternative approaches for detecting and replacing the old header when it is generated from a template.
Tech stack
rust
Domain
cli
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55