Skip to content

Commit 951ab51

Browse files
authored
Move variable relating to Dependency Review outside the product.yml file (github#33443)
1 parent 954e13b commit 951ab51

File tree

10 files changed

+20
-19
lines changed

10 files changed

+20
-19
lines changed

content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Configuring dependency review for your appliance
33
shortTitle: Configuring dependency review
4-
intro: 'To helps users understand dependency changes when reviewing pull requests, you can enable, configure, and disable dependency review for {% data variables.location.product_location %}.'
4+
intro: 'To help users understand dependency changes when reviewing pull requests, you can enable, configure, and disable dependency review for {% data variables.location.product_location %}.'
55
product: '{% data reusables.gated-features.dependency-review %}'
66
miniTocMaxHeadingLevel: 3
77
versions:

content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ As a first step, you want to make a complete inventory of your dependencies. The
5353
{% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.5 %}
5454
### Automatic detection of vulnerabilities in pull requests
5555

56-
The {% data variables.product.prodname_dependency_review_action %} enforces a dependency review on your pull requests, making it easy for you to see if a pull request will introduce a vulnerable version of a dependency to your repository. When a vulnerability is detected, the {% data variables.product.prodname_dependency_review_action %} can block the pull request from merging. For more information, see "[Dependency review enforcement](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement)."{% endif %}
56+
The {% data variables.dependency-review.action_name %} enforces a dependency review on your pull requests, making it easy for you to see if a pull request will introduce a vulnerable version of a dependency to your repository. When a vulnerability is detected, the {% data variables.dependency-review.action_name %} can block the pull request from merging. For more information, see "[Dependency review enforcement](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement)."{% endif %}
5757

5858

5959
### Assessment of exposure to risk from a vulnerable dependency

content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ The action is available for all {% ifversion fpt or ghec %}public repositories,
5050

5151
{% data reusables.dependency-review.action-enterprise %}
5252

53-
You can use the {% data variables.product.prodname_dependency_review_action %} in your repository to enforce dependency reviews on your pull requests. The action scans for vulnerable versions of dependencies introduced by package version changes in pull requests, and warns you about the associated security vulnerabilities. This gives you better visibility of what's changing in a pull request, and helps prevent vulnerabilities being added to your repository. For more information, see [`dependency-review-action`](https://github.com/actions/dependency-review-action).
53+
You can use the {% data variables.dependency-review.action_name %} in your repository to enforce dependency reviews on your pull requests. The action scans for vulnerable versions of dependencies introduced by package version changes in pull requests, and warns you about the associated security vulnerabilities. This gives you better visibility of what's changing in a pull request, and helps prevent vulnerabilities being added to your repository. For more information, see [`dependency-review-action`](https://github.com/actions/dependency-review-action).
5454

5555
![Dependency review action example](/assets/images/help/graphs/dependency-review-action.png)
5656

57-
By default, the {% data variables.product.prodname_dependency_review_action %} check will fail if it discovers any vulnerable packages. A failed check blocks a pull request from being merged when the repository owner requires the dependency review check to pass. For more information, see "[About protected branches](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging)."
57+
By default, the {% data variables.dependency-review.action_name %} check will fail if it discovers any vulnerable packages. A failed check blocks a pull request from being merged when the repository owner requires the dependency review check to pass. For more information, see "[About protected branches](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-status-checks-before-merging)."
5858

5959
The action uses the Dependency Review REST API to get the diff of dependency changes between the base commit and head commit. You can use the Dependency Review API to get the diff of dependency changes, including vulnerability data, between any two commits on a repository. For more information, see "[Dependency review](/rest/reference/dependency-graph#dependency-review)."
6060

6161
{% ifversion dependency-review-action-configuration %}
62-
You can configure the {% data variables.product.prodname_dependency_review_action %} to better suit your needs. For example, you can specify the severity level that will make the action fail{% ifversion dependency-review-action-licenses %}, or set an allow or deny list for licenses to scan{% endif %}. For more information, see "[Configuring dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review#configuring-the-dependency-review-github-action)."
62+
You can configure the {% data variables.dependency-review.action_name %} to better suit your needs. For example, you can specify the severity level that will make the action fail{% ifversion dependency-review-action-licenses %}, or set an allow or deny list for licenses to scan{% endif %}. For more information, see "[Configuring dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review#configuring-the-dependency-review-github-action)."
6363
{% endif %}
6464

6565
{% endif %}

content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Dependency review is available when dependency graph is enabled for {% data vari
5151
{% endif %}
5252

5353
{% ifversion dependency-review-action-configuration %}
54-
## About configuring the {% data variables.product.prodname_dependency_review_action %}
54+
## About configuring the {% data variables.dependency-review.action_name %}
5555

5656
{% data reusables.dependency-review.dependency-review-action-overview %}
5757

@@ -77,14 +77,14 @@ The following configuration options are available.
7777
{% endtip %}
7878
{% endif %}
7979

80-
## Configuring the {% data variables.product.prodname_dependency_review_action %}
80+
## Configuring the {% data variables.dependency-review.action_name %}
8181

82-
There are two methods of configuring the {% data variables.product.prodname_dependency_review_action %}:
82+
There are two methods of configuring the {% data variables.dependency-review.action_name %}:
8383
- Inlining the configuration options in your workflow file.
8484
- Referencing a configuration file in your workflow file.
8585

8686
Notice that all of the examples use a short version number for the action (`v3`) instead of a semver release number (for example, `v3.0.8`). This ensures that you use the most recent minor version of the action.
87-
### Using inline configuration to set up the {% data variables.product.prodname_dependency_review_action %}
87+
### Using inline configuration to set up the {% data variables.dependency-review.action_name %}
8888

8989
1. Add a new YAML workflow to your `.github/workflows` folder.
9090

@@ -108,7 +108,7 @@ Notice that all of the examples use a short version number for the action (`v3`)
108108
```
109109
1. Specify your settings.
110110

111-
This {% data variables.product.prodname_dependency_review_action %} example file illustrates how you can use the available configuration options.
111+
This {% data variables.dependency-review.action_name %} example file illustrates how you can use the available configuration options.
112112
```yaml{:copy}
113113
name: 'Dependency Review'
114114
on: [pull_request]
@@ -146,7 +146,7 @@ Notice that all of the examples use a short version number for the action (`v3`)
146146
fail-on-scopes: development, runtime
147147
{% endif %}
148148
```
149-
### Using a configuration file to set up {% data variables.product.prodname_dependency_review_action %}
149+
### Using a configuration file to set up {% data variables.dependency-review.action_name %}
150150

151151
1. Add a new YAML workflow to your `.github/workflows` folder and use `config-file` to specify that you are using a configuration file.
152152

content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-dependency-changes-in-a-pull-request.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ Dependency review allows you to "shift left". You can use the provided predictiv
3434

3535
{% ifversion fpt or ghec or ghes > 3.5 or ghae > 3.5 %}
3636

37-
You can use the {% data variables.product.prodname_dependency_review_action %} to help enforce dependency reviews on pull requests in your repository. {% data reusables.dependency-review.dependency-review-action-overview %}
37+
You can use the {% data variables.dependency-review.action_name %} to help enforce dependency reviews on pull requests in your repository. {% data reusables.dependency-review.dependency-review-action-overview %}
3838

3939
{% ifversion dependency-review-action-configuration %}
40-
You can configure the {% data variables.product.prodname_dependency_review_action %} to better suit your needs by specifying the type of dependency vulnerability you wish to catch. For more information, see "[Configuring dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review#configuring-the-dependency-review-github-action)."
40+
You can configure the {% data variables.dependency-review.action_name %} to better suit your needs by specifying the type of dependency vulnerability you wish to catch. For more information, see "[Configuring dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review#configuring-the-dependency-review-github-action)."
4141
{% endif %}
4242

4343
{% endif %}
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{% ifversion ghes or ghae %}
2-
Enterprise owners and people with admin access to a repository can add the {% data variables.product.prodname_dependency_review_action %} to their enterprise and repository, respectively.
2+
Enterprise owners and people with admin access to a repository can add the {% data variables.dependency-review.action_name %} to their enterprise and repository, respectively.
33
{% endif %}
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% note %}
22

3-
**Note**: The {% data variables.product.prodname_dependency_review_action %} is currently in public beta and subject to change.
3+
**Note**: The {% data variables.dependency-review.action_name %} is currently in public beta and subject to change.
44

55
{% endnote %}
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
The {% data variables.product.prodname_dependency_review_action %} scans your pull requests for dependency changes and raises an error if any new dependencies have known vulnerabilities. The action is supported by an API endpoint that compares the dependencies between two revisions and reports any differences.
1+
The {% data variables.dependency-review.action_name %} scans your pull requests for dependency changes and raises an error if any new dependencies have known vulnerabilities. The action is supported by an API endpoint that compares the dependencies between two revisions and reports any differences.
22

33
For more information about the action and the API endpoint, see the [`dependency-review-action`](https://github.com/actions/dependency-review-action) documentation, and "[Dependency review](/rest/dependency-graph/dependency-review)" in the API documentation.

data/variables/dependency-review.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Variables used in the dependency review docs that are not product names
2+
3+
# Dependency review action
4+
action_name: 'dependency review action'

data/variables/product.yml

-3
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,6 @@ prodname_dependabot_security_updates: 'Dependabot security updates'
213213
prodname_dependabot_version_updates: 'Dependabot version updates'
214214
prodname_dependabot_updates: 'Dependabot updates'
215215

216-
# Dependency review action
217-
prodname_dependency_review_action: 'dependency review action'
218-
219216
# GitHub Archive Program
220217
prodname_archive: 'GitHub Archive Program'
221218
prodname_arctic_vault: 'Arctic Code Vault'

0 commit comments

Comments
 (0)