File tree Expand file tree Collapse file tree 2 files changed +43
-10
lines changed Expand file tree Collapse file tree 2 files changed +43
-10
lines changed Original file line number Diff line number Diff line change 1
1
# NodeSecure CI Action
2
2
3
- Please refer to the [ @nodesecure/ci ] ( https://github.com/NodeSecure/ci ) documentation to see more about available options.
3
+ @nodesecure/ci brings together a set of tools to identify dependencies vulnerabilities
4
+ and track most common malicious code and patterns.
4
5
5
- ## Example of options
6
+ Please refer to the [ @ nodesecure/ci ] ( https://github.com/NodeSecure/ci ) documentation to see more about the project.
6
7
8
+ ## Usage
9
+ ### Add to an existing Workflow
10
+
11
+ Simply add this action to your workflow
12
+
13
+ ``` yaml
14
+ uses :
NodeSecure/[email protected]
15
+ ` ` `
16
+
17
+ ### Add a new dedicated Workflow
18
+
19
+ Here's a sample complete workflow you can add to your repositories:
20
+
21
+ **` .github/workflows/nodesecure.yml`**
7
22
` ` ` yaml
8
- with :
9
- strategy : npm
10
- vulnerabilities : medium
11
- warnings : off
12
- reporters : console
13
- ` ` `
23
+ name: "NodeSecure Continuous Integration"
24
+ on: [push]
25
+
26
+ jobs:
27
+ validation:
28
+ name: "Validation"
29
+ runs-on: ubuntu-latest
30
+ steps:
31
+ - uses: actions/checkout@v2
32
+ - uses: NodeSecure/[email protected]
33
+ with:
34
+ strategy: npm
35
+ vulnerabilities: medium
36
+ warnings: off
37
+ reporters: console
38
+ ` ` `
39
+
Original file line number Diff line number Diff line change 1
- name : ' NodeSecure CI '
1
+ name : ' NodeSecure Continuous Integration '
2
2
description : ' Pipeline of tools that identify dependencies vulnerabilities and track malicious code'
3
+ author : ' NodeSecure'
4
+
3
5
inputs :
4
6
directory :
5
7
description : ' Root directory from which the analyses will be run'
@@ -20,6 +22,11 @@ inputs:
20
22
description : ' Pipeline reporters'
21
23
required : false
22
24
default : ' console'
25
+
23
26
runs :
24
27
using : ' node16'
25
- main : ' index.js'
28
+ main : ' index.js'
29
+
30
+ branding :
31
+ icon : ' shield'
32
+ color : purple
You can’t perform that action at this time.
0 commit comments