feat: replace changelog generation with git-cliff#90
Merged
Conversation
Replace triple-stacked changelog generators (BobAnkh, custom script, GitHub generateReleaseNotes) with git-cliff in both the cookiecutter template and the cookiecutter repo itself. Changes to generated projects (template): - Add cliff.toml with conventional commit parsing and GitHub links - Add git-cliff to dev dependencies - Replace poe changelog/release-notes tasks with git-cliff commands - Add publish preflight checks (main branch + clean tree) - Update release workflow to use git-cliff for release notes + CHANGELOG Changes to cookiecutter repo: - Same git-cliff setup for the repo's own releases - Add preflight checks to release tasks Closes #89 Authored by Jny
The cookiecutter template directory's cliff.toml contains git-cliff
Tera template syntax (self::remote_url(), trim_start_matches, etc.)
that conflicts with Jinja2 processing during project generation.
Wrap non-cookiecutter template expressions in {% raw %}...{% endraw %}
blocks so Jinja2 passes them through untouched while still expanding
cookiecutter.github_username and cookiecutter.package_name.
Authored by Jny
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replace triple-stacked changelog generators with git-cliff in both the cookiecutter template and the repo itself.
Problem
Same issue as busylight-core#55: three overlapping changelog generators (BobAnkh, custom git log script, GitHub generateReleaseNotes) producing duplicate/messy output.
Template changes (what generated projects get)
changelogandrelease-notesusing git-cliffRepo changes (cookiecutter itself)
Reference
Based on the pattern established in JnyJny/busylight-core#55.
Closes #89
Authored by Jny