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

Build and lint the docsite on new pull-requests #15

Merged
merged 9 commits into from
Aug 5, 2024
Merged
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
35 changes: 35 additions & 0 deletions .github/workflows/lint-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: build-docs
on:
workflow_dispatch:

pull_request:
branches:
- main

jobs:
build-docs:
permissions:
contents: read
uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main
with:
init-lenient: false
init-fail-on-error: true

lint-docs:
name: Lint Docs
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install antsibull-docs
run: pip install antsibull-docs
- name: Lint Docs
run: |
antsibull-docs lint-collection-docs \
--plugin-docs \
--validate-collection-refs=all \
--disallow-unknown-collection-refs .
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.vscode
.vscode
changelogs/.plugin-cache.yaml
5 changes: 5 additions & 0 deletions roles/uki_config/meta/argument_specs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,8 @@ argument_specs:
uki_config_kernel_install_config_root:
type: path
default: /etc/kernel
description: |
The path where configuration files are stored.

This should usually be `/etc/kernel` (the default), but you may wish
to use `/usr/lib/kernel` instead.
Loading