Skip to content

ci: add build-docs workflow #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jimisola merged 1 commit into from
Mar 13, 2026
Merged

ci: add build-docs workflow #153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/workflows/build-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Build Docs
on:
workflow_dispatch:
pull_request:
paths:
- "docs/**"
push:
branches:
- main
paths:
- "docs/**"

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 7 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.
Loading