Skip to content

Commit 9e18494

Browse files
authored
Update README.md
1 parent c33f75c commit 9e18494

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ In general, integrating Coderrect requires two steps:
3030
2. Apply Coderrect Github Action
3131
```yaml
3232
- name: Coderrect Scan
33-
uses: coderrect-inc/coderrect-github-action@v0.4
33+
uses: coderrect-inc/coderrect-github-action@v0.5
3434
```
3535
3636
### For CMake projects
@@ -47,7 +47,7 @@ Since we are building the project under the `build` directory instead of the roo
4747
We will also need to specify the build directory for Coderrect.
4848
```yaml
4949
- name: Coderrect Scan
50-
uses: coderrect-inc/coderrect-github-action@v0.4
50+
uses: coderrect-inc/coderrect-github-action@v0.5
5151
with:
5252
buildPath: "build"
5353
```
@@ -63,7 +63,7 @@ You will need to install the fortran compiler first. For example:
6363
Then it is likely that you need to specify the fortran compiler when you use `make`. If so, you should also pass the full compilation command to Coderrect. (`gcc` is pre-installed in the Github Action environment.)
6464
```yaml
6565
- name: coderrect scan
66-
uses: coderrect-inc/coderrect-github-action@v0.4
66+
uses: coderrect-inc/coderrect-github-action@v0.5
6767
with:
6868
buildCommand: "make COMPILER=GNU MPI_COMPILER=gfortran C_MPI_COMPILER=gcc"
6969
```
@@ -76,7 +76,7 @@ Coderrect allows you to provide a configuration file to fully customize your ana
7676
In order to do so, check our [documentation](https://coderrect.com/documentation/reference/) to see available configurations. Once you write a configuration file (say `coderrect.json`). You can pass it to the scanner as below:
7777
```yaml
7878
- name: coderrect scan
79-
uses: coderrect-inc/coderrect-github-action@v0.4
79+
uses: coderrect-inc/coderrect-github-action@v0.5
8080
with:
8181
options: "-conf=/path/to/coderrect.json"
8282
```
@@ -96,6 +96,9 @@ The path should be **a relative path from your build directory** (e.g., if your
9696
- `options`
9797
- Default: `"-analyzeAllBinaries"`
9898
- Description: The command line options for Coderrect Scanner. Check the [documentation](https://coderrect.com/documentation/reference/) for all supported options.
99+
- `exit0`
100+
- Default: false
101+
- Description: By default, Coderrect will exit with 1 if any race is detected, thus your following CI/CD workflow will be blocked. Set this to true if you want CI/CD to proceed after Coderrect no matter what.
99102

100103
## License
101104
Copyright 2020 Coderrect Inc.

0 commit comments

Comments
 (0)