Skip to content

Commit 0961bc5

Browse files
DOC: Add MAINTAINERS.md with notes on grype security scans
1 parent 094b6e1 commit 0961bc5

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

MAINTAINERS.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# upload-nightly-action Maintainer Notes
2+
3+
## Grype security scans in CI
4+
5+
[`grype`](https://github.com/anchore/grype) is used to perform scheduled security scans of the `upload-nightly-action` Pixi environment in CI.
6+
In the event that the scan fails, a maintainer should:
7+
8+
1. Check to see if the detected vulnerability can be avoided by upgrading dependencies with
9+
10+
```
11+
pixi upgrade
12+
```
13+
14+
2. If the `pixi.lock` has been updated by this action, then the offending packages should be checked for updates with `pixi list` and the `grype` scan should be repeated with
15+
16+
```
17+
pixi run grype
18+
```
19+
20+
3. If the `pixi.lock` lock file is not updated try resolving the lock file fresh with
21+
22+
```
23+
pixi reinstall
24+
```
25+
26+
or by
27+
28+
```
29+
rm pixi.lock && pixi lock
30+
```
31+
32+
and then running the scan again
33+
34+
35+
```
36+
pixi run grype
37+
```
38+
39+
4. If the `pixi.lock` lock file is still not updated with fixes to the offending packages, then the changes to the `pixi.toml` Pixi manifest and `pixi.lock` lock file can be ignored/reverted and a maintainer should open up a tracking GitHub issue that reports the vulnerability and summarizes their understanding of the root cause of the vulnerability being introduced to the environment.
40+
`pixi tree --invert` may help with this.
41+
42+
Example:
43+
44+
```
45+
pixi tree --invert openssl
46+
```

0 commit comments

Comments
 (0)