Skip to content

ci: add build-docs workflow#91

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

ci: add build-docs workflow#91
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 5c77cbb 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 6 days ago

In general, fix this by explicitly setting a permissions: block for the workflow or for the specific job, granting only the minimal scopes required. Because this workflow only delegates to a reusable workflow and likely needs no write access itself, a conservative choice is to set contents: read at the workflow root so it applies to all jobs (including build).

Concretely, in .github/workflows/build-docs.yml, add a permissions: section directly under the name: Build Docs line (before on:) with least-privilege settings. A minimal and safe starting point that satisfies CodeQL and GitHub’s recommendations is:

permissions:
  contents: read

This does not change the functional behavior of the workflow steps themselves (they can still read the repository), but it prevents unintended write access through GITHUB_TOKEN unless explicitly re-granted elsewhere (e.g., in the reusable workflow, if needed).

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
@@ -1,4 +1,6 @@
 name: Build Docs
+permissions:
+  contents: read
 on:
   workflow_dispatch:
   pull_request:
EOF
@@ -1,4 +1,6 @@
name: Build Docs
permissions:
contents: read
on:
workflow_dispatch:
pull_request:
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