Add release process with changelog support using scriv

CHANGES.d/20241029_095544_elikowa.md

@@ -0,0 +1 @@
+- Add release process with changelog support using scriv

CHANGES.d/20241029_100619_elikowa.md

@@ -0,0 +1 @@
+- fix Component.require_one raising a configuration error with strict=False

CHANGES.d/20241029_100632_elikowa.md

@@ -0,0 +1,2 @@
+- Adds command `./batou secrets decrypttostdout` to decrypt a secrets file to stdout.
+  - Useful for integration with git diff using textconv, see documentation for installation instructions.

CHANGES.d/20241029_100641_elikowa.md

@@ -0,0 +1,3 @@
+- The error message shown when a batou deployment fails to start due to another
+  deployment running at the same time, now correctly informs the user that
+  another deployment is running instead of showing a traceback. (#446)

CHANGES.md

@@ -1,16 +1,9 @@
-## Changelog
 
 
 ## 2.5.1 (unreleased)
 ---------------------
 
-- fix Component.require_one raising a configuration error with strict=False
-- Adds command `./batou secrets decrypttostdout` to decrypt a secrets file to stdout.
-  - Useful for integration with git diff using textconv, see documentation for installation instructions.
-- The error message shown when a batou deployment fails to start due to another
-  deployment running at the same time, now correctly informs the user that
-  another deployment is running instead of showing a traceback. (#446)
-
+- Nothing changed yet.
 
 ## 2.5.0 (2024-09-04)
 -----------------------
@@ -87,7 +80,7 @@
 ## 2.4 (2023-12-06)
 ----------------------
 
-- Nothing changed yet.
+- No changes since 2.4rc2.
 
 
 ## 2.4rc2 (2023-11-29)

README.md

@@ -84,6 +84,11 @@ The project is licensed under the 2-clause BSD license.
 * Set up GPG for the examples with `export GNUPGHOME=<DIRECTORY OF BATOU HERE>/src/batou/secrets/tests/fixture/gnupg`
 * Make sure [age](https://github.com/FiloSottile/age) is installed and in `$PATH` for age encryption support.
 
+## Development and release process
+
+* Changes should be accompanied with a changelog entry. Use `./changelog.sh` to create one.
+* Releasing will create a tag and publishes the package to pypi. Use `./release-this.sh` to create a release.
+
 ## Changelog
 
 See [CHANGES.md](./CHANGES.md).

changelog.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -ex
+
+cd $(dirname $0)
+chmod u+w bin/*ctivate* || true
+python3 -m venv .
+bin/pip install scriv
+
+mkdir -p CHANGES.d
+exec bin/scriv create --edit

release-this.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+set -euxo pipefail
+
+current_branch=$(git rev-parse --abbrev-ref HEAD)
+
+if [ "$current_branch" != "master" ]; then
+    set +x
+    echo
+    echo
+    echo "ERROR: can only release from master. We are on $current_branch"
+    echo
+    exit 1
+fi
+
+changes=$(git status --porcelain)
+if [ -n "$changes" ]; then
+    set +x
+    echo
+    echo
+    echo "ERROR: there are changes."
+    echo
+    git status
+    exit 1
+fi
+
+cd $(dirname $0)
+chmod u+w bin/*ctivate* || true
+python3 -m venv .
+bin/pip install zest.releaser scriv
+bin/pip install -e .
+
+bin/scriv collect
+sed  -i .orig '/- Nothing changed yet./ { N; d; } ' CHANGES.md
+git add -A .
+git status
+PAGER= git diff --cached
+echo "Press enter to commit, Ctrl-C to abort."
+read
+git commit -m "Prepare changelog for release"
+
+bin/fullrelease

setup.cfg

@@ -4,3 +4,13 @@ upload-dir = build/doc
 [isort]
 multi_line_output = 3
 include_trailing_comma = true
+
+[tool.scriv]
+format = md
+fragment_directory = CHANGES.d
+output_file = CHANGES.md
+version = unreleased
+entry_title_template =
+new_fragment_template = - New changelog entry.
+insert_marker = - Nothing changed yet.
+categories =