зеркало из https://github.com/github/docs.git
docs-bot
GitHub
Коммит
66be239524
|
|
@ -18,7 +18,12 @@ permissions:
|
|||
|
||||
jobs:
|
||||
find-pr-and-post-comment:
|
||||
if: ${{ github.repository == 'github/docs-internal' }}
|
||||
if: >-
|
||||
${{
|
||||
github.repository == 'github/docs-internal' &&
|
||||
(github.event_name != 'workflow_run' ||
|
||||
github.event.workflow_run.conclusion == 'success')
|
||||
}}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out repo
|
||||
|
|
|
|||
|
|
@ -30,7 +30,12 @@ env:
|
|||
|
||||
jobs:
|
||||
send-purges:
|
||||
if: ${{ github.repository == 'github/docs-internal' && (github.event_name != 'workflow_run' || github.event.workflow_run.conclusion == 'success') }}
|
||||
if: >-
|
||||
${{
|
||||
github.repository == 'github/docs-internal' &&
|
||||
(github.event_name != 'workflow_run' ||
|
||||
github.event.workflow_run.conclusion == 'success')
|
||||
}}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out repo
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ topics:
|
|||
- Profiles
|
||||
shortTitle: Pin items
|
||||
---
|
||||
You can pin a public repository if you own the repository or you've made contributions to the repository. Commits to forks don't count as contributions, so you can't pin a fork that you don't own. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"
|
||||
You can pin a public repository if you own the repository or you've made contributions to the repository within the last year. Commits to forks don't count as contributions, so you can't pin a fork that you don't own. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile)"
|
||||
|
||||
You can pin any public gist you own.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,10 @@ topics:
|
|||
- Errors
|
||||
- Troubleshooting
|
||||
versions:
|
||||
feature: code-scanning-tool-status-page
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
|
||||
## About this error
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: 'Alerts found in generated code'
|
||||
shortTitle: 'Alerts in generated code'
|
||||
title: Alerts found in generated code
|
||||
shortTitle: Alerts in generated code
|
||||
intro: 'When analyzing your code with {% data variables.product.prodname_code_scanning %}, you may wish to build only the code which you wish to analyze.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
|
|
@ -8,6 +8,8 @@ versions:
|
|||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/alerts-found-in-generated-code
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: 'Code scanning analysis takes too long'
|
||||
shortTitle: 'Analysis takes too long'
|
||||
title: Code scanning analysis takes too long
|
||||
shortTitle: Analysis takes too long
|
||||
intro: 'You can fine tune your {% data variables.product.prodname_code_scanning %} configuration to minimize analysis time.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
|
|
@ -8,6 +8,8 @@ versions:
|
|||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/build-is-taking-too-long
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: 'Automatic build failed for a compiled language'
|
||||
shortTitle: 'Automatic build failed'
|
||||
title: Automatic build failed for a compiled language
|
||||
shortTitle: Automatic build failed
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'If automatic build fails, you can configure {% data variables.product.prodname_code_scanning %} to use specific build steps for compiled languages.'
|
||||
versions:
|
||||
|
|
@ -8,6 +8,8 @@ versions:
|
|||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed-for-a-compiled-language
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: 'Cannot enable CodeQL in a private repository'
|
||||
intro: '{% data variables.product.prodname_GH_advanced_security %} must be enabled in order to use {% data variables.product.prodname_code_scanning %} on private repositories.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
type: reference
|
||||
topics:
|
||||
- Code scanning
|
||||
- Errors
|
||||
- Troubleshooting
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
---
|
||||
|
||||
{% ifversion fpt %}
|
||||
If you are on a free, pro, or team plan, you can only use {% data variables.product.prodname_code_scanning %} on repositories that are publically available. To enable {% data variables.product.prodname_code_scanning %} for private or internal repositories, you must upgrade to GitHub Enterprise with {% data variables.product.prodname_GH_advanced_security %} and enable {% data variables.product.prodname_GH_advanced_security %} for the repository. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-products#github-enterprise)" and "[AUTOTITLE](/get-started/learning-about-github/about-github-advanced-security)."
|
||||
|
||||
{% else %}
|
||||
|
||||
## Confirm whether {% data variables.product.prodname_GH_advanced_security %} is enabled
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% data reusables.user-settings.security-analysis %}
|
||||
1. Scroll down to "{% data variables.product.prodname_GH_advanced_security %}."
|
||||
1. If there is an associated and active **Enable** button, {% data variables.product.prodname_GH_advanced_security %} is available for this repository but not yet enabled.
|
||||
1. If use of {% data variables.product.prodname_GH_advanced_security %} is blocked by a policy, the **Enable** button is inactive and the owner of the policy is listed.
|
||||
|
||||
|
||||
|
||||
### Requesting access to {% data variables.product.prodname_GH_advanced_security %}
|
||||
|
||||
1. In the "{% data variables.product.prodname_GH_advanced_security %}" settings, click the enterprise name to display a list of users with access to edit the policy that controls access to {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise#enforcing-a-policy-for-the-use-of-github-advanced-security-in-your-enterprises-organizations)."
|
||||
1. Follow your company's policy for requesting access to additional features.
|
||||
|
||||
### Enabling {% data variables.product.prodname_GH_advanced_security %}
|
||||
|
||||
1. In the "{% data variables.product.prodname_GH_advanced_security %}" settings, click **Enable**.
|
||||
1. Rerun {% data variables.product.prodname_code_scanning %}.
|
||||
|
||||
{% endif %}
|
||||
|
|
@ -1,10 +1,12 @@
|
|||
---
|
||||
title: 'A particular language is causing default setup to fail'
|
||||
shortTitle: 'Default setup fails with a language'
|
||||
title: A particular language is causing default setup to fail
|
||||
shortTitle: Default setup fails with a language
|
||||
intro: 'When you enable default setup, all languages selected for analysis must be successfully analyzed, or the configuration of default setup will fail.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
feature: code-scanning-without-workflow-310
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/a-particular-language-is-causing-default-setup-to-fail
|
||||
---
|
||||
|
||||
To enable default setup when a language previously failed, you must reconfigure default setup, deselecting all failing languages for analysis.
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: 'CodeQL scanned fewer lines than expected'
|
||||
shortTitle: 'Fewer lines scanned than expected'
|
||||
title: CodeQL scanned fewer lines than expected
|
||||
shortTitle: Fewer lines scanned than expected
|
||||
intro: 'If {% data variables.product.prodname_codeql %} analyzed less code than than you expected, you may need to use a custom build command.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
|
|
@ -8,6 +8,8 @@ versions:
|
|||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -15,24 +15,26 @@ topics:
|
|||
- CodeQL
|
||||
- Repositories
|
||||
children:
|
||||
- /a-particular-language-is-causing-default-setup-to-fail
|
||||
- /advanced-security-must-be-enabled
|
||||
- /alerts-found-in-generated-code
|
||||
- /automatic-build-failed-for-a-compiled-language
|
||||
- /build-is-taking-too-long
|
||||
- /codeql-scanned-fewer-lines-than-expected
|
||||
- /alerts-in-generated-code
|
||||
- /analysis-takes-too-long
|
||||
- /automatic-build-failed
|
||||
- /cannot-enable-codeql-in-a-private-repository
|
||||
- /default-setup-fails-with-a-language
|
||||
- /enabling-default-setup-takes-too-long
|
||||
- /extraction-errors-in-the-database
|
||||
- /logs-are-not-detailed-enough
|
||||
- /fewer-lines-scanned-than-expected
|
||||
- /logs-not-detailed-enough
|
||||
- /no-source-code-seen-during-build
|
||||
- /not-recognized
|
||||
- /out-of-disk-or-memory
|
||||
- /some-languages-were-not-analyzed
|
||||
- /resource-not-accessible-by-integration
|
||||
- /results-are-different-than-expected
|
||||
- /resource-not-accessible
|
||||
- /results-different-than-expected
|
||||
- /results-differ-between-platforms
|
||||
- /server-error
|
||||
- /some-languages-not-analyzed
|
||||
- /two-codeql-workflows
|
||||
- /unclear-what-triggered-a-workflow-run
|
||||
- /unclear-what-triggered-a-workflow
|
||||
- /unnecessary-step-found
|
||||
---
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: 'Logs are not detailed enough'
|
||||
shortTitle: 'Logs not detailed enough'
|
||||
title: Logs are not detailed enough
|
||||
shortTitle: Logs not detailed enough
|
||||
intro: 'If you''d like to increase the level of detail in your logs, try these steps.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
|
|
@ -8,6 +8,8 @@ versions:
|
|||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/logs-are-not-detailed-enough
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -1,11 +1,13 @@
|
|||
---
|
||||
title: 'Error: 403 "Resource not accessible by integration"'
|
||||
shortTitle: 'Resource not accessible'
|
||||
shortTitle: Resource not accessible
|
||||
intro: 'This error may be seen on pull requests created by {% data variables.product.prodname_dependabot %} and can be resolved in a couple of different ways.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible-by-integration
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -1,10 +1,12 @@
|
|||
---
|
||||
title: 'Results are different than expected'
|
||||
shortTitle: 'Results different than expected'
|
||||
title: Results are different than expected
|
||||
shortTitle: Results different than expected
|
||||
intro: 'If your {% data variables.product.prodname_code_scanning %} results are different than you expected, you can check which configurations are active.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
feature: code-scanning-without-workflow
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/results-are-different-than-expected
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: 'Some languages were not analyzed with CodeQL advanced setup'
|
||||
shortTitle: 'Some languages not analyzed'
|
||||
title: Some languages were not analyzed with CodeQL advanced setup
|
||||
shortTitle: Some languages not analyzed
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'If some languages were not analyzed, you can modify your {% data variables.product.prodname_code_scanning %} workflow to add a matrix specifying the languages you want to analyze.'
|
||||
versions:
|
||||
|
|
@ -8,6 +8,8 @@ versions:
|
|||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/some-languages-were-not-analyzed
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -1,10 +1,12 @@
|
|||
---
|
||||
title: 'Unclear what triggered a workflow run'
|
||||
shortTitle: 'Unclear what triggered a workflow'
|
||||
title: Unclear what triggered a workflow run
|
||||
shortTitle: Unclear what triggered a workflow
|
||||
intro: 'If you don''t know what triggered an analysis, {% ifversion code-scanning-tool-status-page %} investigate the {% data variables.code-scanning.tool_status_page %} or {% endif %}look at the log for the last scan.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
feature: code-scanning-without-workflow
|
||||
redirect_from:
|
||||
- /code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow-run
|
||||
---
|
||||
|
||||
{% data reusables.code-scanning.beta %}
|
||||
|
|
@ -84,6 +84,7 @@ You may notice some repositories have a "Used by" section in the sidebar of the
|
|||
- The dependency graph is enabled for the repository (see the above section for more details).
|
||||
- Your repository contains a package that is published on a [supported package ecosystem](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#supported-package-ecosystems).
|
||||
- Within the ecosystem, your package has a link to a _public_ repository where the source is stored.
|
||||
- More than 100 repositories depend on your package.
|
||||
|
||||
The "Used by" section shows the number of public references to the package that were found, and displays the avatars of some of the owners of the dependent projects.
|
||||
|
||||
|
|
|
|||
|
|
@ -45,6 +45,8 @@ A [pull request](/github/collaborating-with-issues-and-pull-requests/about-pull-
|
|||
|
||||
We cannot accept contributions to the [REST API reference documentation](/rest/reference). If you spot an inaccuracy in the REST API reference documentation, open an issue in the [`rest-api-description`](https://github.com/github/rest-api-description/issues/new?template=schema-inaccuracy.md) repository.
|
||||
|
||||
We only document {% data variables.product.prodname_dotcom %} products, features, tools, and extensions. We do not document third-party tools or integrations unless they were codeveloped with {% data variables.product.company_short %}.
|
||||
|
||||
### Reviewing your own pull requests
|
||||
|
||||
You should always review your own pull request first, before marking it as ready for review by others.
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ Only include a maximum of eight different tools in an article. Including more to
|
|||
|
||||
## Adding new tools
|
||||
|
||||
{% data variables.product.prodname_docs %} documents and maintains tool tags for {% data variables.product.prodname_dotcom %} products, {% data variables.product.prodname_dotcom %}-developed tools, and select third-party extensions.
|
||||
{% data variables.product.prodname_docs %} documents and maintains tool tags for {% data variables.product.prodname_dotcom %} products, {% data variables.product.prodname_dotcom %}-developed tools, and select third-party extensions developed in collaboration with {% data variables.product.company_short %} .
|
||||
|
||||
New tools are only added when they are the only way to accurately document something for a specific user need. If a writer determines that adding a new tool is the only way to accurately document something, they need to propose the new tool in a content design plan. Whoever reviews the content design plan should consider any alternative ways to address the documentation needs without adding a new tool. If a new tool is the only way to create accurate documentation, the new tool should be added. If there is an alternative content solution that does not add a new tool, that option should be used.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,12 @@ shortTitle: Required status checks
|
|||
---
|
||||
If you have a check and a status with the same name, and you select that name as a required status check, both the check and the status are required. For more information, see "[AUTOTITLE](/rest/checks)."
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** To be required, status checks must have completed successfully within the chosen repository during the past seven days.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
After you enable required status checks, your branch may need to be up-to-date with the base branch before merging. This ensures that your branch has been tested with the latest code from the base branch. If your branch is out of date, you'll need to merge the base branch into your branch. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging)."
|
||||
|
||||
{% note %}
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ When we receive reports of trademark policy violations from holders of federal o
|
|||
|
||||
## How Do I Report a Trademark Policy Violation?
|
||||
|
||||
Holders of registered trademarks can report possible trademark policy violations to GitHub via [GitHub Support](https://support.github.com/). Please use the contact form and submit trademark-related requests using your company email address and include all the information requested below to help expedite our response. Also be sure to clearly describe to us why the account may cause confusion with your mark or how the account may dilute or tarnish your mark.
|
||||
Holders of registered trademarks can report possible trademark policy violations to GitHub via [Submit a Trademark Policy Violation Report](https://support.github.com/contact/trademark-policy). Please use the contact form and submit trademark-related requests using your company email address and include all the information requested below to help expedite our response. Also be sure to clearly describe to us why the account may cause confusion with your mark or how the account may dilute or tarnish your mark.
|
||||
|
||||
## What Information is Required When Reporting Trademark Policy Violations?
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
[APIs and Integrations discussions on {% data variables.product.prodname_github_community %}](https://github.com/orgs/community/discussions/categories/api-and-webhooks)https://github.com/orgs/community/discussions/categories/api-and-webhooks)
|
||||
[API and Webhooks category in GitHub's Community Discussions](https://github.com/orgs/community/discussions/categories/api-and-webhooks)
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче