Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Document required workflow permissions (README regression)

Đang mở
#1,913 5 bình luận 3 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
30/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github-actions
Lĩnh vực
documentation

Hướng nghiên cứu

So sánh README hiện tại với bản sửa đổi README cũ hơn được liên kết, sau đó xem lại tài liệu CodeQL được liên kết về code scanning để xác định nơi đặt các quyền của workflow. Công việc được xem là hoàn tất khi các quyền cần thiết cho các repository riêng tư, bao gồm lý do cần các quyền đó, được ghi lại ở một vị trí dễ tìm.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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!

Ngôn ngữ chính
TypeScript
Star
1.6k
Fork
493
Merge trung bình
1 ngày 13 giờ
Pull request đã merge (30 ngày)
44

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/codeql-action

Tất cả issue của github/codeql-action

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.