Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre-commit.com hooks for lint-collection-docs #231

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 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"
ssbarnea marked this conversation as resolved.
Show resolved Hide resolved
additional_dependencies:
- ansible-core >= 2.14.0
4 changes: 4 additions & 0 deletions changelogs/fragments/231-pre-commit.yaml
Original file line number Diff line number Diff line change
@@ -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).