Skip to content

ci: add build-docs workflow#78

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

ci: add build-docs workflow#78
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 70576f4 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 4 days ago

In general, the problem is fixed by adding an explicit permissions block either at the root of the workflow (applies to all jobs) or under the specific job. Since this workflow only delegates to a reusable workflow, the top-level workflow itself typically only needs read access to repository contents (for checkout or for the reusable workflow to read docs). A minimal and safe configuration is permissions: contents: read at the workflow level.

The best way to fix this specific file without changing existing functionality is to add a root-level permissions section beneath the name (or at the same top level as on and jobs). This will apply to all jobs, including build, unless that job or the called reusable workflow overrides permissions. Given the information available, we should choose a least-privilege default: contents: read. If the reusable workflow requires more (e.g., to publish pages or comment on PRs), it can still request elevated permissions in its own file; our addition here will not break that, since job-level permissions in the reusable workflow can be more specific. Concretely, in .github/workflows/build-docs.yml, insert:

permissions:
  contents: read

at the top level between name: Build Docs and on: (or immediately before jobs:; both are valid). No imports or external methods are 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