Skip to content

Commit c01fbd3

Browse files
Fixing vulnerability (eclipse-velocitas#15)
Co-authored-by: BjoernAtBosch <[email protected]>
1 parent 22a8b1e commit c01fbd3

File tree

3 files changed

+32
-5
lines changed

3 files changed

+32
-5
lines changed

NOTICE-3RD-PARTY-CONTENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107
|commander|9.1.0|MIT|
108108
|concat-map|0.0.1|MIT|
109109
|create-require|1.1.1|MIT|
110-
|cross-spawn|7.0.3|MIT|
110+
|cross-spawn|7.0.5|MIT|
111111
|cucumber-console-formatter|1.0.0|ISC|
112112
|cucumber-tsflow|4.4.1|MIT|
113113
|date-format|4.0.14|MIT|

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,32 @@ Use the `actions/checkout@v4` action to clone the `release-documentation-action`
6363
|sourcePath|true|folder where the action retrieves the raw result files|
6464
|packagePath|true|target path where the results are copied to |
6565

66-
## Contributing
66+
# Contributing
6767

6868
For guidance on setting up a development environment and how to make a contribution to the Velocitas Release Documentation Action, see the [contributing guidelines](./CONTRIBUTING.md).
69+
70+
## Updating dependencies
71+
72+
Sometimes dependencies needs to be updated to address vulnerabilities.
73+
If the vulnerability is known by npm (and a fix is published) you can typically request npm to update all existing vulnerabilities:
74+
75+
```bash
76+
sudo npm audit fix
77+
```
78+
79+
If the vulnerability is not (yet) considered as a vulnerability by npm you can update it manually:
80+
81+
```bash
82+
sudo npm update cross-spawn
83+
```
84+
85+
After updating you should do some basic checks that the tool is still working:
86+
87+
```bash
88+
npm run build
89+
npm run package
90+
```
91+
92+
After updating dependencies the file `NOTICE-3RD-PARTY-CONTENT.md` needs to be updated.
93+
The easiest way to do this is to create a Pull Request (preferably as draft),
94+
then the "Check Licenses" workflow will fail but as output produce content that you can add to the Pull Request.

package-lock.json

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)