Potential fix for code scanning alert no. 2: Workflow does not contain permissions#203
Open
Potential fix for code scanning alert no. 2: Workflow does not contain permissions#203
Conversation
…n permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Potential fix for https://github.com/stripe/sync-engine/security/code-scanning/2
In general, to fix this issue, add an explicit
permissionsblock at either the workflow root or the job level so that theGITHUB_TOKENhas only the minimal privileges required. For a docs deployment that pushes to GitHub Pages (typically togh-pages), it needs permission to read contents and to write contents (to push the generated site). It does not appear to need any other scopes (issues, pull requests, etc.).The best minimal fix here is to add a
permissionsblock under thedeployjob (or at the root) specifyingcontents: write.mkdocs gh-deployusesGITHUB_TOKENto push to thegh-pagesbranch, so write access to repository contents is required; settingcontents: readonly would break the deployment. No other steps in the job need additional scopes. Concretely, in.github/workflows/docs.yml, insert:directly under the job configuration (e.g., below
runs-onor below theif:line) for thedeployjob. No imports or external libraries are involved, and no functional behavior aside from token scoping is changed.Suggested fixes powered by Copilot Autofix. Review carefully before merging.