Document required workflow permissions (README regression)
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 30/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- github-actions
研究方向
比較目前的 README 與連結的較舊 README 修訂版本,然後檢視連結的 CodeQL 程式碼掃描文件,以找出工作流程權限應放置的位置。當私有儲存庫所需的權限(包括說明為什麼需要這些權限)已記錄在容易找到的位置時,即表示完成。
由索引模型根據 Issue 內容生成。
描述
Hello,
I've come across quite a few issues in the repo here that seem to boil down to people not knowing what permissions are needed for enabling CodeQL to work in their workflows. I believe for private repo they are:
# required for all workflows
security-events: write
# only required for workflows in private repositories
actions: read
contents: read
These were documented in an old version of the README, which was super helpful. This was removed by this commit.
The documentation the current README points to seems to focus around enabling CodeQL or Advanced Security for new repos or enabling it for the first time.
But we have several repos that have been around for some time. It doesn't seem right that we should disable/remove CodeQL only to re-enable it using the "defaults" listed above.
I've clicked through all of the links that the current README point to but none of them describe what permissions the code scanning features require. This information seems important to capture somewhere. As a security minded organization, we want to make sure we're only enabling the minimum set of permissions in a repo, and it would be helpful to understand also why a certain action requires a particular permission.
Could we please add a note on permissions on either the About code scanning with CodeQL page, or one that is easily found from that page?
Thanks!
- 主要語言
- TypeScript
- 星號
- 1.6k
- 分支
- 493
- 平均合併
- 1 天 13 小時
- 30 天內合併 PR
- 44
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
github/codeql-action 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 68/100
github/codeql-action#4052 · 4 則留言 ·
-
難度 4/5 3-5 天 新手友好度 45/100
github/codeql-action#4078 · 1 則留言 ·
-
難度 4/5 3-5 天 新手友好度 48/100
github/codeql-action#4008 · 9 則留言 ·
-
難度 4/5 3-5 天 新手友好度 52/100
github/codeql-action#3978 · 4 則留言 · 1 個 reaction ·
-
難度 3/5 1-2 天 新手友好度 48/100
github/codeql-action#3915 · 6 則留言 · 3 個 reaction ·
查看 github/codeql-action 的全部 Issue
相似的 Issue
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs 未關閉
難度 2/5 1-3 小時 新手友好度 70/100
-
Crush 未關閉
難度 1/5 1 小時以內 新手友好度 85/100
catppuccin/catppuccin#3125 ·
-
難度 1/5 1 小時以內 新手友好度 90/100
ElementsProject/cln-application#167 · 1 則留言 · 1 個 reaction ·
-
難度 2/5 1-3 小時 新手友好度 75/100
Quantco/pnpm-licenses#17 ·
-
難度 2/5 1-3 小時 新手友好度 75/100