Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Document required workflow permissions (README regression)

未关闭
#1,913 5 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
30/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
github-actions
领域
documentation

调研方向

将当前 README 与链接的旧版 README 修订进行比较,然后查看链接的 CodeQL 代码扫描文档,以确定工作流权限应放置在哪里。只有在易于找到的位置记录了私有仓库所需的权限(包括说明为什么需要这些权限)后,才算完成。

由索引模型根据 Issue 内容生成。

描述

CodeQL Action documentation good first 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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

github/codeql-action 的其他 Issue

查看 github/codeql-action 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。