Document required workflow permissions (README regression)

Offen

#1,913 erstellt am 02.10.2023 5 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 30/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: github-actions
Bereich: documentation

Rechercherichtung

Vergleiche die aktuelle README mit der verlinkten älteren README-Revision und prüfe anschließend die verlinkte CodeQL-Dokumentation zum Code-Scanning, um festzustellen, wo Workflow-Berechtigungen hingehören. Die Aufgabe ist erledigt, wenn die erforderlichen Berechtigungen für private Repositorys einschließlich der Gründe, warum sie benötigt werden, an einer leicht auffindbaren Stelle dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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!

Vorherrschende Sprache: TypeScript
Sterne: 1.6k
Forks: 493
Ø Merge: 1 T. 13 Std.
Gemergte PRs (30 T.): 44

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/codeql-action

upload-sarif always warns when setting partialFingerprints Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

github/codeql-action#4052 · 4 Kommentare · Erstellt am 29.7.2026
Ruby (build-mode=none) default-setup analysis fails with "no source code was seen" on pull_request events, but succeeds on push — traced to --no-calculate-baseline Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

github/codeql-action#4078 · 1 Kommentar · Erstellt am 05.8.2026
CodeQL autobuild hangs forever on failure Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 48/100

github/codeql-action#4008 · 9 Kommentare · Erstellt am 14.7.2026
`codeql-action/init` Makes Metal Toolchain Unavailable on macOS 26 Runners Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100

github/codeql-action#3978 · 4 Kommentare · 1 Reaktion · Erstellt am 26.6.2026
CodeQL fails to detect rust/insecure-cookie in Rust code Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 48/100

github/codeql-action#3915 · 6 Kommentare · 3 Reaktionen · Erstellt am 19.5.2026

Alle Issues in github/codeql-action