Skip to content

Commit 02970e4

Browse files
author
jossef
committed
docs: updated readme
1 parent c7d92d3 commit 02970e4

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Learning the lessons of these supply chain incidents we've created **ChainAlert*
1515
ChainAlert cloud service continuously monitor and analyse new releases of packages:
1616
- Detection of newly added auto install scripts such as `install`, `preinstall`, `postinstall`
1717
- Checking the consistency of the version and if presented in the package's linked git repository tags
18+
- Changes in package maintainers
1819

1920
![Group 468](https://user-images.githubusercontent.com/1287098/144894054-1ca132cf-e3f2-448a-bfdb-d04b00cbd02c.png)
2021

@@ -29,17 +30,15 @@ If ChainAlert finds a suspicious activity of a package, it will automatically op
2930

3031
### How Do I Opt In?
3132

32-
You need to add our [GitHub action](https://github.com/marketplace/actions/chainalert) to your project. If you already have an existing workflow, add the following step:
33+
You need to add our [GitHub action](https://github.com/marketplace/actions/chainalert) to your project as a cron job.
3334

34-
```yml
35-
- uses: checkmarx/chainalert-github-action@v1
36-
```
37-
38-
Alternatively, create a dedicated workflow file under `.github/workflows/chainalert.yml`
35+
Create a dedicated workflow file under `.github/workflows/chainalert.yml`
3936

4037
```yml
4138
name: ChainAlert
4239
on:
40+
schedule:
41+
- cron: '0 0 * * *'
4342
push:
4443
branches: [ master ]
4544
jobs:
@@ -50,6 +49,7 @@ jobs:
5049
- uses: checkmarx/chainalert-github-action@v1
5150
```
5251
- 💡 This action and service are only available for public GitHub projects
52+
- 💡 If our service stops receiving for more than 2 days, we will automatically opt you out
5353
5454
5555
### Features

0 commit comments

Comments
 (0)