Skip to content

ci: add build-docs workflow#153

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

ci: add build-docs workflow#153
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 8740e35 into main Mar 13, 2026
6 checks passed
@jimisola jimisola deleted the ci/add-build-docs-workflow branch March 13, 2026 20:17

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 3 days ago

Generally, the fix is to add an explicit permissions: block that grants only the minimal access needed to build the docs. Because this workflow simply delegates to a reusable workflow via uses:, and we cannot see any need for write access from the snippet, the safest and least intrusive change is to set workflow-wide read-only permissions (e.g., contents: read). This documents the intended access and prevents the token from having elevated privileges if repository or organization defaults are broad.

Concretely, in .github/workflows/build-docs.yml, add a permissions: section at the root level (between the on: block and jobs:) specifying read-only access. A minimal and common baseline is:

permissions:
  contents: read

This applies to all jobs (including the build job using the reusable workflow) that do not override permissions: themselves. No additional imports or methods are required since this is a YAML configuration change only, and it does not alter the functional behavior of the docs build, only the scope of the GITHUB_TOKEN.

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