Skip to content

Commit a56a8b6

Browse files
authored
Testing and fixing dash list style (#42493)
1 parent 803157a commit a56a8b6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

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

+9-9
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,17 @@ The best practices you should take will depend on whether you use {% data variab
8585
### Using GitHub Actions to access the dependency submission API and the dependency review API
8686

8787
If you use {% data variables.product.prodname_actions %} to access the dependency submission API or the dependency review API:
88-
* Make sure you run all of your dependency submission actions in the same {% data variables.product.prodname_actions %} workflow as your {% data variables.dependency-review.action_name %}. This will give you control over the order of execution, and it will ensure that dependency review will always work.
89-
* If you do choose to run the {% data variables.dependency-review.action_name %} separately, for instance, as a required workflow, you should:
90-
+ Set `retry-on-snapshot-warnings` to `true`.
91-
+ Set `retry-on-snapshot-warnings-timeout` to slightly exceed the typical run time (in seconds) of your longest-running dependency submission action.
88+
- Make sure you run all of your dependency submission actions in the same {% data variables.product.prodname_actions %} workflow as your {% data variables.dependency-review.action_name %}. This will give you control over the order of execution, and it will ensure that dependency review will always work.
89+
- If you do choose to run the {% data variables.dependency-review.action_name %} separately, for instance, as a required workflow, you should:
90+
- Set `retry-on-snapshot-warnings` to `true`.
91+
- Set `retry-on-snapshot-warnings-timeout` to slightly exceed the typical run time (in seconds) of your longest-running dependency submission action.
9292

9393
### Using direct API access to the dependency submission API and the dependency review API
9494

9595
If you don’t use {% data variables.product.prodname_actions %}, and your code relies on direct access to the dependency submission API and the dependency review API:
96-
* Make sure you run the code that calls the dependency submission API first, and then run the code that calls the dependency review API afterwards.
97-
* If you do choose to run the code for the dependency submission API and the dependency review API in parallel, you should implement a retry logic and note the following:
98-
+ When there are snapshots missing for either side of the comparison, you will see an explanation for that in the `x-github-dependency-graph-snapshot-warnings` header (as a base64-encoded string). Therefore, if the header is non-empty, you should consider retrying.
99-
+ Implement a retry logic with exponential backoff retries.
100-
+ Implement a reasonable number of retries to account for the typical runtime of your dependency submission code.
96+
- Make sure you run the code that calls the dependency submission API first, and then run the code that calls the dependency review API afterwards.
97+
- If you do choose to run the code for the dependency submission API and the dependency review API in parallel, you should implement a retry logic and note the following:
98+
- When there are snapshots missing for either side of the comparison, you will see an explanation for that in the `x-github-dependency-graph-snapshot-warnings` header (as a base64-encoded string). Therefore, if the header is non-empty, you should consider retrying.
99+
- Implement a retry logic with exponential backoff retries.
100+
- Implement a reasonable number of retries to account for the typical runtime of your dependency submission code.
101101
{% endif %}

0 commit comments

Comments
 (0)