Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 286327d

Browse files
docs-botdocs-bot
authored
Merge pull request #53259 from github/repo-sync
Repo sync
2 parents 46cd4cc + 465b512 commit 286327d

98 files changed

Lines changed: 230 additions & 229 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ When creating a query suite, you first need to specify the locations of the
3838
queries that you want to select. You can define the location of one or more
3939
queries using:
4040

41-
* A `query` instruction—tells {% data variables.product.prodname_codeql %} to look for one or more specified `.ql`
41+
* A `query` instruction: Tells {% data variables.product.prodname_codeql %} to look for one or more specified `.ql`
4242
files:
4343

4444
```yaml
@@ -48,7 +48,7 @@ files:
4848
The argument must be one or more file paths, relative to the {% data variables.product.prodname_codeql %} pack containing
4949
the suite definition.
5050
51-
* A `queries` instruction—tells {% data variables.product.prodname_codeql %} to recursively scan a directory
51+
* A `queries` instruction: Tells {% data variables.product.prodname_codeql %} to recursively scan a directory
5252
for `.ql` files:
5353

5454
```yaml
@@ -68,7 +68,7 @@ for `.ql` files:
6868
The `version` field is optional and specifies a range of compatible versions of this {% data variables.product.prodname_codeql %} pack.
6969
If you don’t specify a version, then the most recent version of the pack is used.
7070

71-
* A `qlpack` instruction—tells {% data variables.product.prodname_codeql %} to resolve queries in the default suite of the
71+
* A `qlpack` instruction: Tells {% data variables.product.prodname_codeql %} to resolve queries in the default suite of the
7272
named {% data variables.product.prodname_codeql %} pack:
7373

7474
```yaml
@@ -136,12 +136,12 @@ For more information about query metadata properties, see
136136

137137
In addition to metadata tags, the keys in the constraint block can also be:
138138

139-
* `query filename`—matches on the last path component of the query file name.
140-
* `query path`—matches on the path to the query file relative to its
139+
* `query filename`: Matches on the last path component of the query file name.
140+
* `query path`: Matches on the path to the query file relative to its
141141
enclosing {% data variables.product.prodname_codeql %} pack.
142-
* `tags contain`—one of the given match strings must match
142+
* `tags contain`: One of the given match strings must match
143143
one of the space-separated components of the value of the `@tags` metadata property.
144-
* `tags contain all`—each of the given match strings must match one of the
144+
* `tags contain all`: Each of the given match strings must match one of the
145145
components of the `@tags` metadata property.
146146

147147
### Examples of filtering which queries are run
@@ -245,7 +245,7 @@ use:
245245

246246
Existing query suite definitions can be reused by specifying:
247247

248-
* An `import` instruction—adds the queries selected by a
248+
* An `import` instruction: Adds the queries selected by a
249249
previously defined `.qls` file to the current suite:
250250

251251
```yaml
@@ -268,7 +268,7 @@ previously defined `.qls` file to the current suite:
268268
Queries added using an `import` instruction can be filtered using subsequent
269269
`exclude` instructions.
270270

271-
* An `apply` instruction—adds all of the instructions from a
271+
* An `apply` instruction: Adds all of the instructions from a
272272
previously defined `.qls` file to the current suite. The instructions in the
273273
applied `.qls` file are executed as if they appear in place of `apply`.
274274
Any `include` and `exclude` instructions from the applied suite also act on

‎content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,11 +278,11 @@ updates:
278278

279279
Use the `allow` option to customize which dependencies are updated. This applies to both version and security updates. You can use the following options:
280280

281-
* `dependency-name`—use to allow updates for dependencies with matching names, optionally using `*` to match zero or more characters.
281+
* `dependency-name`: Use to allow updates for dependencies with matching names, optionally using `*` to match zero or more characters.
282282
* For Java dependencies, the format of the `dependency-name` attribute is: `groupId:artifactId`; for example: `org.kohsuke:github-api`.
283283
* For Docker image tags, the format is the full name of the repository; for example, for an image tag of `<account ID>.dkr.ecr.us-west-2.amazonaws.com/base/foo/bar/ruby:3.1.0-focal-jemalloc`, use `base/foo/bar/ruby`.
284284

