Skip to content

Commit

Permalink
Fixing vulnerability
Browse files Browse the repository at this point in the history
Also adding some documentation on how to do it
  • Loading branch information
erikbosch committed Nov 18, 2024
1 parent 22a8b1e commit 000abe5
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 4 deletions.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,32 @@ Use the `actions/checkout@v4` action to clone the `release-documentation-action`
|sourcePath|true|folder where the action retrieves the raw result files|
|packagePath|true|target path where the results are copied to |

## Contributing
# Contributing

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

## Updating dependencies

Sometimes dependencies needs to be updated to address vulnerabilities.
If the vulnerability is known by npm (and a fix is published) you can typically request npm to update all existing vulnerabilities:

```bash
sudo npm audit fix
```

If the vulnerability is not (yet) considered as a vulnerability by npm you can update it manually:

```bash
sudo npm update cross-spawn
```

After updating you should do some basic checks that the tool is still working:

```bash
npm run build
npm run package
```

After updating dependencies the file `NOTICE-3RD-PARTY-CONTENT.md` needs to be updated.
The easiest way to do this is to create a Pull Request (preferably as draft),
then the license check will fail but as output produce content that you can add to the Pull Request.
7 changes: 4 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 000abe5

Please sign in to comment.