feat: ✨ add Commitizen version bump with GitHub workflow

README.md

@@ -34,6 +34,18 @@ spaid_gh_set_repo_settings -h
 spaid_gh_ruleset_basic_protect_main -h
 ```
 
+Some configuration is needed after copying this template to a new
+repository, including configuration external to the repository.
+
+-   The template file `.github/workflows/release-package.yml` requires
+    installing the
+    [auto-release-token](https://github.com/apps/auto-release-token)
+    GitHub App to be installed, as well as a GitHub secret called
+    `UPDATE_VERSION_TOKEN` and a variable called `UPDATE_VERSION_APP_ID`
+    to be set up in the repository (or organization) settings. See this
+    [guide](https://guidebook.seedcase-project.org/operations/security#using-github-apps-to-generate-tokens)
+    for more details on how to set this up.
+
 ## Features
 
 -   Use [uv](https://docs.astral.sh/uv/) to manage the Data Package.

template/.cz.toml

@@ -0,0 +1,10 @@
+[tool.commitizen]
+bump_message = "build(version): :bookmark: update version from $current_version to $new_version [skip ci]"
+update_changelog_on_bump = true
+version_provider = "uv"
+version_files = [
+  "pyproject.toml:version",
+  "scripts/properties.py:version"
+]
+# Don't regenerate the changelog on every update
+changelog_incremental = true

template/.github/workflows/release-package.yml

@@ -0,0 +1,21 @@
+name: Release package
+
+on:
+  push:
+    branches:
+      - main
+
+# Limit token permissions for security
+permissions: read-all
+
+jobs:
+  release:
+    # This job outputs env variables `previous_version` and `current_version`.
+    # Only give permissions for this job.
+    permissions:
+      contents: write
+    uses: seedcase-project/.github/.github/workflows/reusable-release-project.yml@main
+    with:
+      app-id: ${{ vars.UPDATE_VERSION_APP_ID }}
+    secrets:
+      update-version-gh-token: ${{ secrets.UPDATE_VERSION_TOKEN }}

template/README.md.jinja

@@ -1,3 +1,16 @@
+
 ## Post-setup steps
 
 - Run `just list-todos` to get a list of TODO items you need to fill out.
+
+## Versioning and changelog
+
+This project uses
+[Commitizen](https://commitizen-tools.github.io/commitizen/) to update
+versions and generate changelogs. Based on the [Conventional
+Commits](https://www.conventionalcommits.org/en/v1.0.0/) message, it
+will automatically update the version in both `pyproject.toml` and
+`datapackage.json`. The [data package](https://datapackage.org/)
+standard suggests using their version of [Semantic
+Versioning](https://datapackage.org/recipes/data-package-version/). So
+follow this guide when making commits to this repository.