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

Adding README and action.yml for external config files.

Browse Source
This commit is contained in:
Federico Builes
2022-10-21 17:34:20 +02:00
parent 80e573b784
commit 74c047086c
2 changed files with 29 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+26 -5
View File
@@ -71,13 +71,22 @@ or by inlining these options in your workflow file.
### config-file ### config-file
A string representing the path to an external configuraton file. By A string representing the path to a configuraton file. The
default external configuration files are not used. configuration file can be local to the repo, or can be a file in an
external repo. If you are referencing a configuration file located in an
external repository, you can use the
`OWNER/REPOSITORY/FILENAME@BRANCH` syntax.
**Possible values**: A string representing the absolute path to the If the configuration file is located in an external private
configuration file. repository, use the [external-repository-token](#external-repository-token) parameter of the
action to specify a token that has read access to the repository.
**Possible values**: A string representing an absolute path to a file,
or a file located in another repository:
**Example**: `config-file: ./.github/dependency-review-config.yml # local file`.
**Example**: `config-file: github/octorepo/dependency-review-config.yml@main # external repo`
**Example**: `config-file: ./.github/dependency-review-config.yml`.
### fail-on-severity ### fail-on-severity
@@ -171,6 +180,18 @@ base-ref: 8bb8a58d6a4028b6c2e314d5caaf273f57644896
head-ref: 69af5638bf660cf218aad5709a4c100e42a2f37b head-ref: 69af5638bf660cf218aad5709a4c100e42a2f37b
``` ```
### external-repository-token
A token for fetching external configuration files if they live in
another repository.
# TODO Add a guide on how to get the token
**Possible values**: Any GitHub token with read access to the external repository.
**Example**: `external-repository-token: ghp_123456789abcdef...`
### Configuration File ### Configuration File
You can use an external configuration file to specify the settings for You can use an external configuration file to specify the settings for
action.yml
+3
View File
@@ -32,6 +32,9 @@ inputs:
allow-ghsas: allow-ghsas:
description: Comma-separated list of allowed Github Advisory IDs (e.g. "GHSA-abcd-1234-5679, GHSA-efgh-1234-5679") description: Comma-separated list of allowed Github Advisory IDs (e.g. "GHSA-abcd-1234-5679, GHSA-efgh-1234-5679")
required: false required: false
external-repository-token:
description: A token for fetching external configuration files if they live in another repository.
required: false
runs: runs:
using: 'node16' using: 'node16'
main: 'dist/index.js' main: 'dist/index.js'