Skip to content

ci: add build-docs workflow #78

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 #78

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

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