chore: add automated changelog and release workflow (git-cliff + bump-my-version) - Update changelog by marvin8 · Pull Request #110 · thejchap/tryke

marvin8 · 2026-05-13T20:50:03Z

Summary

Adds git-cliff and bump-my-version to the dev dependencies
Adds cliff.toml with commit parsers matching commitizen-style messages
Adds justfile with a release recipe orchestrating the full release flow
Bootstraps bump-my-version config in pyproject.toml (version tracking for
Cargo.toml and pyproject.toml itself)
Adds an empty CHANGELOG.md as the prepend target
Enforces commitizen-style commit messages in AGENTS.md

Release workflow

Computes the next version via bump-my-version show new_version
Generates a changelog entry for unreleased commits via git-cliff --unreleased --prepend
Pauses for manual review/edit of CHANGELOG.md
Commits the changelog update and bumps the version in pyproject.toml and Cargo.toml
Creates a signed git tag and pushes the branch and tag

First-run: manual tag required

git-cliff --unreleased scopes to commits after the most recent semver tag.
The repo has no tags yet, so on first run it would pull the entire commit history
into the changelog.

Before the first just release, create an annotated tag at the last release commit:

git tag -a 0.0.28 3f03d3d -m "0.0.28"
git push origin 0.0.28   # or: git push claude 0.0.28


Closes #104

release steps

Copilot

Pull request overview

Adds automated changelog and release tooling: a just release recipe that drives bump-my-version and git-cliff to compute the next semver, generate an unreleased changelog section, pause for manual edit, then commit, tag, and push. Also seeds an empty CHANGELOG.md and codifies commitizen-style commit messages in AGENTS.md. Closes #104.

Changes:

