Skip to content

Commit e222141

Browse files
dotkascarru93
andauthored
fix: update upload-sarif documentations (#196)
Co-authored-by: caru93 <ema.caruso2@gmail.com>
1 parent 42be729 commit e222141

File tree

38 files changed

+456
-38
lines changed

38 files changed

+456
-38
lines changed

_templates/README.md.erb

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
7171

7272
```yaml
7373
name: Example workflow for <%= @name %> using Snyk
74+
7475
on: push
76+
7577
jobs:
7678
security:
79+
7780
runs-on: ubuntu-latest
81+
82+
permissions:
83+
security-events: write
84+
85+
# If your repository is private, also add:
86+
actions: read
87+
contents: read
88+
7889
steps:
7990
- uses: actions/checkout@master
8091
- name: Run Snyk to check for vulnerabilities
@@ -85,7 +96,7 @@ jobs:
8596
with:
8697
args: --sarif-file-output=snyk.sarif
8798
- name: Upload result to GitHub Code Scanning
88-
uses: github/codeql-action/upload-sarif@v2
99+
uses: github/codeql-action/upload-sarif@v3
89100
with:
90101
sarif_file: snyk.sarif
91102
```

cocoapods/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6363

6464
```yaml
6565
name: Example workflow for CocoaPods using Snyk
66+
6667
on: push
68+
6769
jobs:
6870
security:
71+
6972
runs-on: ubuntu-latest
73+
74+
permissions:
75+
security-events: write
76+
77+
# If your repository is private, also add:
78+
actions: read
79+
contents: read
80+
7081
steps:
7182
- uses: actions/checkout@master
7283
- name: Run Snyk to check for vulnerabilities
@@ -77,7 +88,7 @@ jobs:
7788
with:
7889
args: --sarif-file-output=snyk.sarif
7990
- name: Upload result to GitHub Code Scanning
80-
uses: github/codeql-action/upload-sarif@v2
91+
uses: github/codeql-action/upload-sarif@v3
8192
with:
8293
sarif_file: snyk.sarif
8394
```

dotnet/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6464

6565
```yaml
6666
name: Example workflow for dotNET using Snyk
67+
6768
on: push
69+
6870
jobs:
6971
security:
72+
7073
runs-on: ubuntu-latest
74+
75+
permissions:
76+
security-events: write
77+
78+
# If your repository is private, also add:
79+
actions: read
80+
contents: read
81+
7182
steps:
7283
- uses: actions/checkout@master
7384
- name: Run Snyk to check for vulnerabilities
@@ -78,7 +89,7 @@ jobs:
7889
with:
7990
args: --sarif-file-output=snyk.sarif
8091
- name: Upload result to GitHub Code Scanning
81-
uses: github/codeql-action/upload-sarif@v2
92+
uses: github/codeql-action/upload-sarif@v3
8293
with:
8394
sarif_file: snyk.sarif
8495
```

elixir-1.18/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6363

6464
```yaml
6565
name: Example workflow for elixir using Snyk
66+
6667
on: push
68+
6769
jobs:
6870
security:
71+
6972
runs-on: ubuntu-latest
73+
74+
permissions:
75+
security-events: write
76+
77+
# If your repository is private, also add:
78+
actions: read
79+
contents: read
80+
7081
steps:
7182
- uses: actions/checkout@master
7283
- name: Run Snyk to check for vulnerabilities
@@ -77,7 +88,7 @@ jobs:
7788
with:
7889
args: --sarif-file-output=snyk.sarif
7990
- name: Upload result to GitHub Code Scanning
80-
uses: github/codeql-action/upload-sarif@v2
91+
uses: github/codeql-action/upload-sarif@v3
8192
with:
8293
sarif_file: snyk.sarif
8394
```

golang/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6363

6464
```yaml
6565
name: Example workflow for Golang using Snyk
66+
6667
on: push
68+
6769
jobs:
6870
security:
71+
6972
runs-on: ubuntu-latest
73+
74+
permissions:
75+
security-events: write
76+
77+
# If your repository is private, also add:
78+
actions: read
79+
contents: read
80+
7081
steps:
7182
- uses: actions/checkout@master
7283
- name: Run Snyk to check for vulnerabilities
@@ -77,7 +88,7 @@ jobs:
7788
with:
7889
args: --sarif-file-output=snyk.sarif
7990
- name: Upload result to GitHub Code Scanning
80-
uses: github/codeql-action/upload-sarif@v2
91+
uses: github/codeql-action/upload-sarif@v3
8192
with:
8293
sarif_file: snyk.sarif
8394
```

gradle-8-jdk17/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6363

6464
```yaml
6565
name: Example workflow for gradle using Snyk
66+
6667
on: push
68+
6769
jobs:
6870
security:
71+
6972
runs-on: ubuntu-latest
73+
74+
permissions:
75+
security-events: write
76+
77+
# If your repository is private, also add:
78+
actions: read
79+
contents: read
80+
7081
steps:
7182
- uses: actions/checkout@master
7283
- name: Run Snyk to check for vulnerabilities
@@ -77,7 +88,7 @@ jobs:
7788
with:
7889
args: --sarif-file-output=snyk.sarif
7990
- name: Upload result to GitHub Code Scanning
80-
uses: github/codeql-action/upload-sarif@v2
91+
uses: github/codeql-action/upload-sarif@v3
8192
with:
8293
sarif_file: snyk.sarif
8394
```

gradle-8-jdk21/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6363

6464
```yaml
6565
name: Example workflow for gradle using Snyk
66+
6667
on: push
68+
6769
jobs:
6870
security:
71+
6972
runs-on: ubuntu-latest
73+
74+
permissions:
75+
security-events: write
76+
77+
# If your repository is private, also add:
78+
actions: read
79+
contents: read
80+
7081
steps:
7182
- uses: actions/checkout@master
7283
- name: Run Snyk to check for vulnerabilities
@@ -77,7 +88,7 @@ jobs:
7788
with:
7889
args: --sarif-file-output=snyk.sarif
7990
- name: Upload result to GitHub Code Scanning
80-
uses: github/codeql-action/upload-sarif@v2
91+
uses: github/codeql-action/upload-sarif@v3
8192
with:
8293
sarif_file: snyk.sarif
8394
```

gradle-8-jdk24/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6363

6464
```yaml
6565
name: Example workflow for gradle using Snyk
66+
6667
on: push
68+
6769
jobs:
6870
security:
71+
6972
runs-on: ubuntu-latest
73+
74+
permissions:
75+
security-events: write
76+
77+
# If your repository is private, also add:
78+
actions: read
79+
contents: read
80+
7081
steps:
7182
- uses: actions/checkout@master
7283
- name: Run Snyk to check for vulnerabilities
@@ -77,7 +88,7 @@ jobs:
7788
with:
7889
args: --sarif-file-output=snyk.sarif
7990
- name: Upload result to GitHub Code Scanning
80-
uses: github/codeql-action/upload-sarif@v2
91+
uses: github/codeql-action/upload-sarif@v3
8192
with:
8293
sarif_file: snyk.sarif
8394
```

gradle-9-jdk17/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6363

6464
```yaml
6565
name: Example workflow for gradle using Snyk
66+
6667
on: push
68+
6769
jobs:
6870
security:
71+
6972
runs-on: ubuntu-latest
73+
74+
permissions:
75+
security-events: write
76+
77+
# If your repository is private, also add:
78+
actions: read
79+
contents: read
80+
7081
steps:
7182
- uses: actions/checkout@master
7283
- name: Run Snyk to check for vulnerabilities
@@ -77,7 +88,7 @@ jobs:
7788
with:
7889
args: --sarif-file-output=snyk.sarif
7990
- name: Upload result to GitHub Code Scanning
80-
uses: github/codeql-action/upload-sarif@v2
91+
uses: github/codeql-action/upload-sarif@v3
8192
with:
8293
sarif_file: snyk.sarif
8394
```

gradle-9-jdk21/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,21 @@ The Snyk Action will fail when vulnerabilities are found. This would prevent the
6363

6464
```yaml
6565
name: Example workflow for gradle using Snyk
66+
6667
on: push
68+
6769
jobs:
6870
security:
71+
6972
runs-on: ubuntu-latest
73+
74+
permissions:
75+
security-events: write
76+
77+
# If your repository is private, also add:
78+
actions: read
79+
contents: read
80+
7081
steps:
7182
- uses: actions/checkout@master
7283
- name: Run Snyk to check for vulnerabilities
@@ -77,7 +88,7 @@ jobs:
7788
with:
7889
args: --sarif-file-output=snyk.sarif
7990
- name: Upload result to GitHub Code Scanning
80-
uses: github/codeql-action/upload-sarif@v2
91+
uses: github/codeql-action/upload-sarif@v3
8192
with:
8293
sarif_file: snyk.sarif
8394
```

0 commit comments

Comments
 (0)