diff --git a/README.md b/README.md index 367b492..52ec107 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/cz.yaml b/cz.yaml index efbc679..1ec5475 100644 --- a/cz.yaml +++ b/cz.yaml @@ -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