Skip to content

Commit

Permalink
chore: move docs lint out of pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
jooola committed Oct 5, 2023
1 parent 8adc78b commit 9fec97d
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 11 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Docs

on:
push:
branches: [main, stable-1]
pull_request:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Setup python
uses: actions/setup-python@v4
with:
python-version: 3.x

- name: Install dependencies
run: make venv

- name: Run docs lint
run: make docs-lint
11 changes: 0 additions & 11 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,6 @@ repos:
- id: antsibull-changelog-lint
- id: antsibull-changelog-lint-changelog-yaml

- repo: local
hooks:
- id: antsibull-docs-lint-collection
name: antsibull-docs lint-collection
description: Lint the collection docs
language: python
entry: antsibull-docs lint-collection-docs --plugin-docs .
pass_filenames: false
additional_dependencies:
- antsibull-docs==2.3.1

- repo: https://github.com/ansible/ansible-lint
rev: v6.20.3
hooks:
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ venv:
lint: venv
venv/bin/pylint plugins

docs-lint:
venv/bin/antsibull-docs lint-collection-docs --plugin-docs .

clean:
git clean -xdf \
-e tests/integration/cloud-config-hcloud.ini
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ requests

# Development requirements
pylint
antsibull-docs>=2.5.0,<2.6

0 comments on commit 9fec97d

Please sign in to comment.