Version 0.23.0 and publishing improvements

.github/workflows/automated-release.yaml

@@ -26,8 +26,13 @@ jobs:
         with:
           python-version: "3.x"
       - run: pipx install uv
-      - run: sh bin/ci/check_versions.sh
+      - run: sh bin/ci/check_versions.sh "$GITHUB_REF_NAME"
       - run: uv build
       - run: find dist
       - name: Publish release distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
+
+      # update 'doc' branch also
+      - run: git checkout doc
+      - run: git merge origin/master --ff-only
+      - run: git push origin doc

CHANGELOG.rst

@@ -2,6 +2,21 @@
  CHANGELOG
 ===========
 
+
+Version 0.23.0 - 3 May 2026
+---------------------------
+
+* New `HOMELY_PULL_WHEN_DIRTY` override to control whether `homely update` will pull when the git repo is dirty.
+* `homely add` will now clone git repos with `--recurse-submodules` so that submodule trees are
+  constructed as well.
+
+
+Version 0.22.0 - 20 Feb 2026
+----------------------------
+
+* Remove checks for old versions of pip (assume pip always supports `--format=freeze`).
+
+
 Version 0.20.1 - 19 Oct 2024
 ----------------------------
 

PUBLISHING.md

@@ -7,21 +7,29 @@ version of python.
 
 Next, add a section to CHANGELOG.rst that looks like this:
 
-    NEW
-    ---
+    Version $NEW_VERSION - $D $MMM $YYYY
+    -------------------------------------
 
     * fixed something
     * fixed something else
 
-Then, after you have committed the changelog changes, run the publish script:
+Then, after you have committed the changelog changes, update the version number in these three files:
 
-    ./publish.py NEW_VERSION_NUMBER
+    vim homely/__init__.py
+    vim pyproject.toml
+    uv lock
+    git add homely/__init__.py pyproject.toml uv.lock
+    git commit -m "Bump version to $NEW_VERSION"
 
 
-After that is finished, you probably want to publish any changes to docs.
-Checkout the `docs` branch, fast-forward it to the commit of the new tag, then
-push that branch. readthedocs.io should hopefully publish an updated version of
-the docs soon afterward.
+Push these changes in a new branch.
+Open a PR for the branch.
+After the branch is merged, add a tag on the merge commit and push the tag:
+
+    git checkout master
+    git pull
+    git tag $NEW_VERSION
+    git push --tags
 
 
 # Manually Publishing Updated Docs

bin/ci/check_versions.sh

@@ -1,4 +1,4 @@
-#!/bin/env bash
+#!/usr/bin/env bash
 pyproject_version=$(grep '^version =' pyproject.toml)
 importable_version=$(grep '^version =' homely/__init__.py)
 if [ "$pyproject_version" != "$importable_version" ]; then
@@ -7,3 +7,13 @@ if [ "$pyproject_version" != "$importable_version" ]; then
 	echo "  homely/__init__.py: $importable_version" >&2
 	exit 2
 fi
+
+expected_version="$1"
+shift
+
+if [ -n "$expected_version" ]; then
+	if ! grep "^version = \"$expected_version\"\$" homely/__init__.py &>/dev/null; then
+		echo "ERROR: expected 'version = \"$expected_version\"' in homely/__init__.py" >&2
+		exit 3
+	fi
+fi

homely/__init__.py

@@ -1 +1 @@
-version = "0.22.0"
+version = "0.23.0"

publish.py

@@ -99,6 +99,8 @@ def updatechangelog(new_tag, latest_tag):
 
 
 def main():
+    raise Exception("This script is deprecated; see instructions in PUBLISHING.md")
+
     tag = sys.argv[1]
     if not len(tag):
         fail("USAGE: {} TAG".format(sys.argv[0]))

pyproject.toml

@@ -18,7 +18,7 @@ classifiers=[
 requires-python = ">=3.10"
 # this also needs to be updated in homely/__init__.py
 # and uv.lock by running "uv lock"
-version = "0.22.0"
+version = "0.23.0"
 
 dependencies = [
     "python-daemon>=2.3.0",