Merge remote-tracking branch 'structure-local/py-docker' into develop

rpatterson · Oct 29, 2023 · 2f9ea2c · 2f9ea2c
2 parents 92571d8 + f8fb7bb
commit 2f9ea2c
Show file tree

Hide file tree

Showing 11 changed files with 73 additions and 38 deletions.
diff --git a/.gitignore b/.gitignore
@@ -81,7 +81,7 @@ nosetests.xml
 local_settings.py
 
 # Flask stuff:
-instance/
+instance
 .webassets-cache
 
 # Scrapy stuff:

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -15,9 +15,7 @@ variables:
 
 default:
   image:
-    # TEMPLATE: Only change these if you customize the `./build-host/Dockerfile` image.
-    # Otherwise use the version of this image from the project template in your CI/CD.
-    name: "registry.gitlab.com/rpatterson/project-structure:build-host"
+    name: "registry.gitlab.com/rpatterson/prunerr:build-host"
     entrypoint:
       - "docker-entrypoint.sh"
   services:

diff --git a/Makefile b/Makefile
@@ -521,7 +521,8 @@ build-docs: build-docs-html
 .PHONY: build-docs-watch
 ## Serve the Sphinx documentation with live updates
 build-docs-watch: $(HOME)/.local/bin/tox
-	tox exec -e "build" -- sphinx-watch "./docs/" "./build/docs/html/" "html" --httpd
+	mkdir -pv "./build/docs/html/"
+	tox exec -e "build" -- sphinx-autobuild -b "html" "./docs/" "./build/docs/html/"
 
 .PHONY: build-docs-%
 # Render the documentation into a specific format.
@@ -787,6 +788,18 @@ test-lint-docker: $(HOST_TARGET_DOCKER) ./.env.~out~ ./var/log/docker-login-DOCK
 	docker compose run $(DOCKER_COMPOSE_RUN_ARGS) hadolint
 	docker compose run $(DOCKER_COMPOSE_RUN_ARGS) hadolint \
 	    hadolint "./build-host/Dockerfile"
+	$(MAKE) -e -j $(PYTHON_MINORS:%=test-lint-docker-volumes-%)
+.PHONY: $(PYTHON_MINORS:%=test-lint-docker-volumes-%)
+## Prevent Docker volumes owned by `root` for one Python version.
+$(PYTHON_MINORS:%=test-lint-docker-volumes-%):
+	$(MAKE) -e \
+	    PYTHON_MINORS="$(@:test-lint-docker-volumes-%=%)" \
+	    PYTHON_MINOR="$(@:test-lint-docker-volumes-%=%)" \
+	    PYTHON_ENV="py$(subst .,,$(@:test-lint-docker-volumes-%=%))" \
+	    test-lint-docker-volumes
+.PHONY: test-lint-docker-volumes
+## Prevent Docker volumes owned by `root`.
+test-lint-docker-volumes: $(HOST_TARGET_DOCKER) ./.env.~out~
 # Ensure that any bind mount volume paths exist in VCS so that `# dockerd` doesn't
 # create them as `root`:
 	if test -n "$$(
@@ -1610,7 +1623,7 @@ then
 fi
 if test "$(TEMPLATE_IGNORE_EXISTING)" = "true"
 then
-    envsubst <"$(1)" >"$(2)"
+    envsubst <"$(1)" >"$(2:%.~out~=%)"
     exit
 fi
 exit 1

diff --git a/newsfragments/+upgrade-requirements.bugfix.rst b/newsfragments/+upgrade-requirements.bugfix.rst
@@ -1,2 +1,2 @@
 Upgrade all requirements to the most recent versions as of
-Sun Oct 29 03:13:29 PM UTC 2023.
+Sun Oct 29 06:24:32 PM UTC 2023.
diff --git a/requirements/build.txt.in b/requirements/build.txt.in
@@ -24,7 +24,7 @@ towncrier
 rstcheck
 # Rich, full documentation site:
 sphinx
-sphinx-watch
+sphinx-autobuild
 # https://github.com/sphinx-contrib/sphinx-lint
 sphinx-lint
 # https://docs.restructuredtext.net/articles/linter#supported-linters

