Skip to content

Commit

Permalink
Merge pull request #33715 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Jun 26, 2024
2 parents e071bda + 1d2ce30 commit b3c4255
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,12 @@ In all views, there are two methods for filtering results by repository name.
You can also filter by repository visibility (internal, private, or public) and archive status.

| Qualifier | Description | Views |
|--------|--------|------|{% ifversion security-overview-dashboard %}
| `visibility` | Display data for all repositories that are `public`, `private`, or `internal`. | "Overview" and metrics{% endif %}
| `is` | Display data for all repositories that are `public`, `private`, or `internal`. | "Risk" and "Coverage"
| `archived` | Display only data for archived (`true`) or active (`false`) repositories. | All except "Alerts" views
|--------|--------|------|
| {% ifversion security-overview-dashboard %} |
| `visibility` | Display data for all repositories that are `public`, `private`, or `internal`. | "Overview" and metrics |
| {% endif %} |
| `is` | Display data for all repositories that are `public`, `private`, or `internal`. | "Risk" and "Coverage" |
| `archived` | Display only data for archived (`true`) or active (`false`) repositories. | All except "Alerts" views |

## Team and topic filters

Expand Down Expand Up @@ -96,9 +98,9 @@ In enterprise-level views, you can limit the data to repositories owned by a sin

| Qualifier | Description | Views |
| -------- | -------- | ------ |
| `owner` | Display data for all repositories owned by one account owner. | Most views
| `owner-type` | Display data for all repositories owned by an organization or a user account in your enterprise. | "Risk", "Coverage" and {% data variables.secret-scanning.alerts %}
| `org` | Display data for repositories owned by one organization. | {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_code_scanning %} alerts
| `owner` | Display data for all repositories owned by one account owner. | Most views |
| `owner-type` | Display data for all repositories owned by an organization or a user account in your enterprise. | "Risk", "Coverage" and {% data variables.secret-scanning.alerts %} |
| `org` | Display data for repositories owned by one organization. | {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_code_scanning %} alerts |

{% elsif security-overview-org-risk-coverage-enterprise %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ Dependency review is available when dependency graph is enabled for {% data vari

{% endif %}

{% ifversion dependency-review-action-configuration %}

## About configuring the {% data variables.dependency-review.action_name %}

{% data reusables.dependency-review.dependency-review-action-overview %}
Expand All @@ -58,11 +56,13 @@ Here is a list of common configuration options. For more information, and a ful
| Option | Required | Usage |
|------------------|-------------------------------|--------|
| `fail-on-severity` | {% octicon "x" aria-label="Optional" %} | Defines the threshold for level of severity (`low`, `moderate`, `high`, `critical`).</br>The action will fail on any pull requests that introduce vulnerabilities of the specified severity level or higher. |
{%- ifversion dependency-review-action-licenses %}
| `allow-licenses` | {% octicon "x" aria-label="Optional" %} | Contains a list of allowed licenses. You can find the possible values for this parameter in the [Licenses](/rest/licenses) page of the API documentation.</br>The action will fail on pull requests that introduce dependencies with licenses that do not match the list.|{% endif %}
{%- ifversion dependency-review-action-licenses %}
| `deny-licenses` | {% octicon "x" aria-label="Optional" %} | Contains a list of prohibited licenses. You can find the possible values for this parameter in the [Licenses](/rest/licenses) page of the API documentation.</br>The action will fail on pull requests that introduce dependencies with licenses that match the list.|{% endif %}{% ifversion dependency-review-action-fail-on-scopes %}
| `fail-on-scopes` | {% octicon "x" aria-label="Optional" %} | Contains a list of strings representing the build environments you want to support (`development`, `runtime`, `unknown`). </br>The action will fail on pull requests that introduce vulnerabilities in the scopes that match the list.|{% endif %}
| {% ifversion dependency-review-action-licenses %} |
| `allow-licenses` | {% octicon "x" aria-label="Optional" %} | Contains a list of allowed licenses. You can find the possible values for this parameter in the [Licenses](/rest/licenses) page of the API documentation.</br>The action will fail on pull requests that introduce dependencies with licenses that do not match the list.|
| {% endif %} |
| {% ifversion dependency-review-action-licenses %} |
| `deny-licenses` | {% octicon "x" aria-label="Optional" %} | Contains a list of prohibited licenses. You can find the possible values for this parameter in the [Licenses](/rest/licenses) page of the API documentation.</br>The action will fail on pull requests that introduce dependencies with licenses that match the list.|
| {% endif %} |
| `fail-on-scopes` | {% octicon "x" aria-label="Optional" %} | Contains a list of strings representing the build environments you want to support (`development`, `runtime`, `unknown`). </br>The action will fail on pull requests that introduce vulnerabilities in the scopes that match the list.|
| `comment-summary-in-pr` | {% octicon "x" aria-label="Optional" %} | Enable or disable the reporting of the review summary as a comment in the pull request. If enabled, you must give the workflow or job the `pull-requests: write` permission. |
| `allow-ghsas` | {% octicon "x" aria-label="Optional" %} | Contains a list of {% data variables.product.prodname_advisory_database %} IDs that can be skipped during detection. You can find the possible values for this parameter in the [{% data variables.product.prodname_advisory_database %}](https://github.com/advisories). |
| `config-file` | {% octicon "x" aria-label="Optional" %} | Specifies a path to a configuration file. The configuration file can be local to the repository or a file located in an external repository.|
Expand All @@ -74,7 +74,6 @@ Here is a list of common configuration options. For more information, and a ful
**Tip:** The `allow-licenses` and `deny-licenses` options are mutually exclusive.

{% endtip %}
{% endif %}

## Configuring the {% data variables.dependency-review.action_name %}

Expand Down Expand Up @@ -144,11 +143,9 @@ Notice that all of the examples use a short version number for the action (`v3`)
# ([String]). Skip these {% data variables.product.prodname_advisory_database %} IDs during detection (optional)
# Possible values: Any valid {% data variables.product.prodname_advisory_database %} ID from https://github.com/advisories
allow-ghsas: GHSA-abcd-1234-5679, GHSA-efgh-1234-5679
{% ifversion dependency-review-action-fail-on-scopes %}
# ([String]). Block pull requests that introduce vulnerabilities in the scopes that match this list (optional)
# Possible values: "development", "runtime", "unknown"
fail-on-scopes: development, runtime
{% endif %}
```
<!-- markdownlint-enable search-replace -->
Expand Down Expand Up @@ -214,13 +211,11 @@ Notice that all of the examples use a short version number for the action (`v3`)
allow-ghsas:
- GHSA-abcd-1234-5679
- GHSA-efgh-1234-5679
{% ifversion dependency-review-action-fail-on-scopes %}
# ([String]). Block pull requests that introduce vulnerabilities in the scopes that match this list (optional)
# Possible values: "development", "runtime", "unknown"
fail-on-scopes:
- development
- runtime
{% endif %}
```
<!-- markdownlint-enable search-replace -->
Expand Down
91 changes: 83 additions & 8 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@
"@types/semver": "^7.5.8",
"@types/tcp-port-used": "1.0.4",
"@typescript-eslint/eslint-plugin": "^7.13.0",
"@typescript-eslint/parser": "^7.13.0",
"@typescript-eslint/parser": "^7.14.1",
"chalk": "^5.0.1",
"change-case": "^5.4.4",
"commander": "^12.1.0",
Expand Down

0 comments on commit b3c4255

Please sign in to comment.