Skip to content

Commit 7133b69

Browse files
chore: update docs and branding
1 parent 39db7a1 commit 7133b69

File tree

2 files changed

+43
-10
lines changed

2 files changed

+43
-10
lines changed

README.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,39 @@
11
# NodeSecure CI Action
22

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.
45

5-
## Example of options
6+
Please refer to the [@nodesecure/ci](https://github.com/NodeSecure/ci) documentation to see more about the project.
67

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`**
722
```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+

action.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
name: 'NodeSecure CI'
1+
name: 'NodeSecure Continuous Integration'
22
description: 'Pipeline of tools that identify dependencies vulnerabilities and track malicious code'
3+
author: 'NodeSecure'
4+
35
inputs:
46
directory:
57
description: 'Root directory from which the analyses will be run'
@@ -20,6 +22,11 @@ inputs:
2022
description: 'Pipeline reporters'
2123
required: false
2224
default: 'console'
25+
2326
runs:
2427
using: 'node16'
25-
main: 'index.js'
28+
main: 'index.js'
29+
30+
branding:
31+
icon: 'shield'
32+
color: purple

0 commit comments

Comments
 (0)