fix: re-alignment with the-hatchlor-enhanced /2.

dornech · dornech · commit bbba17da948b · 2025-09-10T01:17:15.000+02:00
re-alignment with new .cookiecutter.json structure including toolchain selection,switch to commitizen (instead of bump-my-version/generate-changelog or python-semantic-release and gitlint), version updates of external github actions in github workflows
diff --git a/.changelog-config.yaml b/.changelog-config.yaml
diff --git a/.cruft.json b/.cruft.json
@@ -14,7 +14,12 @@
       "github_username": "dornech",
       "project_repo": "https://github.com/dornech/utils-COMobjects",
       "pypi_username": "dornech",
+      "tooling_environment": "commitizen",
+      "__tooling_packages": "{'commitizen': ['commitizen'], 'semantic-release': ['semantic-release'], 'bump-my-version_and_generate-changelog': ['bump-my-version', 'generate-changelog'], 'none': []}",
+      "commitmsg_linter": "toolchain_default",
+      "__tooling_commitmsg_linter": "{'toolchain_default': 'commitizen', 'enforce_commitizen': 'commitizen', 'enforce_gitlint': 'gitlint', 'none': '0'}",
       "lock_file_support": false,
+      "initial_commit": false,
       "_template": "https://github.com/dornech/the-hatchlor-enhanced.git"
     }
   },
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [dornech]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with URL
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -28,9 +28,9 @@ jobs:
     if: startsWith(github.ref, 'refs/tags/')
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
       - name: Install dependencies
@@ -55,9 +55,9 @@ jobs:
     needs: build-test
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
       - name: Install dependencies
@@ -84,7 +84,7 @@ jobs:
       id-token: write
     steps:
       - name: Download all the dists
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: python-package-distributions
           path: dist/
@@ -108,7 +108,7 @@ jobs:
       id-token: write
     steps:
       - name: Download all the dists
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: python-package-distributions
           path: dist/
@@ -129,12 +129,12 @@ jobs:
       id-token: write  # IMPORTANT: mandatory for sigstore
     steps:
       - name: Download all the dists
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v5
         with:
           name: python-package-distributions
           path: dist/
       - name: Sign the Python 🐍 distribution 📦 with Sigstore