diff --git a/requirements/py310/build.txt b/requirements/py310/build.txt
@@ -25,12 +25,12 @@ charset-normalizer==3.3.1
 click==8.1.7
     # via
     #   proselint
-    #   sphinx-watch
     #   towncrier
     #   typer
 colorama==0.4.6
     # via
     #   commitizen
+    #   sphinx-autobuild
     #   typer
 commitizen==3.12.0
     # via -r requirements/build.txt.in
@@ -81,6 +81,8 @@ jinja2==3.1.2
     #   towncrier
 keyring==24.2.0
     # via twine
+livereload==2.6.3
+    # via sphinx-autobuild
 markdown-it-py==3.0.0
     # via rich
 markupsafe==2.1.3
@@ -162,21 +164,22 @@ shellingham==1.5.4
 six==1.16.0
     # via
     #   configobj
+    #   livereload
     #   proselint
 snowballstemmer==2.2.0
     # via sphinx
 sphinx==7.2.6
     # via
     #   -r requirements/build.txt.in
-    #   sphinx-watch
+    #   sphinx-autobuild
     #   sphinxcontrib-applehelp
     #   sphinxcontrib-devhelp
     #   sphinxcontrib-htmlhelp
     #   sphinxcontrib-qthelp
     #   sphinxcontrib-serializinghtml
-sphinx-lint==0.8.1
+sphinx-autobuild==2021.3.14
     # via -r requirements/build.txt.in
-sphinx-watch==0.1.2
+sphinx-lint==0.8.1
     # via -r requirements/build.txt.in
 sphinxcontrib-applehelp==1.0.7
     # via sphinx
@@ -200,6 +203,8 @@ tomli==2.0.1
     #   towncrier
 tomlkit==0.12.1
     # via commitizen
+tornado==6.3.3
+    # via livereload
 towncrier==23.10.0
     # via -r requirements/build.txt.in
 twine==4.0.2
@@ -219,8 +224,6 @@ urllib3==2.0.7
     #   twine
 virtualenv==20.24.6
     # via pre-commit
-watchdog==3.0.0
-    # via sphinx-watch
 wcwidth==0.2.8
     # via prompt-toolkit
 zipp==3.17.0

diff --git a/requirements/py311/build.txt b/requirements/py311/build.txt
@@ -25,12 +25,12 @@ charset-normalizer==3.3.1
 click==8.1.7
     # via
     #   proselint
-    #   sphinx-watch
     #   towncrier
     #   typer
 colorama==0.4.6
     # via
     #   commitizen
+    #   sphinx-autobuild
     #   typer
 commitizen==3.12.0
     # via -r requirements/build.txt.in
@@ -81,6 +81,8 @@ jinja2==3.1.2
     #   towncrier
 keyring==24.2.0
     # via twine
+livereload==2.6.3
+    # via sphinx-autobuild
 markdown-it-py==3.0.0
     # via rich
 markupsafe==2.1.3
@@ -162,21 +164,22 @@ shellingham==1.5.4
 six==1.16.0
     # via
     #   configobj
+    #   livereload
     #   proselint
 snowballstemmer==2.2.0
     # via sphinx
 sphinx==7.2.6
     # via
     #   -r requirements/build.txt.in
-    #   sphinx-watch
+    #   sphinx-autobuild
     #   sphinxcontrib-applehelp
     #   sphinxcontrib-devhelp
     #   sphinxcontrib-htmlhelp
     #   sphinxcontrib-qthelp
     #   sphinxcontrib-serializinghtml
-sphinx-lint==0.8.1
+sphinx-autobuild==2021.3.14
     # via -r requirements/build.txt.in
-sphinx-watch==0.1.2
+sphinx-lint==0.8.1
     # via -r requirements/build.txt.in
 sphinxcontrib-applehelp==1.0.7
     # via sphinx
@@ -196,6 +199,8 @@ termcolor==2.3.0
     # via commitizen
 tomlkit==0.12.1
     # via commitizen
+tornado==6.3.3
+    # via livereload
 towncrier==23.10.0
     # via -r requirements/build.txt.in
 twine==4.0.2
@@ -215,8 +220,6 @@ urllib3==2.0.7
     #   twine
 virtualenv==20.24.6
     # via pre-commit
-watchdog==3.0.0
-    # via sphinx-watch
 wcwidth==0.2.8
     # via prompt-toolkit
 zipp==3.17.0

