Version 4.7.0 release
Also add a note about the new `LicenseRef-clearlydefined-OTHER` to the README.
This commit is contained in:
@@ -15,6 +15,7 @@ The dependency review action scans your pull requests for dependency changes, an
|
|||||||
The action is supported by an [API endpoint](https://docs.github.com/en/rest/dependency-graph/dependency-review?apiVersion=2022-11-28) that diffs the dependencies between any two revisions on your default branch.
|
The action is supported by an [API endpoint](https://docs.github.com/en/rest/dependency-graph/dependency-review?apiVersion=2022-11-28) that diffs the dependencies between any two revisions on your default branch.
|
||||||
|
|
||||||
The action is available for:
|
The action is available for:
|
||||||
|
|
||||||
- Public repositories
|
- Public repositories
|
||||||
- Private repositories with a [GitHub Advanced Security](https://docs.github.com/en/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security) license.
|
- Private repositories with a [GitHub Advanced Security](https://docs.github.com/en/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security) license.
|
||||||
|
|
||||||
@@ -23,6 +24,7 @@ The action is available for:
|
|||||||
When the action runs, you can see the results on:
|
When the action runs, you can see the results on:
|
||||||
|
|
||||||
- The **job logs** page.
|
- The **job logs** page.
|
||||||
|
|
||||||
1. Go to the **Actions** tab for the repository and select the relevant workflow run.
|
1. Go to the **Actions** tab for the repository and select the relevant workflow run.
|
||||||
1. Then under "Jobs", click **dependency review**.
|
1. Then under "Jobs", click **dependency review**.
|
||||||
|
|
||||||
@@ -86,7 +88,8 @@ You can install the action on repositories on GitHub Enterprise Server.
|
|||||||
- name: 'Dependency Review'
|
- name: 'Dependency Review'
|
||||||
uses: actions/dependency-review-action@v4
|
uses: actions/dependency-review-action@v4
|
||||||
```
|
```
|
||||||
5. In the workflow file, replace the `runs-on` value with the label of any of your runners. (The default value is `self-hosted`.)
|
|
||||||
|
4. In the workflow file, replace the `runs-on` value with the label of any of your runners. (The default value is `self-hosted`.)
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
@@ -100,7 +103,7 @@ There are various configuration options you can use to specify settings for the
|
|||||||
All configuration options are optional.
|
All configuration options are optional.
|
||||||
|
|
||||||
| Option | Usage | Possible values | Default value |
|
| Option | Usage | Possible values | Default value |
|
||||||
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------- |
|
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------- |
|
||||||
| `fail-on-severity` | Defines the threshold for the level of severity. The action will fail on any pull requests that introduce vulnerabilities of the specified severity level or higher. | `low`, `moderate`, `high`, `critical` | `low` |
|
| `fail-on-severity` | Defines the threshold for the level of severity. The action will fail on any pull requests that introduce vulnerabilities of the specified severity level or higher. | `low`, `moderate`, `high`, `critical` | `low` |
|
||||||
| `allow-licenses`\* | Contains a list of allowed licenses. The action will fail on pull requests that introduce dependencies with licenses that do not match the list. | Any [SPDX-compliant identifier(s)](https://spdx.org/licenses/) | none |
|
| `allow-licenses`\* | Contains a list of allowed licenses. The action will fail on pull requests that introduce dependencies with licenses that do not match the list. | Any [SPDX-compliant identifier(s)](https://spdx.org/licenses/) | none |
|
||||||
| `deny-licenses`\* | Contains a list of prohibited licenses. The action will fail on pull requests that introduce dependencies with licenses that match the list. | Any [SPDX-compliant identifier(s)](https://spdx.org/licenses/) | none |
|
| `deny-licenses`\* | Contains a list of prohibited licenses. The action will fail on pull requests that introduce dependencies with licenses that match the list. | Any [SPDX-compliant identifier(s)](https://spdx.org/licenses/) | none |
|
||||||
@@ -120,6 +123,7 @@ All configuration options are optional.
|
|||||||
| `warn-on-openssf-scorecard-level` | When `show-openssf-scorecard-levels` is set to `true`, this option lets you configure the threshold for when a score is considered too low and gets a :warning: warning in the CI. | Any positive integer | 3 |
|
| `warn-on-openssf-scorecard-level` | When `show-openssf-scorecard-levels` is set to `true`, this option lets you configure the threshold for when a score is considered too low and gets a :warning: warning in the CI. | Any positive integer | 3 |
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
|
>
|
||||||
> - \* Not supported for use with GitHub Enterprise Server. (Checking for licenses is not supported on GitHub Enterprise Server because the API does not return license information.)
|
> - \* Not supported for use with GitHub Enterprise Server. (Checking for licenses is not supported on GitHub Enterprise Server because the API does not return license information.)
|
||||||
> - \+ When `warn-only` is set to `true`, all vulnerabilities, independently of the severity, will be reported as warnings and the action will not fail.
|
> - \+ When `warn-only` is set to `true`, all vulnerabilities, independently of the severity, will be reported as warnings and the action will not fail.
|
||||||
> - The `allow-licenses` and `deny-licenses` options are mutually exclusive; an error will be raised if you provide both.
|
> - The `allow-licenses` and `deny-licenses` options are mutually exclusive; an error will be raised if you provide both.
|
||||||
@@ -128,6 +132,7 @@ All configuration options are optional.
|
|||||||
### Configuration methods
|
### Configuration methods
|
||||||
|
|
||||||
To specify settings for the dependency review action, you can choose from two options:
|
To specify settings for the dependency review action, you can choose from two options:
|
||||||
|
|
||||||
- [Option 1: Inline the configuration options]() in your workflow file.
|
- [Option 1: Inline the configuration options]() in your workflow file.
|
||||||
- [Option 2: Reference an external configuration file]() in your workflow file.
|
- [Option 2: Reference an external configuration file]() in your workflow file.
|
||||||
|
|
||||||
@@ -136,6 +141,7 @@ To specify settings for the dependency review action, you can choose from two op
|
|||||||
You can pass configuration options to the dependency review action using your workflow file.
|
You can pass configuration options to the dependency review action using your workflow file.
|
||||||
|
|
||||||
1. In the same YAML workflow file you created during installation, use the `with:` key to specify your chosen settings:
|
1. In the same YAML workflow file you created during installation, use the `with:` key to specify your chosen settings:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
name: 'Dependency Review'
|
name: 'Dependency Review'
|
||||||
on: [pull_request]
|
on: [pull_request]
|
||||||
@@ -178,9 +184,11 @@ You can use an external configuration file to specify settings for this action.
|
|||||||
with:
|
with:
|
||||||
config-file: './.github/dependency-review-config.yml'
|
config-file: './.github/dependency-review-config.yml'
|
||||||
```
|
```
|
||||||
|
|
||||||
| Option | Usage | Possible values |
|
| Option | Usage | Possible values |
|
||||||
|--------------------- | ----------- | ----------------------------- |
|
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `config-file` | A path to a file in the current repository or an external repository. Use this syntax for external files: `OWNER/REPOSITORY/FILENAME@BRANCH` | **Local file**: `./.github/dependency-review-config.yml` <br> **External repo**: `github/octorepo/dependency-review-config.yml@main` |
|
| `config-file` | A path to a file in the current repository or an external repository. Use this syntax for external files: `OWNER/REPOSITORY/FILENAME@BRANCH` | **Local file**: `./.github/dependency-review-config.yml` <br> **External repo**: `github/octorepo/dependency-review-config.yml@main` |
|
||||||
|
|
||||||
2. Optionally, if the file resides in a private external repository, and for all GitHub Enterprise Server repositories, use `external-repo-token` to specify a token for fetching the file.
|
2. Optionally, if the file resides in a private external repository, and for all GitHub Enterprise Server repositories, use `external-repo-token` to specify a token for fetching the file.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@@ -192,8 +200,9 @@ You can use an external configuration file to specify settings for this action.
|
|||||||
```
|
```
|
||||||
|
|
||||||
| Option | Usage | Possible values |
|
| Option | Usage | Possible values |
|
||||||
|--------------------- | ----------- | ----------------------------- |
|
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||||
| `external-repo-token` | Specifies a token for fetching the configuration file. It is required if the file resides in a private external repository and for all GitHub Enterprise Server repositories. Create a token in [developer settings](https://github.com/settings/tokens). | Any token with `read` permissions to the repository hosting the config file. |
|
| `external-repo-token` | Specifies a token for fetching the configuration file. It is required if the file resides in a private external repository and for all GitHub Enterprise Server repositories. Create a token in [developer settings](https://github.com/settings/tokens). | Any token with `read` permissions to the repository hosting the config file. |
|
||||||
|
|
||||||
3. Create the configuration file in the path you specified for `config-file`.
|
3. Create the configuration file in the path you specified for `config-file`.
|
||||||
4. In the configuration file, specify your chosen settings.
|
4. In the configuration file, specify your chosen settings.
|
||||||
```yaml
|
```yaml
|
||||||
@@ -207,6 +216,14 @@ You can use an external configuration file to specify settings for this action.
|
|||||||
> For external configuration files, the option names use underscores instead of dashes.
|
> For external configuration files, the option names use underscores instead of dashes.
|
||||||
> Example: `fail_on_severity`
|
> Example: `fail_on_severity`
|
||||||
|
|
||||||
|
#### `OTHER` in license strings
|
||||||
|
|
||||||
|
License data comes from [ClearlyDefined](https://clearlydefined.io) and you may sometimes see licenses displayed with the string `OTHER` in them. ClearlyDefined [defines OTHER](https://docs.clearlydefined.io/docs/curation/curation-guidelines) as:
|
||||||
|
|
||||||
|
> This indicates that a human confirmed that there is license information in the file but that the license is not an SPDX-identified license.
|
||||||
|
|
||||||
|
`OTHER` is not a valid [SPDX license identifier](https://spdx.org/licenses/), so we convert `OTHER` in a license string into `LicenseRef-clearlydefined-OTHER`, which _is_ valid in SPDX. If you want to add that to the deny or allow list, be sure to add `LicenseRef-clearlydefined-OTHER` to this list, because that is what we'll actually be comparing.
|
||||||
|
|
||||||
#### Further information
|
#### Further information
|
||||||
|
|
||||||
- For more examples of how to use this action and its configuration options, see the [examples](docs/examples.md) page.
|
- For more examples of how to use this action and its configuration options, see the [examples](docs/examples.md) page.
|
||||||
|
|||||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "dependency-review-action",
|
"name": "dependency-review-action",
|
||||||
"version": "4.6.0",
|
"version": "4.7.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "dependency-review-action",
|
"name": "dependency-review-action",
|
||||||
"version": "4.6.0",
|
"version": "4.7.0",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^1.10.1",
|
"@actions/core": "^1.10.1",
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "dependency-review-action",
|
"name": "dependency-review-action",
|
||||||
"version": "4.6.0",
|
"version": "4.7.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"description": "A GitHub Action for Dependency Review",
|
"description": "A GitHub Action for Dependency Review",
|
||||||
"main": "lib/main.js",
|
"main": "lib/main.js",
|
||||||
|
|||||||
Reference in New Issue
Block a user