You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# required to fetch internal or private CodeQL packs
36
+
packages: read
37
+
38
+
# only required for workflows in private repositories
39
+
actions: read
40
+
contents: read
41
+
42
+
strategy:
43
+
fail-fast: false
44
+
matrix:
45
+
include:
46
+
- language: actions
47
+
build-mode: none
48
+
- language: go
49
+
build-mode: autobuild
50
+
- language: javascript-typescript
51
+
build-mode: none
52
+
# CodeQL supports the following values keywords for 'language': 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
53
+
# Use `c-cpp` to analyze code written in C, C++ or both
54
+
# Use 'java-kotlin' to analyze code written in Java, Kotlin or both
55
+
# Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
56
+
# To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
57
+
# see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
58
+
# If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
59
+
# your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
60
+
steps:
61
+
- name: Checkout repository
62
+
uses: actions/checkout@v7
63
+
64
+
# Add any setup steps before running the `github/codeql-action/init` action.
65
+
# This includes steps like installing compilers or runtimes (`actions/setup-node`
66
+
# or others). This is typically only required for manual builds.
67
+
# - name: Setup runtime (example)
68
+
# uses: actions/setup-example@v1
69
+
70
+
# Initializes the CodeQL tools for scanning.
71
+
- name: Initialize CodeQL
72
+
uses: github/codeql-action/init@v4
73
+
with:
74
+
languages: ${{ matrix.language }}
75
+
build-mode: ${{ matrix.build-mode }}
76
+
# If you wish to specify custom queries, you can do so here or in a config file.
77
+
# By default, queries listed here will override any specified in a config file.
78
+
# Prefix the list here with "+" to use these queries and those in the config file.
79
+
80
+
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
81
+
# queries: security-extended,security-and-quality
82
+
83
+
# If the analyze step fails for one of the languages you are analyzing with
84
+
# "We were unable to automatically build your code", modify the matrix above
85
+
# to set the build mode to "manual" for that language. Then modify this step
86
+
# to build your code.
87
+
# ℹ️ Command-line programs to run using the OS shell.
88
+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
89
+
- name: Run manual build steps
90
+
if: matrix.build-mode == 'manual'
91
+
shell: bash
92
+
run: |
93
+
echo 'If you are using a "manual" build mode for one or more of the' \
94
+
'languages you are analyzing, replace this with the commands to build' \
Copy file name to clipboardExpand all lines: README.md
+76Lines changed: 76 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -586,6 +586,7 @@ The following sets of tools are available:
586
586
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/comment-discussion-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/comment-discussion-light.png"><imgsrc="pkg/octicons/icons/comment-discussion-light.png"width="20"height="20"alt="comment-discussion"></picture> |`discussions`| GitHub Discussions related tools |
587
587
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/logo-gist-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/logo-gist-light.png"><imgsrc="pkg/octicons/icons/logo-gist-light.png"width="20"height="20"alt="logo-gist"></picture> |`gists`| GitHub Gist related tools |
588
588
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/git-branch-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/git-branch-light.png"><imgsrc="pkg/octicons/icons/git-branch-light.png"width="20"height="20"alt="git-branch"></picture> |`git`| GitHub Git API related tools for low-level Git operations |
589
+
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/law-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/law-light.png"><imgsrc="pkg/octicons/icons/law-light.png"width="20"height="20"alt="law"></picture> |`governance`| Repository governance tools for managing rulesets and custom properties at the repository, organization, and enterprise levels |
589
590
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/issue-opened-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/issue-opened-light.png"><imgsrc="pkg/octicons/icons/issue-opened-light.png"width="20"height="20"alt="issue-opened"></picture> |`issues`| GitHub Issues related tools |
590
591
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/tag-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/tag-light.png"><imgsrc="pkg/octicons/icons/tag-light.png"width="20"height="20"alt="tag"></picture> |`labels`| GitHub Labels related tools |
591
592
| <picture><sourcemedia="(prefers-color-scheme: dark)"srcset="pkg/octicons/icons/bell-dark.png"><sourcemedia="(prefers-color-scheme: light)"srcset="pkg/octicons/icons/bell-light.png"><imgsrc="pkg/octicons/icons/bell-light.png"width="20"height="20"alt="bell"></picture> |`notifications`| GitHub Notifications related tools |
@@ -872,6 +873,81 @@ The following sets of tools are available:
-`bypass_actors`: The actors that can bypass the rules in this ruleset (object[], optional)
881
+
-`conditions`: Conditions for when this ruleset applies, e.g. {"ref_name": {"include": ["refs/heads/main"], "exclude": []}} (object, optional)
882
+
-`enforcement`: The enforcement level of the ruleset. 'evaluate' allows admins to test rules before enforcing them (string, required)
883
+
-`enterprise`: Enterprise slug. Required when level is 'enterprise'. (string, optional)
884
+
-`level`: The level at which the ruleset is configured:
885
+
- 'repository': A ruleset on a single repository (requires 'owner' and 'repo').
886
+
- 'organization': A ruleset covering repositories in an organization (requires 'org').
887
+
- 'enterprise': A ruleset covering repositories across an enterprise (requires 'enterprise'). (string, required)
888
+
-`name`: The name of the ruleset (string, required)
889
+
-`org`: Organization name. Required when level is 'organization'. (string, optional)
890
+
-`owner`: Repository owner. Required when level is 'repository'. (string, optional)
891
+
-`repo`: Repository name. Required when level is 'repository'. (string, optional)
892
+
-`rules`: An array of rules within the ruleset. Each rule is an object with a 'type' (e.g. 'creation', 'deletion', 'non_fast_forward', 'required_signatures', 'pull_request', 'required_status_checks') and, for rules that need configuration, a 'parameters' object (object[], required)
893
+
-`target`: The target of the ruleset. Defaults to 'branch'. 'repository' is only valid for 'organization' and 'enterprise' level rulesets. (string, optional)
-`enterprise`: Enterprise slug. Required when level is 'enterprise'. (string, optional)
909
+
-`level`: The level at which custom properties are managed:
910
+
- 'repository': The custom property VALUES assigned to a repository (requires 'owner' and 'repo').
911
+
- 'organization': The custom property DEFINITIONS (schema) for an organization (requires 'org').
912
+
- 'enterprise': The custom property DEFINITIONS (schema) for an enterprise (requires 'enterprise'). (string, required)
913
+
-`org`: Organization name. Required when level is 'organization'. (string, optional)
914
+
-`owner`: Repository owner. Required when level is 'repository'. (string, optional)
915
+
-`properties`: The custom properties to create or update. At the repository level each item assigns a value ('property_name' and 'value'); at the organization and enterprise levels each item defines the schema ('property_name' and 'value_type', plus optional definition fields). (object[], required)
916
+
-`repo`: Repository name. Required when level is 'repository'. (string, optional)
-`actor_name`: The handle for the GitHub user account to filter rule suites on. Used by the 'list_rule_suites' method. (string, optional)
921
+
-`branch`: Branch name. Required for the 'get_rules_for_branch' method. (string, optional)
922
+
-`enterprise`: Enterprise slug. Required when level is 'enterprise'. (string, optional)
923
+
-`evaluate_status`: Filter rule suites by ruleset evaluation mode. Used by the 'list_rule_suites' method. (string, optional)
924
+
-`includes_parents`: Include rulesets configured at higher levels that also apply. Defaults to true. Used by the 'get' and 'list' methods at the repository level. (boolean, optional)
925
+
-`level`: The level at which the ruleset is configured:
926
+
- 'repository': A ruleset on a single repository (requires 'owner' and 'repo').
927
+
- 'organization': A ruleset covering repositories in an organization (requires 'org').
928
+
- 'enterprise': A ruleset covering repositories across an enterprise (requires 'enterprise'). (string, required)
929
+
-`method`: Operation to perform:
930
+
- 'get': Get a specific ruleset by ID (requires 'ruleset_id'). Supported at every level.
931
+
- 'list': List all rulesets. Supported at every level.
932
+
- 'get_rules_for_branch': Get all rules that apply to a branch (requires 'branch'). Repository level only.
933
+
- 'list_rule_suites': List rule suites, the evaluations of rules against pushes. Repository and organization levels only.
934
+
- 'get_rule_suite': Get a specific rule suite by ID (requires 'rule_suite_id'). Repository and organization levels only. (string, required)
935
+
-`org`: Organization name. Required when level is 'organization'. (string, optional)
936
+
-`owner`: Repository owner. Required when level is 'repository'. (string, optional)
937
+
-`page`: Page number for pagination (min 1) (number, optional)
938
+
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
939
+
-`ref`: The name of the ref (branch, tag, etc.) to filter rule suites by. Used by the 'list_rule_suites' method. (string, optional)
940
+
-`repo`: Repository name. Required when level is 'repository'. (string, optional)
941
+
-`repository_name`: Repository name to filter rule suites by. Used by the 'list_rule_suites' method at the organization level. (string, optional)
942
+
-`rule_suite_id`: Rule suite ID. Required for the 'get_rule_suite' method. (number, optional)
943
+
-`rule_suite_result`: The rule suite result to filter by. Used by the 'list_rule_suites' method. (string, optional)
944
+
-`ruleset_id`: Ruleset ID. Required for the 'get' method. (number, optional)
945
+
-`time_period`: The time period to filter rule suites by. Used by the 'list_rule_suites' method. (string, optional)
0 commit comments