add pre-commit.com hooks for lint-collection-docs

ansible-community · Dec 19, 2023 · 03c1db5 · 03c1db5
1 parent 0941d58
commit 03c1db5
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -0,0 +1,15 @@
+# Copyright (C) 2023 Maxwell G <[email protected]>
+# SPDX-License-Identifier: GPL-3.0-or-later
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or
+# https://www.gnu.org/licenses/gpl-3.0.txt)
+---
+- id: lint-collection-docs
+  name: Lint collection docs
+  language: python
+  pass_filenames: false
+  entry: "antsibull-docs lint-collection-docs ."
+  # Default arguments based on the collection_template.
+  # Users can change these if they wish
+  args:
+    - "--plugin-docs"
+    - "--skip-rstcheck"
diff --git a/changelogs/fragments/231-pre-commit.yaml b/changelogs/fragments/231-pre-commit.yaml
@@ -0,0 +1,4 @@
+---
+minor_changes:
+  - Add pre-commit.com hook for ``antsibull-docs lint-collection-docs``
+    (https://github.com/ansible-community/antsibull-docs/pull/231).