Skip to content

Commit ee1eb19

Browse files
committed
actions: add description of actionsPermissionsDataModel
1 parent bd7c684 commit ee1eb19

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

actions/ql/lib/codeql/actions/config/ConfigExtensions.qll

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,5 +80,10 @@ extensible predicate untrustedGhCommandDataModel(string cmd_regex, string flag);
8080

8181
/**
8282
* Holds if `action` needs `permission` to run.
83+
* - 'action' is the name of the action without any version information.
84+
* E.g. for the action selector `actions/checkout@v2`, `action` is `actions/checkout`.
85+
* - `permission` is of the form `scope-name: read|write`, for example `contents: read`.
86+
* - see https://github.com/actions/checkout?tab=readme-ov-file#recommended-permissions
87+
* for an example of recommended permissions.
8388
*/
8489
extensible predicate actionsPermissionsDataModel(string action, string permission);

0 commit comments

Comments
 (0)