Skip to content

chore: update commitizen version to use v<version number> and add #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
goapunk merged 1 commit into from
Apr 14, 2026
Merged

chore: update commitizen version to use v<version number> and add #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,12 @@ Run with:
```
go test
```

## Release
Release are created using commitizen. To create a new release:
1. create a python venv if not existing: `python3 -m venv venv`
2. activate the venv: `source venv/bin/activate`
3. install commitizen: `pip install commitizen`
4. run `cz bump`
5. push to a new branch and make pr
6. once merged, delete the tag created by commitizen, tag the release commit on main and push it

@decentral1se decentral1se Mar 25, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Kind of weird that you have to delete the tag and tag again but I'm fine with it ☺️

@goapunk goapunk Mar 25, 2026

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it's a bit of a hack, otherwise we would have to push directly to main. I guess something like

cz bump --files-only --yes --changelog
git commit -am "bump: release $(cz version --project)"

would make more sense. Or just having a GitHub action do the whole process. Maybe I'll add that instead.

2 changes: 1 addition & 1 deletion cz.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
commitizen:
major_version_zero: true
name: cz_conventional_commits
tag_format: $version
tag_format: v$version
update_changelog_on_bump: true
version_provider: scm
version_scheme: semver2
Loading