Skip to content

ci: add build-docs workflow #148

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

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 fix is to add an explicit permissions block that grants only the minimal GITHUB_TOKEN scopes required by this workflow. Because this workflow’s sole job delegates to a reusable workflow that builds documentation, it almost certainly only needs read access to repository contents and packages. GitHub’s recommended baseline for read‑only is permissions: contents: read (and optionally packages: read), which satisfies the CodeQL rule and documents intended access.

The single best fix here, without changing functionality, is to define permissions at the workflow root so that it applies to all jobs (including the build job that calls the reusable workflow). We’ll add, just below the on: block, a permissions: section that limits contents to read (and optionally packages to read if you want parity with GitHub’s recommended read‑only defaults). This does not change how the reusable workflow is invoked; it only constrains the GITHUB_TOKEN for this workflow’s jobs. Concretely, in .github/workflows/build-docs.yml, between the on: block (lines 2–11) and jobs: (line 13), we’ll insert:

permissions:
  contents: read

No imports or additional methods are needed because this is declarative YAML configuration, not executable code.

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