Skip to content

Commit 57ac0e1

Browse files
committed
docs: Update READMEs
1 parent 0f7a196 commit 57ac0e1

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,18 @@ Using a `githubsecuritylab/codeql-LANG-queries` query pack will reference the de
3333
packs: githubsecuritylab/codeql-${{ matrix.language }}-queries
3434
```
3535
36+
### Using community packs with provided configuration file
37+
38+
This repository has a number of [provided configuration files][configurations] you can use or copy from the community packs.
39+
40+
```yaml
41+
- name: Initialize CodeQL
42+
uses: github/codeql-action/init@v2
43+
with:
44+
languages: ${{ matrix.language }}
45+
config-file: GitHubSecurityLab/CodeQL-Community-Packs:configs/codeql.yml
46+
```
47+
3648
### Using a community pack from the CLI configuration file
3749
3850
```bash
@@ -54,3 +66,7 @@ This project is licensed under the terms of the MIT open source license. Please
5466
## Support
5567

5668
Please [create GitHub issues](https://github.com/advanced-security/brew-dependency-submission-action) for any feature requests, bugs, or documentation problems.
69+
70+
<!-- Resources / Links -->
71+
72+
[configurations]: https://github.com/GitHubSecurityLab/CodeQL-Community-Packs/tree/main/configs

configs/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Community Configurations
2+
3+
## Default / CodeQL
4+
5+
The `codeql.yml` configuration is the default config file used to make it easy to use the CodeQL Community Packs.
6+
7+
## Audit
8+
9+
The `audit.yml` configuration is used primary to audit code by running a number of audit queries with CodeQL.
10+
These are based on the suite in each language suites folder called `{LANG}-audit.qls`
11+
12+
> ![NOTE]
13+
> Current Ruby and Swift are not supported

0 commit comments

Comments
 (0)