-        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        uses: sigstore/gh-action-sigstore-python@v3.0.1
         with:
           inputs: >-
             ./dist/*.tar.gz
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -10,7 +10,6 @@ on:
       # only release tags x.y.z (preceded by v)
       - 'v?[0-9]+.[0-9]+.[0-9]+*'
 
-
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
@@ -41,9 +40,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: '3.x'
       - name: Install dependencies
@@ -54,7 +53,7 @@ jobs:
       - name: Build documentation
         run: hatch run docs:build-check
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v4
         with:
           path: ./site
 
diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml
@@ -25,7 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Run Labeler
         uses: crazy-max/ghaction-github-labeler@v5.3.0
         with:
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -8,7 +8,6 @@ on:
     branches:
       - '*'
 
-
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
   cancel-in-progress: true
@@ -35,9 +34,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
diff --git a/.gitlint b/.gitlint
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,3 +1,8 @@
+# pre-commit defaults
+default_stages: [ pre-commit, pre-merge-commit, pre-push, manual ]   # define default explicitly to avoid double execution for commit-msg hook for commit-msg linter
+default_install_hook_types: [ pre-commit, commit-msg ]
+
+# pre-commit repos
 repos:
 
   # standard pre-commit hooks
@@ -21,7 +26,7 @@ repos:
         args: [ '--fix=auto' ]  # replace 'auto' with 'lf' to enforce Linux/Mac line endings or 'crlf' for Windows
       - id: detect-private-key
 
-  # Ruff (replaces black, flake8, autoflake, isort and more)
+  # ruff (replaces black, flake8, autoflake, isort and more)
   # - repo: https://github.com/charliermarsh/ruff-pre-commit
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: 'v0.11.12'  # make sure this is always consistent with hatch configs
@@ -38,9 +43,9 @@ repos:
         args: [ "--install-types", "--non-interactive", "--config-file=pyproject.toml" ]
         additional_dependencies: [ types-tabulate, types-cachetools ]
 
-  # gitlint - linter for git commit messages
-  - repo: https://github.com/jorisroovers/gitlint
-    rev: 'v0.19.1'
+  # commitizen - linter for git commit messages
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: 'v1.17.0'
     hooks:
-      - id: gitlint    # this is the regular commit-msg hook
-      - id: gitlint-ci # hook for CI environments
+      - id: commitizen
+        stages: [commit-msg]
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -96,7 +96,7 @@ This often provides additional considerations and avoids unnecessary work.
 1. Create a branch to hold your changes:
 
    ```console
-   git checkout -b my-feature
+   git switch --create my-feature
    ```
 
    and start making changes. Never work on the main branch!
@@ -140,7 +140,7 @@ This often provides additional considerations and avoids unnecessary work.
 1. If everything works fine, push your local branch to the remote server with:
 
    ```console
-   git push -u origin my-feature
+   git push --set-upstream origin my-feature
    ```
 
 2. Go to the web page of your fork and click "Create pull request"
diff --git a/README.md b/README.md
@@ -37,10 +37,17 @@ problems with `hatch run lint:fix` and use `hatch run docs:serve` to build and s
 You can also easily define your own environments and commands. Check out the environment setup of hatch
 in [pyproject.toml](pyproject.toml) for more commands as well as the package, build and tool configuration.
 
+To support versioning and changelog generation please refer to the toolchain selected during package
+generation (see also `pyproject.toml`). If not deselected, the toolchain includes a [pre-commit] hook
+for linting commit messages to ensure commit messages are compliant with the conventional commit format and
+support an automated changelog generation.
+
 ## Credits
 
-This package was created with [The Hatchlor] project template.
+This package was created with [The Hatchlor Enhanced] project template. This template is based on [The Hatchlor]
+but was substantially improved.
 
+[The Hatchlor Enhanced]: https://github.com/dornech/the-hatchlor-enhanced
 [The Hatchlor]: https://github.com/florianwilhelm/the-hatchlor
 [pipx]: https://pypa.github.io/pipx/
 [hatch]: https://hatch.pypa.io/
diff --git a/changelog_commitizen-template.md.j2 b/changelog_commitizen-template.md.j2
@@ -0,0 +1,25 @@
+{# MACRO: Capitalize the first letter of a string only #}
+{% macro capitalize_first_letter_only(sentence) %}
+{{    (sentence[0] | upper) ~ sentence[1:] }}
+{% endmacro %}
+# CHANGELOG
+
+{% for entry in tree %}
+
+## [{{ entry.version }}](https://github.com/dornech/utils-COMobjects/releases/tag/{{ entry.version }}) {% if entry.date %} ({{ entry.date }}) {% endif %}
+
+{% for change_type, changes in entry.changes.items() %}
+
+{% if change_type %}
+### {{ capitalize_first_letter_only(change_type) }}
+{% endif %}
+{% for change in changes %}
+{% if change.scope %}
+- **{{ change.scope }}**: {{ capitalize_first_letter_only(change.message) }} (['{{ change.sha1[:7] }}'](https://github.com/dornech/utils-COMobjects/commit/{{ change.sha1 }}))
+{% elif change.message %}
+- {{ capitalize_first_letter_only(change.message) }}(['{{ change.sha1[:7] }}'](https://github.com/dornech/utils-COMobjects/commit/{{ change.sha1 }}))
+{% endif %}
+
+{% endfor %}
+{% endfor %}
+{% endfor %}
diff --git a/pyproject.toml b/pyproject.toml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# Auto detect text files and perform LF normalization`
	`2`	`+* text=auto`