Skip to content

Commit 8c5a043

Browse files
committed
update readme
1 parent e753792 commit 8c5a043

1 file changed

Lines changed: 12 additions & 15 deletions

File tree

README.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,16 @@ jobs:
3232

3333
# Initializes the CodeQL tools for scanning.
3434
- name: Initialize CodeQL
35-
uses: Anthophila/codeql-action/codeql/init@master
35+
uses: github/codeql-action/init@v1
3636
# Override language selection by uncommenting this and choosing your languages
3737
# with:
3838
# languages: go, javascript, csharp, python, cpp, java
3939

4040
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
41-
# If this step fails, then you should remove it and run the build manually (see bellow)
41+
# If this step fails, then you should remove it and run the build manually (see below)
4242
# custom build steps.
4343
- name: Autobuild
44-
uses: Anthophila/codeql-action/codeql/autobuild@master
44+
uses: github/codeql-action/autobuild@v1
4545

4646
# ℹ️ Command-line programs to run using the OS shell.
4747
# 📚 https://git.io/JvXDl
@@ -55,14 +55,14 @@ jobs:
5555
# make release
5656

5757
- name: Perform CodeQL Analysis
58-
uses: Anthophila/codeql-action/codeql/finish@master
58+
uses: github/codeql-action/analyze@v1
5959
```
6060
6161
If you prefer to integrate this within an existing CI workflow, it should end up looking something like this:
6262
6363
```yaml
6464
- name: Initialize CodeQL
65-
uses: Anthophila/codeql-action/codeql/init@master
65+
uses: github/codeql-action/init@v1
6666
with:
6767
languages: go, javascript
6868

@@ -72,7 +72,7 @@ If you prefer to integrate this within an existing CI workflow, it should end up
7272
make release
7373
7474
- name: Perform CodeQL Analysis
75-
uses: Anthophila/codeql-action/codeql/finish@master
75+
uses: github/codeql-action/analyze@master
7676
```
7777
### Actions triggers
7878
The CodeQL action should be run on `push` events, and on a `schedule`. `Push` events allow us to do detailed analysis of the delta in a pull request, while the `schedule` event ensures that GitHub regularly scans the repository for the latest vulnerabilities, even if the repository becomes inactive. This action does not support the `pull_request` event.
@@ -89,7 +89,7 @@ Identifying potential files for extraction:
8989
Use the config-file parameter of the codeql/init action to enable the configuration file. For example:
9090

9191
```yaml
92-
- uses: Anthophila/codeql-action/codeql/init@master
92+
- uses: github/codeql-action/init@master
9393
with:
9494
config-file: ./.github/codeql/codeql-config.yml
9595
```
@@ -117,8 +117,6 @@ paths-ignore:
117117
- lib
118118
```
119119

120-
Some example QL packs can be found here: https://github.com/Anthophila/python-querypack https://github.com/Anthophila/javascript-querypack
121-
122120
## Troubleshooting
123121

124122
### Trouble with Go dependencies
@@ -130,7 +128,7 @@ Try passing
130128
env:
131129
GOFLAGS: "-mod=vendor"
132130
```
133-
to `Anthophila/codeql-action/codeql/finish`.
131+
to `github/codeql-action/analyze`.
134132
135133
### If you do not use a vendor directory
136134
@@ -141,19 +139,18 @@ Dependencies on public repositories should just work. If you have dependencies o
141139
env:
142140
TOKEN: ${{ secrets.GITHUB_PAT }}
143141
run: |
144-
git config --global url."https://${TOKEN}@github.com/github/foo".insteadOf "https://github.com/github/foo"
145-
git config --global url."https://${TOKEN}@github.com/github/bar".insteadOf "https://github.com/github/bar"
146-
git config --global url."https://${TOKEN}@github.com/github/baz".insteadOf "https://github.com/github/baz"
142+
git config --global url."https://${TOKEN}@github.com/foo/bar".insteadOf "https://github.com/foo/bar"
143+
git config --global url."https://${TOKEN}@github.com/foo/baz".insteadOf "https://github.com/foo/baz"
147144
```
148145
before any codeql actions. A similar thing can also be done with a SSH key or deploy key.
149146
150147
### C# using dotnet version 2 on linux
151148
152-
This unfortunately doesn't work properly unless `dotnet` is invoked with the `/p:UseSharedCompilation=false` flag. For example:
149+
This currently requires invoking `dotnet` with the `/p:UseSharedCompilation=false` flag. For example:
153150
```
154151
dotnet build /p:UseSharedCompilation=false
155152
```
156-
Version 3 works fine and does not require the additional flag.
153+
Version 3 does not require the additional flag.
157154
158155
## License
159156

0 commit comments

Comments
 (0)