diff --git a/requirements/py312/build.txt b/requirements/py312/build.txt
@@ -25,12 +25,12 @@ charset-normalizer==3.3.1
 click==8.1.7
     # via
     #   proselint
-    #   sphinx-watch
     #   towncrier
     #   typer
 colorama==0.4.6
     # via
     #   commitizen
+    #   sphinx-autobuild
     #   typer
 commitizen==3.12.0
     # via -r requirements/build.txt.in
@@ -80,6 +80,8 @@ jinja2==3.1.2
     #   towncrier
 keyring==24.2.0
     # via twine
+livereload==2.6.3
+    # via sphinx-autobuild
 markdown-it-py==3.0.0
     # via rich
 markupsafe==2.1.3
@@ -161,21 +163,22 @@ shellingham==1.5.4
 six==1.16.0
     # via
     #   configobj
+    #   livereload
     #   proselint
 snowballstemmer==2.2.0
     # via sphinx
 sphinx==7.2.6
     # via
     #   -r requirements/build.txt.in
-    #   sphinx-watch
+    #   sphinx-autobuild
     #   sphinxcontrib-applehelp
     #   sphinxcontrib-devhelp
     #   sphinxcontrib-htmlhelp
     #   sphinxcontrib-qthelp
     #   sphinxcontrib-serializinghtml
-sphinx-lint==0.8.1
+sphinx-autobuild==2021.3.14
     # via -r requirements/build.txt.in
-sphinx-watch==0.1.2
+sphinx-lint==0.8.1
     # via -r requirements/build.txt.in
 sphinxcontrib-applehelp==1.0.7
     # via sphinx
@@ -195,6 +198,8 @@ termcolor==2.3.0
     # via commitizen
 tomlkit==0.12.1
     # via commitizen
+tornado==6.3.3
+    # via livereload
 towncrier==23.10.0
     # via -r requirements/build.txt.in
 twine==4.0.2
@@ -214,8 +219,6 @@ urllib3==2.0.7
     #   twine
 virtualenv==20.24.6
     # via pre-commit
-watchdog==3.0.0
-    # via sphinx-watch
 wcwidth==0.2.8
     # via prompt-toolkit
 zipp==3.17.0

diff --git a/requirements/py38/build.txt b/requirements/py38/build.txt
@@ -25,12 +25,12 @@ charset-normalizer==3.3.1
 click==8.1.7
     # via
     #   proselint
-    #   sphinx-watch
     #   towncrier
     #   typer
 colorama==0.4.6
     # via
     #   commitizen
+    #   sphinx-autobuild
     #   typer
 commitizen==3.12.0
     # via -r requirements/build.txt.in
@@ -88,6 +88,8 @@ jinja2==3.1.2
     #   towncrier
 keyring==24.2.0
     # via twine
+livereload==2.6.3
+    # via sphinx-autobuild
 markdown-it-py==3.0.0
     # via rich
 markupsafe==2.1.3
@@ -171,16 +173,17 @@ shellingham==1.5.4
 six==1.16.0
     # via
     #   configobj
+    #   livereload
     #   proselint
 snowballstemmer==2.2.0
     # via sphinx
 sphinx==7.1.2
     # via
     #   -r requirements/build.txt.in
-    #   sphinx-watch
-sphinx-lint==0.8.1
+    #   sphinx-autobuild
+sphinx-autobuild==2021.3.14
     # via -r requirements/build.txt.in
-sphinx-watch==0.1.2
+sphinx-lint==0.8.1
     # via -r requirements/build.txt.in
 sphinxcontrib-applehelp==1.0.4
     # via sphinx
@@ -204,6 +207,8 @@ tomli==2.0.1
     #   towncrier
 tomlkit==0.12.1
     # via commitizen
+tornado==6.3.3
+    # via livereload
 towncrier==23.10.0
     # via -r requirements/build.txt.in
 twine==4.0.2
@@ -227,8 +232,6 @@ urllib3==2.0.7
     #   twine
 virtualenv==20.24.6
     # via pre-commit
-watchdog==3.0.0
-    # via sphinx-watch
 wcwidth==0.2.8
     # via prompt-toolkit
 zipp==3.17.0