New cliff.toml with a custom body template and commit parsers grouping feat/fix/docs/refactor/perf/test/ci and skipping chore.
New justfile release recipe orchestrating bump → cliff → manual review → commit → bump-tag → push.
bump-my-version config added to pyproject.toml, tracking the version string in Cargo.toml; dev deps gain bump-my-version and git-cliff.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
pyproject.toml	Adds `bump-my-version`/`git-cliff` dev deps and `[tool.bumpversion]` config (with a `Cargo.toml` file entry).
cliff.toml	git-cliff template and parser config for changelog generation.
justfile	New `release` recipe driving the end-to-end release flow.
CHANGELOG.md	Empty file created as the prepend target for git-cliff.
AGENTS.md	Documents the commitizen-style commit message requirement.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+"""
+
+[git]
+conventional_commits = false


thejchap · 2026-05-17T01:27:49Z

+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'


looks legit

+release type:
+    #!/usr/bin/env bash
+    set -euo pipefail
+    type="{{type}}"
+
+    if [[ "$type" != "patch" && "$type" != "minor" && "$type" != "major" ]]; then
+        echo "Error: argument must be patch, minor, or major (got: $type)"
+        exit 1
+    fi


+
+    uv run bump-my-version bump "$type"
+
+    git push


thejchap · 2026-05-15T05:09:53Z

thank you! i am at pycon the next few days - will take a look at this soon

thejchap

thanks for working on this @marvin8 !

i like the direction this is heading. there are a few changes to the process that i think i'd like to make - i am not deeply familiar with these tools so will defer to you to let me know if it makes sense to continue using them or switch to something different

commit message format - i don't want to be prescriptive on commit message format, or rely on that to generate changelog sections, at least at this stage in the project. i think this is a bit too structured and introduces a bit more friction to iterating than i would like
related to the above, is there by any chance a way to instead rely on PR labels to drive changelog categories? for example if i just add 3 simple "Features" "Bug fixes" "Other" labels for now? if not, no problem - can keep it un-sectioned and i will editorialize it manually
is it possible to have a section to list contributors for each release (like this)?
can we have GH actions publish a GH Release as well now that we'll have the nice changelog?

thejchap · 2026-05-17T01:27:00Z

 ## style guidelines

 - comments and docs should be capitalized: <https://google.github.io/styleguide/cppguide.html#Punctuation_Spelling_and_Grammar> and <https://peps.python.org/pep-0008/#comments>
+- commit messages must be in commitizen style


i would like to avoid this - i am not a huge fan of being too prescriptive on commit message format

thejchap · 2026-05-17T01:27:49Z

+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'


looks legit

thejchap · 2026-05-17T01:42:10Z

+current_version = "0.0.28"
+commit = true
+tag = true
+tag_name = "{new_version}"


does this need to be "v{new_version}"?

thejchap · 2026-05-17T01:44:11Z

+
+# Release -  Usage: just release patch|minor|major
+release type:
+    #!/usr/bin/env bash


nit: can we move the shell script itself into scripts/release.sh

marvin8 · 2026-05-17T23:13:13Z

Thanks for the feedback. I am currently busy with something else but should get to addressing your comments later this week.
Also, did you want me to address the comments by copilot as well?

thejchap · 2026-05-18T00:00:03Z

@marvin8 sounds good! and yes that would be great, those all look legitimate

- Remove prescriptive commit-message style guideline from AGENTS.md - Switch changelog categorization from commit prefixes to PR labels via git-cliff GitHub integration; add contributors section to template - Add [remote.github] to cliff.toml for PR label and contributor data - Fix tag_name to use v{new_version} prefix in bump-my-version config - Anchor Cargo.toml version search to [workspace.package] section with regex to prevent false matches on pinned dependencies - Extract inline justfile script to scripts/release.sh; drop justfile - Rename `type` param to `bump_type` to avoid bash builtin shadowing - Fix bare `git push` to `git push origin HEAD` for explicit ref - Add github-release job to release.yml to publish GH Release after PyPI publish, using git-cliff to generate release notes from PR labels

marvin8 · 2026-05-19T04:02:19Z

I think I've addressed all review remarks.

Fair warning though, I have never used github actions, so I had Claude Code do that part for me. That might be worth having a good look at.

Other than that, cliff is supposed to use PR labels now and not commits. I've also removed the commit style requirement in your AGENTS.md file.

If I have missed anything, just let me know.

marvin8 added 4 commits May 13, 2026 13:54

docs: initial automated release including update to CHANGELOG.md

1c6c0bc

chore: add dev dependencies and empty CHANGELOG.md file

416210d

chore: change bump-my-version settings to update Cargo.toml

83f283d

chore: bootstrap bump-my-version with current_version and fix justfile

de676c8

release steps

marvin8 requested a review from thejchap as a code owner May 13, 2026 20:50

marvin8 mentioned this pull request May 13, 2026

Changelog for the new releases / tags. #104

Open

thejchap requested a review from Copilot May 13, 2026 22:45

Copilot started reviewing on behalf of thejchap May 13, 2026 22:46 View session

Copilot AI reviewed May 13, 2026

View reviewed changes

thejchap requested changes May 17, 2026

View reviewed changes

marvin8 and others added 2 commits May 19, 2026 13:52

Merge branch 'main' into update-changelog

4566847

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: add automated changelog and release workflow (git-cliff + bump-my-version) - Update changelog#110

chore: add automated changelog and release workflow (git-cliff + bump-my-version) - Update changelog#110
marvin8 wants to merge 6 commits into
thejchap:mainfrom
marvin8:update-changelog

marvin8 commented May 13, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

thejchap May 17, 2026

Uh oh!

thejchap commented May 15, 2026

Uh oh!

thejchap left a comment

Uh oh!

thejchap May 17, 2026

Uh oh!

thejchap May 17, 2026

Uh oh!

thejchap May 17, 2026

Uh oh!

thejchap May 17, 2026

Uh oh!

marvin8 commented May 17, 2026

Uh oh!

thejchap commented May 18, 2026

Uh oh!

marvin8 commented May 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		search = 'version = "{current_version}"'
		replace = 'version = "{new_version}"'

Conversation

marvin8 commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Release workflow

First-run: manual tag required

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

thejchap May 17, 2026

Choose a reason for hiding this comment

Uh oh!

thejchap commented May 15, 2026

Uh oh!

thejchap left a comment

Choose a reason for hiding this comment

Uh oh!

thejchap May 17, 2026

Choose a reason for hiding this comment

Uh oh!

thejchap May 17, 2026

Choose a reason for hiding this comment

Uh oh!

thejchap May 17, 2026

Choose a reason for hiding this comment

Uh oh!

thejchap May 17, 2026

Choose a reason for hiding this comment

Uh oh!

marvin8 commented May 17, 2026

Uh oh!

thejchap commented May 18, 2026

Uh oh!

marvin8 commented May 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

marvin8 commented May 13, 2026 •

edited

Loading