fix(release-plz): keep copyright header atop the generated changelog #119

Merged
jwilger merged 1 commit from fix/release-plz-changelog-copyright-header into main 2026-06-13 11:13:16 -07:00
Owner

Summary

Configure release-plz's changelog header so the regenerated CHANGELOG.md
keeps <!-- Copyright 2026 John Wilger --> as its first line.

Rationale

release-plz rewrites CHANGELOG.md from its own template on every release. With
no [changelog] config it used the default # Changelog preamble and dropped
the copyright comment that had been added to the file. The Rust CI job runs
just copyright-headers as its first step, and scripts/copyright-headers.sh
requires the Copyright 2026 John Wilger header within the first five lines of
every *.md file — so the generated release PR (#118) failed CI before any
tests ran. Pinning the changelog header to start with the copyright comment
makes every future release PR satisfy the header check while preserving the
existing Keep-a-Changelog body format.

Verification

  • release-plz update (run locally in the dev shell) regenerates CHANGELOG.md
    with <!-- Copyright 2026 John Wilger --> on line 1, the standard preamble,
    and the unchanged ## [x.y.z](compare) - date + ### Added/Fixed sections.
  • scripts/copyright-headers.sh --check and cargo fmt --all --check pass.

🤖 Generated with Claude Code

## Summary Configure release-plz's changelog `header` so the regenerated `CHANGELOG.md` keeps `<!-- Copyright 2026 John Wilger -->` as its first line. ## Rationale release-plz rewrites `CHANGELOG.md` from its own template on every release. With no `[changelog]` config it used the default `# Changelog` preamble and dropped the copyright comment that had been added to the file. The Rust CI job runs `just copyright-headers` as its first step, and `scripts/copyright-headers.sh` requires the `Copyright 2026 John Wilger` header within the first five lines of every `*.md` file — so the generated release PR (#118) failed CI before any tests ran. Pinning the changelog header to start with the copyright comment makes every future release PR satisfy the header check while preserving the existing Keep-a-Changelog body format. ## Verification - `release-plz update` (run locally in the dev shell) regenerates `CHANGELOG.md` with `<!-- Copyright 2026 John Wilger -->` on line 1, the standard preamble, and the unchanged `## [x.y.z](compare) - date` + `### Added/Fixed` sections. - `scripts/copyright-headers.sh --check` and `cargo fmt --all --check` pass. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
fix(release-plz): keep copyright header atop the generated changelog
All checks were successful
CI / Nix flake check (pull_request) Successful in 2m52s
CI / Request auto_review semantic review (pull_request) Successful in 2s
auto_review auto_review: no findings
CI / Rust CI (pull_request) Successful in 9m21s
4ac793d899
release-plz regenerated CHANGELOG.md with its default `# Changelog` preamble,
dropping the `<!-- Copyright 2026 John Wilger -->` line. `just copyright-headers`
(first step of Rust CI) requires that header within the first five lines, so
every release PR failed CI. Configure the release-plz changelog header to start
with the copyright comment.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
auto-review left a comment

This PR updates the release-plz.toml configuration to ensure that the copyright header is retained at the top of the generated CHANGELOG.md, addressing a CI failure issue. The change appears safe to merge.

LLM usage and cost

This PR updates the `release-plz.toml` configuration to ensure that the copyright header is retained at the top of the generated `CHANGELOG.md`, addressing a CI failure issue. The change appears safe to merge. ## LLM usage and cost - Reasoning (gpt-4o) in=1326 out=141 cost=$0.008745 - Cheap (gpt-4o-mini) in=583 out=42 cost=$0.000113 Estimated total USD: $0.008858 via https://api.openai.com and https://api.openai.com
jwilger deleted branch fix/release-plz-changelog-copyright-header 2026-06-13 11:13:16 -07:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Slipstream/emc!119
No description provided.