#571 Use pre-commit dog food and update release process for pre-commi…

…t autoupdate. (#572)

* Use pre-commit dog food.

* Run pre-commit autoupdate.

* Update .github/workflows/ci.yml

* Better name. Also run auto-update.

* Add news fragment.

* Update black.

* Update pre-commit hooks.

* Use latets towncrier.

* Use latest pre-commit-hooks.

* Use immutable versions

* Add info about release process.

* Apply fix from Sadik.

* Update .github/workflows/ci.yml

Co-authored-by: Chris Beaven <[email protected]>

---------

Co-authored-by: Hynek Schlawack <[email protected]>
Co-authored-by: Chris Beaven <[email protected]>

.github/workflows/ci.yml

@@ -195,6 +195,36 @@ jobs:
  if: ${{ matrix.task.run-if }}
 
 
+ pre-commit:
+ name: Check pre-commit integration
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Set up python
+ uses: actions/setup-python@v5
+ with:
+ python-version: 3.12
+
+ - name: Install dependencies
+ run: python -m pip install pre-commit
+
+ - name: Install pre-commit
+ run: |
+ pre-commit install
+
+ - name: Update pre-commit
+ run: |
+ pre-commit autoupdate
+
+ - name: Run pre-commit
+ run: |
+ pre-commit run -a
+
+
  pypi-publish:
  name: Check tag and publish
  # Only trigger this for tag changes.
@@ -292,6 +322,7 @@ jobs:
  - test-windows
  - coverage
  - check
+ - pre-commit
  steps:
  - name: Require all successes
  uses: re-actors/alls-green@3a2de129f0713010a71314c74e33c0e3ef90e696

.pre-commit-config.yaml

@@ -33,3 +33,8 @@ repos:
  - id: debug-statements
  - id: check-toml
  - id: check-yaml
+
+ - repo: https://github.com/twisted/towncrier
+ rev: 23.11.0
+ hooks:
+ - id: towncrier-check

RELEASE.rst

@@ -102,7 +102,14 @@ In ``src/towncrier/_version.py`` the version is set using ``incremental`` such a
 
 Commit and push the changes.
 
-Merge the commit in the main branch.
+Merge the commit in the main branch, **without using squash**.
+
+We tag the release based on a commit from the release branch.
+If we merge with squash,
+the release tag commit will no longer be found in the main branch history.
+With a squash merge, the whole branch history is lost.
+This causes the `pre-commit autoupdate` to fail.
+See `PR590 <https://github.com/twisted/towncrier/pull/590>`_ for more details.
 
 You can announce the release over IRC or Gitter.
 

docs/pre-commit.rst

@@ -16,7 +16,7 @@ Usage with the default configuration
 
  repos:
  - repo: https://github.com/twisted/towncrier
- rev: 22.13.0 # run 'pre-commit autoupdate' to update
+ rev: 23.11.0 # run 'pre-commit autoupdate' to update
  hooks:
  - id: towncrier-check
 
@@ -30,7 +30,7 @@ News fragments are stored in ``changelog.d/`` in the root of the repository and
 
  repos:
  - repo: https://github.com/twisted/towncrier
- rev: 22.13.0 # run 'pre-commit autoupdate' to update
+ rev: 23.11.0 # run 'pre-commit autoupdate' to update
  hooks:
  - id: towncrier-update
  files: $changelog\.d/