actions/dependency-review-action
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Apply suggestions for docs

Browse Source 
Co-authored-by: Federico Builes <[email protected]>
This commit is contained in:
Alexey Alekhin
2024-03-15 02:32:15 +01:00
committed by GitHub
co-authored by Federico Builes
parent 84b80e6e84
commit e38e634e54
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -4
View File
@@ -161,12 +161,12 @@ The Dependency Review GitHub Action check will only block a pull request from be
- `comment-content` is generated with the same content as would be present in a Dependency Review Action comment. - `comment-content` is generated with the same content as would be present in a Dependency Review Action comment.
- `dependency-changes` holds all dependency changes in a JSON format. The following outputs are subsets of `dependency-changes` filtered based on the configuration: - `dependency-changes` holds all dependency changes in a JSON format. The following outputs are subsets of `dependency-changes` filtered based on the configuration:
- `vulnerable-changes` holds information about dependency changes with vulnerable dependencies in a JSON format. - `vulnerable-changes` holds information about dependency changes with vulnerable dependencies in a JSON format.
- `invalid-license-changes` holds information about invalid or non-compliant license dependency changes in a JSON format. - `invalid-license-changes` holds information about invalid or non-compliant license dependency changes in a JSON format.
- `denied-changes` holds information about denied dependency changes in a JSON format. - `denied-changes` holds information about denied dependency changes in a JSON format.
> [!NOTE] > [!NOTE]
> Action outputs [have a size limit](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-docker-container-and-javascript-actions): outputs are Unicode strings, and can be a maximum of 1MB > Action outputs are unicode strings [with a 1MB size limit](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-docker-container-and-javascript-actions).
## Getting help ## Getting help
docs/examples.md
+2 -2
View File
@@ -166,8 +166,8 @@ jobs:
## Getting the results of the action in a later step ## Getting the results of the action in a later step
- Using the `comment-content` output you can get the results of the action in a workflow step. - `comment-content` contains the output of the results comment for the entire run.
- Using other outputs like `dependency-changes`, `vulnerable-changes`, `invalid-license-changes` and `denied-changes` you can get the results of the action in JSON format and use them in a programmatic way. `dependency-changes`, `vulnerable-changes`, `invalid-license-changes` and `denied-changes` are all JSON objects that allow you to access individual sets of changes.
```yaml ```yaml
name: 'Dependency Review' name: 'Dependency Review'