285-
* `dependency-type`—use to allow updates for dependencies of specific types.
285+
* `dependency-type`: Use to allow updates for dependencies of specific types.
286286

287287
| Dependency types | Supported by package managers | Allow updates |
288288
|------------------|-------------------------------|--------|

‎content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,8 @@ If you continue to see CI failures, you should remove the group configuration so
256256

257257
If you unblock {% data variables.product.prodname_dependabot %}, you can manually trigger a fresh attempt to create a pull request.
258258

259-
* **Security updates**—display the {% data variables.product.prodname_dependabot %} alert that shows the error you have fixed and click **Create {% data variables.product.prodname_dependabot %} security update**.
260-
* **Version updates**—on the **Insights** tab for the repository click **Dependency graph**, and then click the **Dependabot** tab. Click **Last checked _TIME_ ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. Click **Check for updates**.
259+
* **Security updates**: Display the {% data variables.product.prodname_dependabot %} alert that shows the error you have fixed and click **Create {% data variables.product.prodname_dependabot %} security update**.
260+
* **Version updates**: On the **Insights** tab for the repository click **Dependency graph**, and then click the **Dependabot** tab. Click **Last checked _TIME_ ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. Click **Check for updates**.
261261

262262
## Further reading
263263

‎content/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ No matter how well you tighten your organization to prevent data leaks, some may
7272
{% ifversion fpt or ghec %}
7373
There are two forms of {% data variables.product.prodname_secret_scanning %} available: **{% data variables.secret-scanning.partner_alerts_caps %}** and **{% data variables.secret-scanning.user_alerts_caps %}**.
7474

75-
* {% data variables.secret-scanning.partner_alerts_caps %}—These are enabled by default and automatically run on all public repositories and public npm packages.
76-
* {% data variables.secret-scanning.user_alerts_caps %}—To get additional scanning capabilities for your organization, you need to enable {% data variables.secret-scanning.user_alerts %}.
75+
* {% data variables.secret-scanning.partner_alerts_caps %}: These are enabled by default and automatically run on all public repositories and public npm packages.
76+
* {% data variables.secret-scanning.user_alerts_caps %}: To get additional scanning capabilities for your organization, you need to enable {% data variables.secret-scanning.user_alerts %}.
7777

7878
When enabled, {% data variables.secret-scanning.user_alerts %} can be detected on the following types of repository:{% ifversion fpt %}
7979
* Public repositories owned by personal accounts on {% data variables.product.prodname_dotcom_the_website %}

‎content/code-security/getting-started/dependabot-quickstart-guide.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ If {% data variables.product.prodname_dependabot_alerts %} are enabled for a rep
7676

7777
1. Optionally, you can also explore the information on the right-side of the page. Some of the information shown in the screenshot may not apply to every alert.
7878
* Severity
79-
* CVSS metrics—we use CVSS levels to assign severity levels. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database#about-cvss-levels)."
79+
* CVSS metrics: We use CVSS levels to assign severity levels. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database#about-cvss-levels)."
8080
* Tags
81-
* Weaknesses—list of CWEs related to the vulnerability, if applicable
82-
* CVE ID—unique CVE identifier for the vulnerability, if applicable
83-
* GHSA ID—unique identifier of the corresponding advisory on the {% data variables.product.prodname_advisory_database %}. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database#about-ghsa-ids)."
81+
* Weaknesses: List of CWEs related to the vulnerability, if applicable
82+
* CVE ID: Unique CVE identifier for the vulnerability, if applicable
83+
* GHSA ID: Unique identifier of the corresponding advisory on the {% data variables.product.prodname_advisory_database %}. For more information, see "[AUTOTITLE](/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database#about-ghsa-ids)."
8484
* Option to navigate to the advisory on the {% data variables.product.prodname_advisory_database %}
8585
* Option to see all of your repositories that are affected by this vulnerability
8686
* Option to suggest improvements for this advisory on the {% data variables.product.prodname_advisory_database %}

