Skip to content

ci: add build-docs workflow#42

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

ci: add build-docs workflow#42
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 a37c2ba into main Mar 13, 2026
@jimisola jimisola deleted the ci/add-build-docs-workflow branch March 13, 2026 20:20

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 1 day ago

In general, the fix is to explicitly declare a permissions block in the workflow, applying the principle of least privilege. Since this workflow only delegates to a reusable workflow and does not itself need to write to the repository, a minimal, safe default is permissions: contents: read at the top level, which applies to all jobs without their own permissions block.

The best way to fix this specific file without changing functionality is to add a root-level permissions section between the on: block and the jobs: block. This will set the default permissions for the build job that calls the reusable workflow. Concretely, in .github/workflows/build-docs.yml, insert:

permissions:
  contents: read

at line 13 (before jobs:). No imports or additional definitions are needed; this is standard GitHub Actions YAML configuration.

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