Skip to content

ci: add build-docs workflow#148

Merged
jimisola merged 1 commit intomainfrom
ci/add-build-docs-workflow
Mar 13, 2026
Merged

ci: add build-docs workflow#148
jimisola merged 1 commit intomainfrom
ci/add-build-docs-workflow

Conversation

@jimisola
Copy link
Member

Summary

  • Add caller workflow for centralized Antora docs build validation
  • Runs on PRs and pushes to main when docs/** files change
  • Calls reusable workflow from reqstool/.github

Test plan

  • Verify Build Docs workflow passes after merge

Call the centralized reusable workflow from reqstool/.github to validate
Antora docs build cleanly on PRs and pushes to main.

Signed-off-by: jimisola <jimisola@jimisola.com>
@jimisola jimisola self-assigned this Mar 13, 2026
@jimisola jimisola merged commit ccda724 into main Mar 13, 2026
6 checks passed
@jimisola jimisola deleted the ci/add-build-docs-workflow branch March 13, 2026 20:11

jobs:
build:
uses: reqstool/.github/.github/workflows/build-docs.yml@main

Check warning

Code scanning / CodeQL

Workflow does not contain permissions Medium

Actions job or workflow does not limit the permissions of the GITHUB_TOKEN. Consider setting an explicit permissions block, using the following as a minimal starting point: {}

Copilot Autofix

AI 2 days ago

In general, the fix is to add an explicit permissions block that grants only the minimal GITHUB_TOKEN scopes required by this workflow. Because this workflow’s sole job delegates to a reusable workflow that builds documentation, it almost certainly only needs read access to repository contents and packages. GitHub’s recommended baseline for read‑only is permissions: contents: read (and optionally packages: read), which satisfies the CodeQL rule and documents intended access.

The single best fix here, without changing functionality, is to define permissions at the workflow root so that it applies to all jobs (including the build job that calls the reusable workflow). We’ll add, just below the on: block, a permissions: section that limits contents to read (and optionally packages to read if you want parity with GitHub’s recommended read‑only defaults). This does not change how the reusable workflow is invoked; it only constrains the GITHUB_TOKEN for this workflow’s jobs. Concretely, in .github/workflows/build-docs.yml, between the on: block (lines 2–11) and jobs: (line 13), we’ll insert:

permissions:
  contents: read

No imports or additional methods are needed because this is declarative YAML configuration, not executable code.

Suggested changeset 1
.github/workflows/build-docs.yml

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -10,6 +10,9 @@
     paths:
       - "docs/**"
 
+permissions:
+  contents: read
+
 jobs:
   build:
     uses: reqstool/.github/.github/workflows/build-docs.yml@main
EOF
@@ -10,6 +10,9 @@
paths:
- "docs/**"

permissions:
contents: read

jobs:
build:
uses: reqstool/.github/.github/workflows/build-docs.yml@main
Copilot is powered by AI and may make mistakes. Always verify output.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant