Skip to content

Commit 79e006c

Browse files
authored
Update README.md
1 parent 458585d commit 79e006c

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

README.md

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This repository contains [CodeQL](https://codeql.github.com/) models and queries
77
### Published CodeQl packs
88
- [advanced-security/javascript-sap-cap-queries](https://github.com/advanced-security/codeql-sap-js/pkgs/container/javascript-sap-cap-queries)
99
- [advanced-security/javascript-sap-ui5-queries](https://github.com/advanced-security/codeql-sap-js/pkgs/container/javascript-sap-ui5-queries)
10-
- [advanced-security/javascript-sap-async-xsjs-queries](https://github.com/advanced-security/codeql-sap-async-xsjs/pkgs/container/javascript-sap-async-xsjs-queries)
10+
- [advanced-security/javascript-sap-async-xsjs-queries](https://github.com/advanced-security/codeql-sap-js/pkgs/container/javascript-sap-async-xsjs-queries)
1111

1212
## Usage
1313

@@ -35,8 +35,53 @@ codeql database create <DB_NAME> --language=javascript
3535
```
3636

3737
### Analyzing the database with [Code Scanning](https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#using-query-packs)
38-
Example [configuration file](https://github.com/advanced-security/codeql-sap-js/blob/main/.github/codeql/codeql-config.yaml#L3-L7).
39-
38+
Example workflow file:
39+
```yaml
40+
jobs:
41+
analyze-javascript:
42+
name: Analyze
43+
runs-on: 'ubuntu-latest'
44+
permissions:
45+
actions: read
46+
contents: read
47+
security-events: write
48+
49+
- name: Compile CDS files
50+
run: |
51+
npm install -g @sap/cds-dk
52+
for cds_file in $(find . -type f \( -iname '*.cds' \) -print)
53+
do
54+
cds compile $cds_file \
55+
-2 json \
56+
-o "$cds_file.json" \
57+
--locations
58+
done
59+
60+
- name: Initialize CodeQL
61+
uses: github/codeql-action/init@v3
62+
with:
63+
languages: javascript
64+
config-file: .github/codeql/codeql-config.yaml
65+
66+
- name: Perform CodeQL Analysis
67+
id: analyze
68+
uses: github/codeql-action/analyze@v3
69+
```
70+
Exmaple configuration file:
71+
```yaml
72+
name: "My CodeQL config"
73+
74+
packs:
75+
# Use these packs for JavaScript and TypeScript analysis
76+
javascript:
77+
- codeql/javascript-queries:codeql-suites/javascript-security-extended.qls
78+
- advanced-security/javascript-sap-async-xsjs-queries:codeql-suites/javascript-security-extended.qls
79+
- advanced-security/javascript-sap-cap-queries:codeql-suites/javascript-security-extended.qls
80+
- advanced-security/javascript-sap-ui5-queries:codeql-suites/javascript-security-extended.qls
81+
82+
paths-ignore:
83+
- "**/node_modules"
84+
```
4085
### Analyzing the database with the [CodeQL CLI](https://docs.github.com/en/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs#using-a-codeql-pack-to-analyze-a-codeql-database)
4186
Example:
4287
```

0 commit comments

Comments
 (0)