You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-34Lines changed: 8 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,6 @@ you are using. We currently support:
20
20
*[Ruby](ruby)
21
21
*[Scala](scala)
22
22
*[Docker](docker)
23
-
*[Setup](setup)
24
23
25
24
Here's an example of using one of the Actions, in this case to test a Node.js project:
26
25
@@ -61,37 +60,11 @@ jobs:
61
60
62
61
See the individual Actions linked above for per-language instructions.
63
62
64
-
Note that GitHub Actions will not pass on secrets set in the repository to forks being used in pull requests, and so the Snyk actions that require the token will fail to run.
63
+
Note: GitHub Actions will not pass on secrets set in the repository to forks being used in pull requests, and so the Snyk actions that require the token will fail to run.
65
64
65
+
## Getting your Snyk token
66
66
67
-
### Bring your own development environment
68
-
69
-
The per-language Actions automatically install all the required development tools for Snyk to determine the correct dependencies and hence vulnerabilities from different language environments. If you have a workflow where you already have those installed then you can instead use the `snyk/actions/setup` Action to just install Snyk
70
-
71
-
```yaml
72
-
name: Snyk example
73
-
on: push
74
-
jobs:
75
-
security:
76
-
runs-on: ubuntu-latest
77
-
steps:
78
-
- uses: actions/checkout@master
79
-
- uses: snyk/actions/setup@master
80
-
- uses: actions/setup-go@v1
81
-
with:
82
-
go-version: "1.13"
83
-
- name: Snyk monitor
84
-
run: snyk test
85
-
env:
86
-
SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}
87
-
```
88
-
89
-
The example here uses `actions/setup-go` would you would need to select the right actions to install the relevant development requirements for your project. If you are already using the same pipeline to build and test your application you're likely already doing so.
90
-
91
-
92
-
### Getting your Snyk token
93
-
94
-
The Actions example above refer to a Snyk API token:
67
+
The Actions example above refer to a Snyk API token:
95
68
96
69
```yaml
97
70
env:
@@ -100,12 +73,10 @@ env:
100
73
101
74
Every Snyk account has this token, and you can find it in one of two ways:
102
75
1. If you're using the [Snyk CLI](https://support.snyk.io/hc/en-us/articles/360003812458-Getting-started-with-the-CLI) you can retrieve it by running `snyk config get api`.
103
-
2. In the UI, go to your Snyk account's [settings page](https://app.snyk.io/account) and retrieve the API token, as shown in the following [Revoking and regenerating Snyk API tokens](https://support.snyk.io/hc/en-us/articles/360004008278-Revoking-and-regenerating-Snyk-API-tokens).
104
-
76
+
2. In the UI, go to your account's general settings page (https://app.snyk.io/account) and retrieve the API token, as shown in the following [Revoking and regenerating Snyk API tokens](https://support.snyk.io/hc/en-us/articles/360004008278-Revoking-and-regenerating-Snyk-API-tokens).
105
77
106
-
### Continuing on error
107
78
108
-
The above examples will fail the workflow when issues are found. If you want to ensure the Action continues, even if Snyk finds vulnerabilities, then [continue-on-error](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error) can be used..
79
+
Note: The above examples will halt the action when issues are found. If you want to ensure the action continues, even if Snyk finds issues, then [conmtinue-on-error]https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error will need to be set.
109
80
110
81
```yaml
111
82
name: Example workflow using Snyk with continue on error
0 commit comments