From 714fc245b42bb506427dc58a7aca1cef804f469c Mon Sep 17 00:00:00 2001 From: Dana Whitfield Date: Wed, 16 Sep 2026 09:40:00 +0200 Subject: [PATCH] Document the release process --- index.md | 1 + release-process.md | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 release-process.md diff --git a/index.md b/index.md index 7e17b890ea63265b83f145b7020c0483c3097839..6c0cf2db68640021f2eaaaba5f0210f51c5f5e66 100644 --- a/index.md +++ b/index.md @@ -8,6 +8,7 @@ tool. It is an ordinary git repository, so improvements are just a push away. - [Getting started](getting-started.md) — install hello-hut and say hello - [Frequently asked questions](faq.md) +- [Release process](release-process.md) — how a version is tagged and announced ## Elsewhere diff --git a/release-process.md b/release-process.md new file mode 100644 index 0000000000000000000000000000000000000000..1a2ef1163e922f66ee291767d70b55e084ba2167 --- /dev/null +++ b/release-process.md @@ -0,0 +1,27 @@ +# Release process + +Releases are cut from `main` by a maintainer. + +1. Update `CHANGELOG.md` and the version in `src/hello_hut/__init__.py`. +2. Commit as `Release X.Y.Z` and create an annotated tag: + + ```sh + git tag -a vX.Y.Z -m "hello-hut X.Y.Z" + git push origin main vX.Y.Z + ``` + +3. Build the tarball and attach it to the tag on git.hut.md: + + ```sh + git archive --format=tar.gz --prefix=hello-hut-X.Y.Z/ vX.Y.Z > hello-hut-X.Y.Z.tar.gz + ``` + +4. Announce it on + [hello-hut-announce](https://lists.hut.md/~reviewer/hello-hut-announce). + +| Version | Date | Highlights | +| --- | --- | --- | +| 0.2.0 | 2026-09-15 | `--count`, `--color`, `--format json`, completions | +| 0.1.0 | 2026-05-04 | First release | + +Back to the [index](index.md).