-
Notifications
You must be signed in to change notification settings - Fork 70
Add workflow permissions #998
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.
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
base: main
Are you sure you want to change the base?
Add workflow permissions #998
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds explicit permission declarations to GitHub Actions workflow files to follow security best practices by limiting workflow permissions to only what's needed. This implements the principle of least privilege for GitHub Actions workflows.
Key Changes
- Added
permissionsblocks to 18 workflow files with appropriate access levels - Most read-only workflows receive
contents: readpermission - Workflows that modify repository state receive elevated permissions like
contents: write,pull-requests: write, oractions: write
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
.github/workflows/verify-standard-library-dependencies.yml |
Added read-only permissions for verification workflow |
.github/workflows/validate-release.yml |
Added read/write permissions for validation workflow that needs to write checks and PR comments |
.github/workflows/validate-query-test-case-formatting.yml |
Added read-only permissions for formatting validation |
.github/workflows/validate-query-help.yml |
Added read-only permissions for help file validation |
.github/workflows/validate-query-formatting.yml |
Added read-only permissions for query formatting validation |
.github/workflows/validate-package-files.yml |
Added read-only permissions for package validation |
.github/workflows/upgrade_codeql_dependencies.yml |
Added write permissions for workflow that creates PRs |
.github/workflows/update-release.yml |
Added write permissions for release update workflow |
.github/workflows/update-check-run.yml |
Added read-only permissions for check run updates |
.github/workflows/tooling-unit-tests.yml |
Added read-only permissions for unit testing |
.github/workflows/standard_library_upgrade_tests.yml |
Added read-only permissions with typo in permission key |
.github/workflows/generate-html-docs.yml |
Added read-only permissions for documentation generation |
.github/workflows/finalize-release.yml |
Added write permissions for release finalization |
.github/workflows/extra-rule-validation.yml |
Added read-only permissions for rule validation |
.github/workflows/dispatch-release-performance-check.yml |
Added mixed permissions for performance check dispatch |
.github/workflows/dispatch-matrix-test-on-comment.yml |
Added mixed permissions for matrix test dispatch |
.github/workflows/codeql_unit_tests.yml |
Added read-only permissions for CodeQL testing |
.github/workflows/code-scanning-pack-gen.yml |
Added read-only permissions for pack generation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| permissions: | ||
| contents: read |
Copilot
AI
Dec 9, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This workflow has duplicate permissions blocks. Lines 2-3 define contents: read, while lines 42-43 define checks: write. GitHub Actions only supports one permissions block per workflow. The workflow likely needs checks: write permission based on the check run update operation performed in the job. The earlier contents: read permission should be removed or combined with checks: write into a single block at the top level.
Description
please enter the description of your change here
Change request type
.ql,.qll,.qlsor unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.