Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs on resolving CKV2_GHA_1: "Ensure top-level permissions are not set to write-all" #6977

Open
JoshuaKGoldberg opened this issue Jan 27, 2025 · 0 comments

Comments

@JoshuaKGoldberg
Copy link

JoshuaKGoldberg commented Jan 27, 2025

Coming over from eslint/eslint#19356: debugging a the CHKV2_GHA_1 message:

.github/workflows/stale.yml:15:1
 15:1  high  Ensure top-level permissions are not set to write-all  checkov/CKV2_GHA_1

There isn't much documentation on the check that I could find. From https://www.checkov.io/5.Policy%20Index/github_actions.html:

CKV2_GHA_1 | resource | permissions | Ensure top-level permissions are not set to write-all | github_actions | ReadOnlyTopLevelPermissions.yaml

...but that's it, seemingly, on checkov.io?

Request: for at least this rule -and ideally all of the GHA checks-, could the site include an explainer with multi-sentence descriptions of:

  • What the rule checks for
  • Why it checks for that
  • How to resolve its reports

For reference, the ESLint and typescript-eslint docs tend to do this:

Note that this is related to #4127. I filed a new issue here because that one has a lot of comments and seems to be user questions focused on understanding the issue, not a docs request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant