From 2a52f444453150651ee90560cbf4221bb139a7cd Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 10:35:32 -0400 Subject: [PATCH 1/9] Don't track antsibull-changelog plugin cache. --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 600d2d3..11f9449 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -.vscode \ No newline at end of file +.vscode +changelogs/.plugin-cache.yaml From 5bb433b84c45d2136c45c38433b8ef5a961f1449 Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 10:36:04 -0400 Subject: [PATCH 2/9] Add kernel-install path arg description. --- roles/uki_config/meta/argument_specs.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/roles/uki_config/meta/argument_specs.yaml b/roles/uki_config/meta/argument_specs.yaml index 611b439..861ed17 100644 --- a/roles/uki_config/meta/argument_specs.yaml +++ b/roles/uki_config/meta/argument_specs.yaml @@ -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. From 3dc2316572bdfdc2f88144cd97e2bfc43872760b Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 11:26:55 -0400 Subject: [PATCH 3/9] Allow running lint-docs manually. --- .github/workflows/lint-docs.yaml | 39 ++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/lint-docs.yaml diff --git a/.github/workflows/lint-docs.yaml b/.github/workflows/lint-docs.yaml new file mode 100644 index 0000000..de3ff20 --- /dev/null +++ b/.github/workflows/lint-docs.yaml @@ -0,0 +1,39 @@ +name: build-docs +on: + workflow_dispatch: + + pull_request: + branches: + - main + + jobs: + build-docs: + permissions: + contents: read + name: Build Docs + 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: + permissions: + contents: read + needs: + - build-docs + steps: + - uses: actions/download-artifact@v4 + with: + name: ${{ needs.build-docs.outputs.artifact-name }} + github_token: ${{ secrets.GITHUB_TOKEN }} + - 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 . From f4088c0f3a71d4f2cbefcbd595695ae7f65bd849 Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 11:28:28 -0400 Subject: [PATCH 4/9] Fix indentation --- .github/workflows/lint-docs.yaml | 60 ++++++++++++++++---------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/.github/workflows/lint-docs.yaml b/.github/workflows/lint-docs.yaml index de3ff20..32309db 100644 --- a/.github/workflows/lint-docs.yaml +++ b/.github/workflows/lint-docs.yaml @@ -6,34 +6,34 @@ on: branches: - main - jobs: - build-docs: - permissions: - contents: read - name: Build Docs - uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main - with: - init-lenient: false - init-fail-on-error: true +jobs: + build-docs: + permissions: + contents: read + name: Build Docs + 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: - permissions: - contents: read - needs: - - build-docs - steps: - - uses: actions/download-artifact@v4 - with: - name: ${{ needs.build-docs.outputs.artifact-name }} - github_token: ${{ secrets.GITHUB_TOKEN }} - - 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 . + lint-docs: + permissions: + contents: read + needs: + - build-docs + steps: + - uses: actions/download-artifact@v4 + with: + name: ${{ needs.build-docs.outputs.artifact-name }} + github_token: ${{ secrets.GITHUB_TOKEN }} + - 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 . From 4eefcf6e14c28707f85b1cb194dbfb7a21ba2cee Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 11:29:58 -0400 Subject: [PATCH 5/9] Add job name and runs-on --- .github/workflows/lint-docs.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/lint-docs.yaml b/.github/workflows/lint-docs.yaml index 32309db..e9c503c 100644 --- a/.github/workflows/lint-docs.yaml +++ b/.github/workflows/lint-docs.yaml @@ -8,6 +8,8 @@ on: jobs: build-docs: + name: Build Docs + runs-on: ubuntu-latest permissions: contents: read name: Build Docs @@ -17,6 +19,8 @@ jobs: init-fail-on-error: true lint-docs: + name: Lint Docs + runs-on: ubuntu-latest permissions: contents: read needs: From b534f8bcf9850e2621f568fdaec721ded1c1e7b3 Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 11:31:15 -0400 Subject: [PATCH 6/9] Remove duplicate name key. --- .github/workflows/lint-docs.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/lint-docs.yaml b/.github/workflows/lint-docs.yaml index e9c503c..c6c392a 100644 --- a/.github/workflows/lint-docs.yaml +++ b/.github/workflows/lint-docs.yaml @@ -8,11 +8,9 @@ on: jobs: build-docs: - name: Build Docs runs-on: ubuntu-latest permissions: contents: read - name: Build Docs uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main with: init-lenient: false From 285698acdf6f5fc909ffe5a50ae9b70cd4a1eb97 Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 11:35:05 -0400 Subject: [PATCH 7/9] Add steps list to docs build job --- .github/workflows/lint-docs.yaml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/lint-docs.yaml b/.github/workflows/lint-docs.yaml index c6c392a..426b27f 100644 --- a/.github/workflows/lint-docs.yaml +++ b/.github/workflows/lint-docs.yaml @@ -11,10 +11,11 @@ jobs: runs-on: ubuntu-latest 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 + steps: + - 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 From 9ff8dc3870f62a55a1ec4defe0507b7559b003f2 Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 11:42:28 -0400 Subject: [PATCH 8/9] Revert last commit, remove runner on reusable workflow step. --- .github/workflows/lint-docs.yaml | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/workflows/lint-docs.yaml b/.github/workflows/lint-docs.yaml index 426b27f..4089a92 100644 --- a/.github/workflows/lint-docs.yaml +++ b/.github/workflows/lint-docs.yaml @@ -8,14 +8,12 @@ on: jobs: build-docs: - runs-on: ubuntu-latest permissions: contents: read - steps: - - uses: ansible-community/github-docs-build/.github/workflows/_shared-docs-build-pr.yml@main - with: - init-lenient: false - init-fail-on-error: true + 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 From dcc8a42ac402b42be68f25f15c0cff140a7dcd14 Mon Sep 17 00:00:00 2001 From: Christopher Palmer-Richez Date: Mon, 5 Aug 2024 11:46:12 -0400 Subject: [PATCH 9/9] Lint the repo, not the docsite. This is a fix from a misunderstanding I had. I thought antsibull-docs lints the docsite, but it actually lints the contents of the documentation fragments and argumnent specs. --- .github/workflows/lint-docs.yaml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/workflows/lint-docs.yaml b/.github/workflows/lint-docs.yaml index 4089a92..53a6339 100644 --- a/.github/workflows/lint-docs.yaml +++ b/.github/workflows/lint-docs.yaml @@ -20,13 +20,8 @@ jobs: runs-on: ubuntu-latest permissions: contents: read - needs: - - build-docs steps: - - uses: actions/download-artifact@v4 - with: - name: ${{ needs.build-docs.outputs.artifact-name }} - github_token: ${{ secrets.GITHUB_TOKEN }} + - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: python-version: '3.11'