Skip to content

ci: add build-docs workflow #85

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

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

To fix this, explicitly define a minimal permissions: block for the workflow so that the GITHUB_TOKEN is constrained to least privilege rather than inheriting potentially broad defaults. Because this workflow is only orchestrating a reusable workflow to build docs and does not appear to need write access to repository contents, an appropriate minimal set is contents: read. Adding the permissions: block at the workflow root (top level, alongside name, on, and jobs) will apply to all jobs that don’t define their own permissions, including the build job that uses the reusable workflow.

Concretely, edit .github/workflows/build-docs.yml and insert a permissions: section after the name: (or before jobs:) with contents: read. No additional imports or dependencies are needed; this is pure GitHub Actions YAML configuration and does not change existing functionality, as read access is sufficient for checking out code and building documentation.

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