diff --git a/README.md b/README.md index d25f8c5..e48a22b 100644 --- a/README.md +++ b/README.md @@ -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. - `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. - - `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. +- `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. +- `denied-changes` holds information about denied dependency changes in a JSON format. > [!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 diff --git a/docs/examples.md b/docs/examples.md index ce1a1cf..183bc9c 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -166,8 +166,8 @@ jobs: ## 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. -- 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. +- `comment-content` contains the output of the results comment for the entire run. +`dependency-changes`, `vulnerable-changes`, `invalid-license-changes` and `denied-changes` are all JSON objects that allow you to access individual sets of changes. ```yaml name: 'Dependency Review'