build: restore --check-tag flag for check-version pre-push hook

build: add gadzooks build-docs hook to rebuild docs if the source changes

.gitignore

@@ -12,3 +12,4 @@ htmlcov
 fancy_dataclass/docs/assets/javascripts
 fancy_dataclass/docs/search
 fancy_dataclass/docs/sitemap.xml.gz
+.doc-checksum

.pre-commit-config.yaml

@@ -28,14 +28,23 @@ repos:
     - id: commitizen
       stages: [commit-msg]
 - repo: https://github.com/jeremander/gadzooks
-  rev: v0.2.3
+  rev: v0.2.4
   hooks:
+    - id: build-docs
+      args: ['--src-docs', 'docs', '--', 'mkdocs', 'build', '--strict', '--no-directory-urls', '-d', 'fancy_dataclass/docs']
+      pass_filenames: false
+      verbose: true
     - id: loc-summarize
       args: ['fancy_dataclass/*.py']
       pass_filenames: false
       verbose: true
     - id: check-version
-      args: ['--dist-dir', 'dist', '--changelog', 'docs/CHANGELOG.md', '--changelog-version-regex', '\[{version}\]:\s*\w+']
+      args: []
+      pass_filenames: false
+      verbose: true
+      stages: [commit]
+    - id: check-version
+      args: ['--check-tag', '--dist-dir', 'dist', '--changelog', 'docs/CHANGELOG.md', '--changelog-version-regex', '\[{version}\]:\s*\w+']
       pass_filenames: false
       verbose: true
-      stages: [commit, push]
+      stages: [push]

TODO.md

@@ -2,16 +2,6 @@
 
 # TODO
 
-## v0.4.2
-
-- `mkdocs` output in `package_data`?
-  - `_docs` subdirectory?
-  - Pre-commit hook to run `mkdocs build`
-    - Takes only a second, but could use file hashes to prevent redundant build, e.g. `sha1sum docs/*.md | sha1sum | head -c 40`
-  - Need some hook (post-tag?) to require the docs be up-to-date
-- CHANGELOG
-  - Check version enforcement when attempting to push new tag
-
 ## v0.5.0
 
 - Optional dependencies

pyproject.toml

@@ -47,6 +47,8 @@ dependencies = [
 
 [tool.hatch.envs.doc.scripts]
 build = "mkdocs build --clean --strict --no-directory-urls {args}"
+# build docs within the package, if not already up-to-date
+build-pkg = "gadzooks build-docs --src-docs docs -- mkdocs build --strict --no-directory-urls -d fancy_dataclass/docs"
 serve = "mkdocs serve"
 deploy = "mkdocs build --site-dir $READTHEDOCS_OUTPUT/html"
 
@@ -65,7 +67,6 @@ dependencies = [
 run-ruff = "ruff check"
 # ensure compatibility with Py3.8 and higher
 run-vermin = "vermin {args:.}"
-# run-vermin = "vermin {args:-t=3.8- --eval-annotations --no-tips --violations --exclude enum.StrEnum --exclude types.UnionType --exclude tests.test_utils .}"
 # type-checking
 run-mypy = "mypy --install-types --non-interactive {args:fancy_dataclass tests}"
 # print info about lines of code