‎content/code-security/secret-scanning/introduction/about-secret-scanning.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,27 +68,27 @@ Below is a typical workflow that explains how {% data variables.product.prodname
6868

6969
## About the benefits of {% data variables.product.prodname_secret_scanning %}
7070

71-
* **Enhanced security**—{% data variables.product.prodname_secret_scanning_caps %} scans your repositories for sensitive information like API keys, passwords, tokens, and other secrets. By detecting these early, you can mitigate potential security risks before they are exploited by malicious actors.
71+
* **Enhanced security**: {% data variables.product.prodname_secret_scanning_caps %} scans your repositories for sensitive information like API keys, passwords, tokens, and other secrets. By detecting these early, you can mitigate potential security risks before they are exploited by malicious actors.
7272

73-
* **Automated detection**—The feature automatically scans your codebase, including commits, issues, and pull requests, ensuring continuous protection without requiring manual intervention. This automation helps in maintaining security even as your repository evolves.
73+
* **Automated detection**: The feature automatically scans your codebase, including commits, issues, and pull requests, ensuring continuous protection without requiring manual intervention. This automation helps in maintaining security even as your repository evolves.
7474

75-
* **Real-time alerts**—When a secret is detected, {% data variables.product.prodname_secret_scanning %} provides real-time alerts to repository administrators and contributors. This immediate feedback allows for swift remediation actions.
75+
* **Real-time alerts**: When a secret is detected, {% data variables.product.prodname_secret_scanning %} provides real-time alerts to repository administrators and contributors. This immediate feedback allows for swift remediation actions.
7676

7777
{% ifversion fpt or ghec %}
7878

79-
* **Integration with service providers**—{% data variables.product.prodname_dotcom %} partners with various service providers to validate detected secrets. When a secret is identified, {% data variables.product.prodname_dotcom %} notifies the corresponding service provider to take appropriate actions, such as revoking the exposed credential. For more information, see "[AUTOTITLE](/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program)."
79+
* **Integration with service providers**: {% data variables.product.prodname_dotcom %} partners with various service providers to validate detected secrets. When a secret is identified, {% data variables.product.prodname_dotcom %} notifies the corresponding service provider to take appropriate actions, such as revoking the exposed credential. For more information, see "[AUTOTITLE](/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program)."
8080

8181
{% endif %}
8282

8383
{% ifversion ghec or ghes %}
8484

85-
* **Custom pattern support**—Organizations can define custom patterns to detect proprietary or unique types of secrets that may not be covered by default patterns. This flexibility allows for tailored security measures specific to your environment.
85+
* **Custom pattern support**: Organizations can define custom patterns to detect proprietary or unique types of secrets that may not be covered by default patterns. This flexibility allows for tailored security measures specific to your environment.
8686

8787
{% endif %}
8888

8989
{% ifversion secret-scanning-non-provider-patterns %}
9090

91-
* **Ability to detect non-provider patterns**—You can expand the detection to include non-provider patterns such as connection strings, authentication headers, and private keys, for your repository or organization.
91+
* **Ability to detect non-provider patterns**: You can expand the detection to include non-provider patterns such as connection strings, authentication headers, and private keys, for your repository or organization.
9292

9393
{% endif %}
9494

‎content/code-security/secret-scanning/introduction/supported-secret-scanning-patterns.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,19 @@ If you believe that {% data variables.product.prodname_secret_scanning %} should
3333

3434
This table lists the secrets supported by {% data variables.product.prodname_secret_scanning %}. You can see the types of alert that get generated for each token, as well as whether a validity check is performed on the token.
3535

36-
* **Provider**—name of the token provider.{% ifversion fpt or ghec %}
37-
* **Partner**—token for which leaks are reported to the relevant token partner. Applies to public repositories only.
38-
* **User**—token for which leaks are reported to users on {% data variables.product.prodname_dotcom %}.{% ifversion secret-scanning-non-provider-patterns %}
36+
* **Provider**: Name of the token provider.{% ifversion fpt or ghec %}
37+
* **Partner**: Token for which leaks are reported to the relevant token partner. Applies to public repositories only.
38+
* **User**: Token for which leaks are reported to users on {% data variables.product.prodname_dotcom %}.{% ifversion secret-scanning-non-provider-patterns %}
3939
* Applies to public repositories, and to private repositories where {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_secret_scanning %} are enabled.
4040
* Includes {% ifversion secret-scanning-alert-experimental-list %}default{% else %}high confidence{% endif %} tokens, which relate to supported patterns and specified custom patterns, as well as non-provider tokens such as private keys, which usually have a higher ratio of false positives.
4141
* For {% data variables.product.prodname_secret_scanning %} to scan for non-provider patterns, the detection of non-provider patterns must be enabled for the repository or the organization. For more information, see "[AUTOTITLE](/code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository)."
4242
{% data reusables.secret-scanning.non-provider-patterns-beta %}{% endif %}{% endif %}{% ifversion ghes %}
43-
* **{% data variables.product.prodname_secret_scanning_caps %} alert**—token for which leaks are reported to users on {% data variables.product.prodname_dotcom %}.{% ifversion secret-scanning-non-provider-patterns %}
43+
* **{% data variables.product.prodname_secret_scanning_caps %} alert**: Token for which leaks are reported to users on {% data variables.product.prodname_dotcom %}.{% ifversion secret-scanning-non-provider-patterns %}
4444
* Applies to private repositories where {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_secret_scanning %} are enabled.
4545
* Includes {% ifversion secret-scanning-alert-experimental-list %}default{% else %}high confidence{% endif %} tokens, which relate to supported patterns and specified custom patterns, as well as non-provider tokens such as private keys, which often result in false positives.{% else %} Applies to private repositories where {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_secret_scanning %} enabled.{% endif %}{% endif %}
46-
* **Push protection**—token for which leaks are reported to users on {% data variables.product.prodname_dotcom %}. Applies to repositories with {% data variables.product.prodname_secret_scanning %} and push protection enabled.
46+
* **Push protection**: Token for which leaks are reported to users on {% data variables.product.prodname_dotcom %}. Applies to repositories with {% data variables.product.prodname_secret_scanning %} and push protection enabled.
4747

48-
* **Validity check**—token for which a validity check is implemented. {% ifversion secret-scanning-validity-check-partner-patterns %}For partner tokens, {% data variables.product.prodname_dotcom %} sends the token to the relevant partner. Note that not all partners are based in the United States. For more information, see "[{% data variables.product.prodname_advanced_security %}](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#advanced-security)" in the Site Policy documentation.{% else %} {% ifversion ghes %}Currently only applies to {% data variables.product.prodname_dotcom %} tokens.{% endif %} {% ifversion fpt %}Currently only applies to {% data variables.product.prodname_dotcom %} tokens, and not shown in the table. For more information about validity check support see "[AUTOTITLE](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}{% endif %}
48+
* **Validity check**: Token for which a validity check is implemented. {% ifversion secret-scanning-validity-check-partner-patterns %}For partner tokens, {% data variables.product.prodname_dotcom %} sends the token to the relevant partner. Note that not all partners are based in the United States. For more information, see "[{% data variables.product.prodname_advanced_security %}](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#advanced-security)" in the Site Policy documentation.{% else %} {% ifversion ghes %}Currently only applies to {% data variables.product.prodname_dotcom %} tokens.{% endif %} {% ifversion fpt %}Currently only applies to {% data variables.product.prodname_dotcom %} tokens, and not shown in the table. For more information about validity check support see "[AUTOTITLE](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}{% endif %}
4949

5050
{% ifversion secret-scanning-non-provider-patterns %}
5151

0 commit comments

Comments
 (0)