pre-commit: add initial config and workflow

Author: Saviq

.github/workflows/pre-commit.yaml

@@ -0,0 +1,24 @@
+name: PreCommit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  PreCommit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v5
+    - uses: actions/setup-python@v6
+      with:
+        python-version: 3.x
+    - uses: pre-commit/[email protected]
+    - uses: pre-commit-ci/[email protected]
+      if: always()
+      with:
+        msg: "pre-commit: apply automatic fixes"

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+# Recommended workflow:
+# - `git add --verbose --patch` to stage changes
+# - `git commit` to commit them
+# - rinse and repeat, if pre-commit wants / applied changes
+#
+# To limit impact to just the `docs` subfolder, uncomment the below
+# files: ^docs/
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: trailing-whitespace
+  - id: end-of-file-fixer
+  - id: check-added-large-files
+
+- repo: https://github.com/executablebooks/mdformat
+  rev: 0.7.22
+  hooks:
+  - id: mdformat
+    additional_dependencies:
+    - mdformat-black
+    - mdformat-beautysh
+    - mdformat-gfm
+    - mdformat-myst
+    - setuptools # Necessary until beautysh fix their stuff, see: https://github.com/hukkin/mdformat/issues/442
+
+- repo: https://github.com/jackdewinter/pymarkdown
+  rev: v0.9.32
+  hooks:
+  - id: pymarkdown
+    args:
+    - --config=docs/.sphinx/.pymarkdown.json
+    - fix

CHANGELOG.md

@@ -3,10 +3,12 @@
 ## Upcoming
 
 * Changes metrics script to a less brittle Python script
+* Adds pre-commit configuration for automatic fixes and checks
 
 ### Added
 
 * `docs/.sphinx/metrics/build_metrics.py` [#373](https://github.com/canonical/sphinx-docs-starter-pack/pull/373)
+* `.pre-commit-config.py`
 
 ## Changed
 

README.md

@@ -29,6 +29,12 @@ This directory contains files used for documentation build checks via GitHub's C
 
 The file `test-starter-pack.yml` tests the functionality of the starter pack project.
 
+### `.pre-commit-config.yaml`
+
+This file has configuration for [pre-commit](pre-commit) checks for automatic fixes and checks, local or in CI.
+
+It can apply the automatic fixes directly through [the GitHub App](pre-commit-ci-lite) - configure it to enable access to repositories you want it on.
+
 ## Contributing
 
 We welcome contributions to this project! If you have suggestions, bug fixes, or improvements, please open an issue or submit a pull request.
@@ -39,3 +45,5 @@ Please read and sign our [Contributor Licence Agreement (CLA)] before submitting
 
 [Sphinx]: https://www.sphinx-doc.org/
 [Contributor Licence Agreement (CLA)]: https://ubuntu.com/legal/contributors
+[pre-commit]: https://pre-commit.com/
+[pre-commit-ci-lite]: https://github.com/apps/pre-commit-ci-lite