diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 46fa6e2d40bf..b04da84f0758 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -63,7 +63,7 @@ // Lifecycle commands // Start a web server and keep it running - "postStartCommand": "nohup bash -c 'npm start &'", + "postStartCommand": "nohup bash -c 'npm ci && npm start &'", // Set port 4000 to be public "postAttachCommand": "gh cs ports visibility 4000:public -c \"$CODESPACE_NAME\"", diff --git a/.github/workflows/docs-review-collect.yml b/.github/workflows/docs-review-collect.yml index 8e1bce8f7af9..a70d29678d3d 100644 --- a/.github/workflows/docs-review-collect.yml +++ b/.github/workflows/docs-review-collect.yml @@ -29,7 +29,7 @@ jobs: cache: npm - name: Install dependencies - run: npm install @octokit/graphql + run: npm ci - name: Run script for audit-log-allowlists run: | diff --git a/.github/workflows/os-ready-for-review.yml b/.github/workflows/os-ready-for-review.yml index 282dd07278dd..37c9881b9963 100644 --- a/.github/workflows/os-ready-for-review.yml +++ b/.github/workflows/os-ready-for-review.yml @@ -54,7 +54,7 @@ jobs: cache: npm - name: Install dependencies - run: npm install @octokit/graphql + run: npm ci - name: Run script run: | diff --git a/.github/workflows/ready-for-doc-review.yml b/.github/workflows/ready-for-doc-review.yml index 6117465f2a77..152490b8b801 100644 --- a/.github/workflows/ready-for-doc-review.yml +++ b/.github/workflows/ready-for-doc-review.yml @@ -33,7 +33,7 @@ jobs: cache: npm - name: Install dependencies - run: npm install @octokit/graphql + run: npm ci - name: Set AUTHOR_LOGIN run: | diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 2815b0d847e9..5368a43186a8 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -163,4 +163,7 @@ jobs: ENABLED_LANGUAGES: ${{ matrix.name == 'languages' && 'all' || '' }} ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'article-api' || matrix.name == 'landings' ) && 'src/fixtures/fixtures' || '' }} TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'article-api') && 'src/fixtures/fixtures/translations' || '' }} + # Enable debug logging when "Re-run jobs with debug logging" is used in GitHub Actions UI + # This will output additional timing and path information to help diagnose timeout issues + RUNNER_DEBUG: ${{ runner.debug }} run: npm test -- src/${{ matrix.name }}/tests/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 188eab56e284..b5d45886da75 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,27 @@ # Docs changelog +**16 January 2026** + +We published [About user offboarding on GitHub Enterprise Cloud](https://docs.github.com/en/enterprise-cloud@latest/admin/concepts/identity-and-access-management/user-offboarding) to give enterprise customers clear guidance about offboarding processes. The article covers recommended offboarding methods, the effects of offboarding, and what happens when a user is removed from all organizations in an enterprise. + +We also updated [Removing a member from your enterprise](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise) and [Removing a member from your organization](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization) to include instructions for enterprises that use Enterprise Managed Users or SCIM for organizations. + +
+ +**13 January 2026** + +We've added a new reference article to clarify which of the various types of custom instructions for Copilot are supported by Copilot Chat, Copilot coding agent, and Copilot code review in GitHub.com, Visual Studio Code, Visual Studio, JetBrains IDEs, Eclipse, Xcode, and Copilot CLI. + +[Support for different types of custom instructions](https://docs.github.com/copilot/reference/custom-instructions-support) + +
+ +**8 January 2026** + +We've added information about permissions to the article [Using GitHub Copilot CLI](https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#permissions). + +
+ **18 December 2025** The documentation has been updated to reflect the general availability of direct organization billing for premium request usage in Copilot Code Review. Organization members without a Copilot plan can now use Copilot Code Review on GitHub.com, with premium request usage billed directly to their organization or enterprise. See [Copilot code review without a Copilot license](https://docs.github.com/en/copilot/concepts/agents/code-review#copilot-code-review-without-a-copilot-license). diff --git a/Dockerfile b/Dockerfile index 9bee3357a106..1a4e587d8c0b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,7 +8,7 @@ # --------------------------------------------------------------- # To update the sha: # https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble -FROM ghcr.io/github/gh-base-image/gh-base-noble:20251217-105955-g05726ec4c AS base +FROM ghcr.io/github/gh-base-image/gh-base-noble:20260113-125234-g605df3bee AS base # Install curl for Node install and determining the early access branch # Install git for cloning docs-early-access & translations repos diff --git a/assets/images/help/copilot/copilot-memory-list.png b/assets/images/help/copilot/copilot-memory-list.png new file mode 100644 index 000000000000..26915ea4117e Binary files /dev/null and b/assets/images/help/copilot/copilot-memory-list.png differ diff --git a/assets/images/help/repository/rendered-code-snippet.png b/assets/images/help/repository/rendered-code-snippet.png index 6a21e3f21773..a1b41600a88e 100644 Binary files a/assets/images/help/repository/rendered-code-snippet.png and b/assets/images/help/repository/rendered-code-snippet.png differ diff --git a/config/moda/secrets/ci/secrets.yml b/config/moda/secrets/ci/secrets.yml new file mode 100644 index 000000000000..0a481b8efa0a --- /dev/null +++ b/config/moda/secrets/ci/secrets.yml @@ -0,0 +1,9 @@ +--- +secrets: + DOCS_BOT_PAT_BASE: + key: DOCS_BOT_PAT_BASE + type: github_pat + owner: docs-engineering + playbook: '' + externally_usable: true + kind: latest_at_deployment_start diff --git a/config/moda/secrets/docs-internal-staging-boxwood/secrets.yml b/config/moda/secrets/docs-internal-staging-boxwood/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-boxwood/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-cedar/secrets.yml b/config/moda/secrets/docs-internal-staging-cedar/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-cedar/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-cypress/secrets.yml b/config/moda/secrets/docs-internal-staging-cypress/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-cypress/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-fir/secrets.yml b/config/moda/secrets/docs-internal-staging-fir/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-fir/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-hemlock/secrets.yml b/config/moda/secrets/docs-internal-staging-hemlock/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-hemlock/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-holly/secrets.yml b/config/moda/secrets/docs-internal-staging-holly/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-holly/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-juniper/secrets.yml b/config/moda/secrets/docs-internal-staging-juniper/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-juniper/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-laurel/secrets.yml b/config/moda/secrets/docs-internal-staging-laurel/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-laurel/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-pine/secrets.yml b/config/moda/secrets/docs-internal-staging-pine/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-pine/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-redwood/secrets.yml b/config/moda/secrets/docs-internal-staging-redwood/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-redwood/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-sequoia/secrets.yml b/config/moda/secrets/docs-internal-staging-sequoia/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-sequoia/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/docs-internal-staging-spruce/secrets.yml b/config/moda/secrets/docs-internal-staging-spruce/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/docs-internal-staging-spruce/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/production/secrets.yml b/config/moda/secrets/production/secrets.yml new file mode 100644 index 000000000000..ce9ebe2c6975 --- /dev/null +++ b/config/moda/secrets/production/secrets.yml @@ -0,0 +1,6 @@ +--- +secrets: + COOKIE_SECRET: + kind: latest_at_deployment_start + key: COOKIE_SECRET + type: salt diff --git a/config/moda/secrets/review-os/secrets.yml b/config/moda/secrets/review-os/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/review-os/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/review/secrets.yml b/config/moda/secrets/review/secrets.yml new file mode 100644 index 000000000000..1cc2ba803f6c --- /dev/null +++ b/config/moda/secrets/review/secrets.yml @@ -0,0 +1,2 @@ +--- +secrets: {} diff --git a/config/moda/secrets/staging/secrets.yml b/config/moda/secrets/staging/secrets.yml new file mode 100644 index 000000000000..ce9ebe2c6975 --- /dev/null +++ b/config/moda/secrets/staging/secrets.yml @@ -0,0 +1,6 @@ +--- +secrets: + COOKIE_SECRET: + kind: latest_at_deployment_start + key: COOKIE_SECRET + type: salt diff --git a/content/account-and-profile/concepts/account-management.md b/content/account-and-profile/concepts/account-management.md index 1a10f571cef2..b8f83f42c197 100644 --- a/content/account-and-profile/concepts/account-management.md +++ b/content/account-and-profile/concepts/account-management.md @@ -13,19 +13,26 @@ redirect_from: - /account-and-profile/concepts/personal-account-management --- +{% ifversion ghes < 3.21 %} ## About converting your personal account Converting a personal account into an organization allows you move to a shared account where a large number of people can collaborate across many projects at once. Converting your account: * Preserves the repositories as they are without the need to transfer them to another account manually * Automatically invites collaborators to teams with permissions equivalent to what they had before -{%- ifversion fpt or ghec %} -* For personal accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/billing/managing-the-plan-for-your-github-account/about-billing-for-plans) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time -{%- endif %} When you convert a personal account into an organization, we'll add collaborators on repositories that belong to the account to the new organization as outside collaborators. You can then invite outside collaborators to become members of your new organization if you wish. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators). To convert your personal account into an organization, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization). +{% else %} + +## About moving your work to an organization + +You can move repositories and projects from your personal account to an organization while keeping your personal account intact. This enables team collaboration with granular permissions across your existing work. + +For more information, see [AUTOTITLE](/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization). +{% endif %} + ## About deletion of your personal account Deleting your personal account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted. Your resources and comments will become associated with the [ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %} diff --git a/content/account-and-profile/how-tos/account-management/converting-a-user-into-an-organization.md b/content/account-and-profile/how-tos/account-management/converting-a-user-into-an-organization.md index 3528a48d83ff..cba85aee110f 100644 --- a/content/account-and-profile/how-tos/account-management/converting-a-user-into-an-organization.md +++ b/content/account-and-profile/how-tos/account-management/converting-a-user-into-an-organization.md @@ -12,9 +12,7 @@ redirect_from: - /account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/converting-a-user-into-an-organization intro: You can convert your personal account into an organization. This allows more granular permissions for repositories that belong to the organization. versions: - fpt: '*' - ghes: '*' - ghec: '*' + ghes: '<3.21' topics: - Accounts shortTitle: Convert your account @@ -25,9 +23,7 @@ contentType: how-tos The personal account you want to convert cannot be a member of any organizations. If the personal account you want to convert is a member of an organization, you must leave the organization before you can convert the account. -{% ifversion ghes %} -You may not be able to convert a personal account into an organization, if an enterprise owner has set a policy at the enterprise level. See, [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/preventing-users-from-creating-organizations). -{% endif %} +You may not be able to convert a personal account into an organization if an enterprise owner has set a policy at the enterprise level. See, [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/preventing-users-from-creating-organizations). ## Keep your personal account and create a new organization manually @@ -56,7 +52,4 @@ To convert your personal account into an organization, follow these steps: * [AUTOTITLE](/account-and-profile/reference/personal-account-reference#side-effects-of-converting-an-account-to-an-organization) * [AUTOTITLE](/organizations/organizing-members-into-teams) -{% ifversion fpt or ghec %} -* [AUTOTITLE](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization) -{% endif %} * [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/accessing-an-organization) diff --git a/content/account-and-profile/how-tos/account-management/index.md b/content/account-and-profile/how-tos/account-management/index.md index 64b0125a06ab..ffbcfd0fc040 100644 --- a/content/account-and-profile/how-tos/account-management/index.md +++ b/content/account-and-profile/how-tos/account-management/index.md @@ -1,6 +1,6 @@ --- title: Managing your personal account -intro: You can manage your personal account on {% data variables.product.github %}. For example, you can {% ifversion fpt or ghec %}manage multiple accounts, {% endif %}convert an account to an organization, or delete an account. +intro: You can manage your personal account on {% data variables.product.github %}. For example, you can change your username, {% ifversion fpt or ghec %}manage multiple accounts, {% endif %}{% ifversion ghes < 3.21 %}convert an account to an organization, {% else %}move your work to an organization, {% endif %}or delete an account. shortTitle: Personal account management versions: fpt: '*' @@ -12,6 +12,7 @@ children: - /managing-multiple-accounts - /merging-multiple-personal-accounts - /changing-your-username + - /moving-your-work-to-an-organization - /converting-a-user-into-an-organization - /unlinking-your-email-address-from-a-locked-account - /deleting-your-personal-account diff --git a/content/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization.md b/content/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization.md new file mode 100644 index 000000000000..6c76c0a24bcc --- /dev/null +++ b/content/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization.md @@ -0,0 +1,32 @@ +--- +title: Moving your work to an organization +intro: You can transfer repositories and projects from your personal account to a new or existing organization through your account settings. +versions: + fpt: '*' + ghes: '>= 3.21' + ghec: '*' +topics: + - Organizations + - Teams +shortTitle: Move work to organization +--- + +## Keeping your username for the organization + +If you want your new organization to use your current personal account username, you'll need to rename your personal account first: + +1. Change your personal account username to something new. For more information, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/changing-your-github-username). +1. Create an organization using your original username, then follow the steps below to move your work. + +## Moving your work to an organization + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.organizations %} +1. Under the "Move to an organization" section, click **Move work to an organization**. +1. Follow the prompts to transfer any of your repositories and projects to a new or existing organization. {% ifversion fpt or ghec %}For more information about the plans available for your team, see [AUTOTITLE](/get-started/learning-about-github/githubs-plans).{% endif %} +1. Once done assigning your work to its new location, click **Move to an organization**, then click **Go to your organization**. + +## Further reading + +- [AUTOTITLE](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization) +- [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization) diff --git a/content/actions/how-tos/manage-runners/larger-runners/use-custom-images.md b/content/actions/how-tos/manage-runners/larger-runners/use-custom-images.md index 4c76c2127654..82544a91631b 100644 --- a/content/actions/how-tos/manage-runners/larger-runners/use-custom-images.md +++ b/content/actions/how-tos/manage-runners/larger-runners/use-custom-images.md @@ -57,6 +57,9 @@ To configure a workflow for image generation: * Each job that includes the `snapshot` keyword creates a separate image. To generate only one image or image version, include all workflow steps in a single job. * Each successful run of a job that includes the `snapshot` keyword creates a new version of that image. + > [!NOTE] + > {% data variables.product.company_short %} recommends configuring image generation as a scheduled workflow on a weekly basis. This approach ensures dependencies remain up-to-date and have the latest security patches. For more information, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#schedule). + It can take some time for your image to be fully generated and ready to use after the workflow completes. Provisioning time varies based on runner size and configuration, and may take several hours for larger runners. The image is generated only when the job completes successfully. This prevents new image versions from being created when a workflow fails or ends in an incomplete state. diff --git a/content/actions/how-tos/monitor-workflows/enable-debug-logging.md b/content/actions/how-tos/monitor-workflows/enable-debug-logging.md index 4233769ee5ba..2cc65a5679fa 100644 --- a/content/actions/how-tos/monitor-workflows/enable-debug-logging.md +++ b/content/actions/how-tos/monitor-workflows/enable-debug-logging.md @@ -42,3 +42,5 @@ Step debug logging increases the verbosity of a job's logs during and after a jo 1. To enable step debug logging, set the following secret or variable in the repository that contains the workflow: `ACTIONS_STEP_DEBUG` to `true`. If both the secret and variable are set, the value of the secret takes precedence over the variable. 1. After setting the secret or variable, more debug events are shown in the step logs. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs#viewing-logs-to-diagnose-failures). + +You can also use the `runner.debug` context to conditionally run steps only when debug logging is enabled. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/contexts#runner-context). diff --git a/content/actions/how-tos/monitor-workflows/index.md b/content/actions/how-tos/monitor-workflows/index.md index 449963c2b164..557de7868aab 100644 --- a/content/actions/how-tos/monitor-workflows/index.md +++ b/content/actions/how-tos/monitor-workflows/index.md @@ -11,6 +11,7 @@ children: - /view-job-execution-time - /add-a-status-badge - /use-workflow-run-logs + - /view-job-condition-logs - /enable-debug-logging redirect_from: - /actions/monitoring-and-troubleshooting-workflows/monitoring-workflows diff --git a/content/actions/how-tos/monitor-workflows/view-job-condition-logs.md b/content/actions/how-tos/monitor-workflows/view-job-condition-logs.md new file mode 100644 index 000000000000..10ffe79d9bfa --- /dev/null +++ b/content/actions/how-tos/monitor-workflows/view-job-condition-logs.md @@ -0,0 +1,40 @@ +--- +title: Viewing job condition expression logs +shortTitle: View job condition logs +intro: 'Learn how to access and interpret expression evaluation logs for job-level `if` conditions in {% data variables.product.prodname_actions %}.' +versions: + fpt: '*' + ghec: '*' +contentType: how-tos +--- + +When a job's `if` condition is evaluated, {% data variables.product.prodname_actions %} logs the expression evaluation to help you understand the result. This is useful for debugging both why a job was skipped and why a job ran when you expected it to be skipped. + +## Accessing expression logs + +1. Navigate to the workflow run summary. +1. Click on the job. +1. Click **{% octicon "gear" aria-label="The Gear icon" %}**. +1. Select **Download log archive**. +1. Extract the ZIP file and open the `JOB-NAME/system.txt` file. + +## Understanding the log output + +The system log shows the expression evaluation: + +```text +Evaluating: (success() && ((github.repository == 'octo-org/octo-repo-prod'))) +Expanded: (true && (('my-username/octo-repo-prod' == 'octo-org/octo-repo-prod'))) +Result: false +``` + +| Line | Description | +|------|-------------| +| **Evaluating** | The original `if` expression from your workflow file. | +| **Expanded** | The expression with context values substituted. This shows you exactly what values were used at runtime. | +| **Result** | The final evaluation result (`true` or `false`). | + +In this example, the expanded line reveals that `github.repository` was `'my-username/octo-repo-prod'` (not `'octo-org/octo-repo-prod'`), which caused the condition to evaluate to `false`. + +> [!NOTE] +> Expression logs are only available for job-level `if` conditions. For step-level conditions, you can enable debug logging to see expression evaluation in the job logs. For more information, see [AUTOTITLE](/actions/how-tos/monitor-workflows/enable-debug-logging). diff --git a/content/actions/how-tos/troubleshoot-workflows.md b/content/actions/how-tos/troubleshoot-workflows.md index 4e55fdcb9186..8f13dd0cd575 100644 --- a/content/actions/how-tos/troubleshoot-workflows.md +++ b/content/actions/how-tos/troubleshoot-workflows.md @@ -98,6 +98,23 @@ For path filtering, evaluating diffs is limited to the first 300 files. If there Workflow execution involves any issues seen after the workflow was triggered and a workflow run has been created. +{% ifversion fpt or ghec %} + +### Debugging job conditions + +If a job was skipped unexpectedly, or ran when you expected it to be skipped, you can view the expression evaluation to understand why: + +1. Click on the job in the workflow run. +1. Download the log archive from the job's menu. +1. Open the `JOB-NAME/system.txt` file. +1. Look for the `Evaluating`, `Expanded`, and `Result` lines. + +The `Expanded` line shows the actual runtime values that were substituted into your `if` condition, making it clear why the expression evaluated to `true` or `false`. + +For more information, see [AUTOTITLE](/actions/how-tos/monitor-workflows/view-job-condition-logs). + +{% endif %} + ### Canceling Workflows If standard cancellation through the [UI](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/canceling-a-workflow) or [API](/rest/actions/workflow-runs?apiVersion=2022-11-28#cancel-a-workflow-run) does not process as expected, there may be a conditional statement configured for your running workflow job(s) that causes it to not cancel. diff --git a/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md b/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md index 2d5cb82666a2..da8210168003 100644 --- a/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md +++ b/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md @@ -37,3 +37,9 @@ Skipped jobs display the message "This check was skipped." > [!NOTE] > A job that is skipped will report its status as "Success". It will not prevent a pull request from merging, even if it is a required check. + +{% ifversion fpt or ghec %} + +To debug why a job was skipped or ran unexpectedly, you can view job condition expression logs. For more information, see [AUTOTITLE](/actions/how-tos/monitor-workflows/view-job-condition-logs). + +{% endif %} diff --git a/content/actions/reference/limits.md b/content/actions/reference/limits.md index c76e61d3631e..0bb6be46a33c 100644 --- a/content/actions/reference/limits.md +++ b/content/actions/reference/limits.md @@ -40,6 +40,7 @@ These limits are subject to change. | Larger runners | Per runner concurrency limit | Varies by runner type | Established when setting up a runner. Normally 1,000 max for Linux CPU runners, but varies by type. See [Job concurrency limits for {% data variables.product.github %}-hosted runners](#job-concurrency-limits-for-github-hosted-runners). | {% octicon "check" aria-label="Yes" %} Support ticket | | Larger runners | Static IP limits | 10 IPs | 10 IPs per enterprise and organization. | {% octicon "check" aria-label="Yes" %} Support ticket | | Larger runners | Private IP scaling for vnet injection | 30% buffer | You need a buffer to accommodate the maximum job concurrency you anticipate. See [Private IP scaling for vnet injection on larger runners](#private-ip-scaling-for-vnet-injection-on-larger-runners). | {% octicon "check" aria-label="Yes" %} Configurable Azure virtual network | +| Dependency caching | Uploads per minute | 200 per minute | Each repository is limited to 200 cache entry uploads per minute. If this limit is exceeded, subsequent cache upload attempts will fail until the rate limit resets. | {% octicon "x" aria-label="No" %} | ### Job concurrency limits for {% data variables.product.github %}-hosted runners diff --git a/content/actions/reference/workflows-and-actions/dependency-caching.md b/content/actions/reference/workflows-and-actions/dependency-caching.md index 734f4c49d85f..d738959f92bd 100644 --- a/content/actions/reference/workflows-and-actions/dependency-caching.md +++ b/content/actions/reference/workflows-and-actions/dependency-caching.md @@ -229,14 +229,14 @@ For example, if a pull request contains a `feature` branch and targets the defau If you are caching the package managers listed below, using their respective setup-* actions requires minimal configuration and will create and restore dependency caches for you. -| Package managers | setup-* action for caching | -|---|---| -| npm, Yarn, pnpm | [setup-node](https://github.com/actions/setup-node#caching-global-packages-data) | -| pip, pipenv, Poetry | [setup-python](https://github.com/actions/setup-python#caching-packages-dependencies) | -| Gradle, Maven | [setup-java](https://github.com/actions/setup-java#caching-packages-dependencies) | -| RubyGems | [setup-ruby](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically) | -| Go `go.sum` | [setup-go](https://github.com/actions/setup-go#caching-dependency-files-and-build-outputs) | -| .NET NuGet | [setup-dotnet](https://github.com/actions/setup-dotnet?tab=readme-ov-file#caching-nuget-packages) | +| Package managers | setup-* action for caching | +| ------------------- | ------------------------------------------------------------------------------------------------- | +| npm, Yarn, pnpm | [setup-node](https://github.com/actions/setup-node#caching-global-packages-data) | +| pip, pipenv, Poetry | [setup-python](https://github.com/actions/setup-python#caching-packages-dependencies) | +| Gradle, Maven | [setup-java](https://github.com/actions/setup-java#caching-packages-dependencies) | +| RubyGems | [setup-ruby](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically) | +| Go `go.sum` | [setup-go](https://github.com/actions/setup-go#caching-dependency-files-and-build-outputs) | +| .NET NuGet | [setup-dotnet](https://github.com/actions/setup-dotnet?tab=readme-ov-file#caching-nuget-packages) | ## Restrictions for accessing a cache @@ -275,6 +275,8 @@ Multiple workflow runs in a repository can share caches. A cache created for a b {% endif %} {% ifversion fpt or ghec %} +You can create cache entries at a rate of up to 200 uploads per minute per repository. If you exceed this rate, subsequent cache upload attempts will fail until the rate limit resets. The time until the rate limit resets is returned in the `Retry-After` header of the response. + ### Increasing cache size If you want to reduce the rate at which cache entries are evicted, you can increase the storage limits for your cache in the Actions Settings. Repositories owned by users can configure up to 10 TB per repository. For repositories owned by organizations, the maximum configurable limit is determined by the organization's settings. For organizations owned by an enterprise, the maximum configurable limit is determined by the enterprise's settings. Increasing the limit beyond the default 10 GB will incur additional costs, if that storage is used. diff --git a/content/actions/tutorials/publish-packages/publish-nodejs-packages.md b/content/actions/tutorials/publish-packages/publish-nodejs-packages.md index 4bb65dae8fd7..4fc561431797 100644 --- a/content/actions/tutorials/publish-packages/publish-nodejs-packages.md +++ b/content/actions/tutorials/publish-packages/publish-nodejs-packages.md @@ -114,6 +114,7 @@ If you do provide the `repository` key in your `package.json` file, then the rep "type": "git", "url": "https://github.com/octocat/my-other-repo.git" }, +} ``` ### Authenticating to the destination repository diff --git a/content/admin/all-releases.md b/content/admin/all-releases.md index 84adf08b7f67..0c46179962e7 100644 --- a/content/admin/all-releases.md +++ b/content/admin/all-releases.md @@ -58,6 +58,7 @@ If you run analysis in an external CI system, we recommend using the same versio | {% data variables.product.prodname_ghe_server %} version | Recommended {% data variables.product.prodname_codeql_cli %} version | | ------------------------------------------------- | ---------------------- | +| 3.19 | 2.22.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.22.4/)) | | 3.18 | 2.21.4 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.21.4/)) | | 3.17 | 2.20.7 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.7/)) | | 3.16 | 2.20.3 ([changelog](https://codeql.github.com/docs/codeql-overview/codeql-changelog/codeql-cli-2.20.3/)) | @@ -78,6 +79,7 @@ For instances with {% data variables.product.prodname_actions %} enabled, self-h | {% data variables.product.prodname_ghe_server %} version | Minimum Runner version | | ------------------------------------------------- | ---------------------- | +| 3.19 | 2.328.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.328.0)) | | 3.18 | 2.324.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.324.0)) | | 3.17 | 2.322.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.322.0)) | | 3.16 | 2.321.0 ([release notes](https://github.com/actions/runner/releases/tag/v2.321.0)) | diff --git a/content/admin/concepts/identity-and-access-management/index.md b/content/admin/concepts/identity-and-access-management/index.md index d1d256ee3715..75e8de8abc1c 100644 --- a/content/admin/concepts/identity-and-access-management/index.md +++ b/content/admin/concepts/identity-and-access-management/index.md @@ -10,6 +10,7 @@ topics: children: - /identity-and-access-management-fundamentals - /enterprise-managed-users + - /user-offboarding contentType: concepts --- diff --git a/content/admin/concepts/identity-and-access-management/user-offboarding.md b/content/admin/concepts/identity-and-access-management/user-offboarding.md new file mode 100644 index 000000000000..8192af5e610f --- /dev/null +++ b/content/admin/concepts/identity-and-access-management/user-offboarding.md @@ -0,0 +1,62 @@ +--- +title: About user offboarding on {% data variables.product.prodname_ghe_cloud %} +shortTitle: User offboarding +intro: 'Manage access with confidence by understanding the recommended approach for offboarding users.' +versions: + ghec: '*' +contentType: concepts +topics: + - Accounts + - Authentication + - Enterprise + - Identity + - SSO +--- + +## How should I offboard users? + +The method for offboarding a user depends on your enterprise type: + +* **Personal accounts**: Remove the user from the enterprise account using the {% data variables.product.github %} UI or API. + * Outside collaborators are an exception to this process. They cannot be removed in the enterprise settings, and must be removed from each repository instead. +* **{% data variables.product.prodname_emus %}**: Suspend the user's account by removing the user from the {% data variables.product.github %} application in your identity provider. + * The user will show as suspended on your enterprise's "People" page. + * It is **not** possible to remove a {% data variables.enterprise.prodname_managed_user %} from the enterprise completely. + +For instructions, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise). + +## What happens when a user is offboarded? + +When you offboard a user by following the instructions linked above: + +* The offboarded user loses access to private and internal resources in your enterprise and organizations. +* The user's {% data variables.product.pat_generic_plural %}, SSH keys, and app authorizations can no longer be used to access your enterprise's and organizations' resources. Access to your resources is restored if the user is added back to the enterprise and relevant organizations. +* The user stops consuming licenses granted from your enterprise, including {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_copilot %} licenses. This change may not be reflected on your bill until the next billing cycle. +* If you use {% data variables.product.prodname_emus %}, the user will no longer be able to sign in to their {% data variables.enterprise.prodname_managed_user %}. +* If you use an enterprise with personal accounts, the user will still be able to sign in to their account and access other resources on {% data variables.product.github %}, even if you have enabled SAML SSO for your enterprise or organizations. This is because SSO only applies to your enterprise- or organization-owned resources. +* The user's commits, issues, pull requests, comments, and so on are retained in organization-owned repositories. However, the user's username is obfuscated if you use {% data variables.product.prodname_emus %}. + +For {% data variables.product.prodname_emus %}, you will find a more exhaustive list of effects of offboarding in [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/deprovisioning-and-reinstating-users). + +## What about removing a user from all organizations? + +Historically, some enterprises' offboarding processes have relied on removing a user from all organizations in the enterprise. However, in many cases, this approach is **not** sufficient for fully offboarding a user. + +### When is a user removed from the enterprise? + +If a user loses access to all organizations in an enterprise, the user is also removed from the enterprise account if **all** of the following things are true: + +* You use an enterprise with **personal accounts**. +* Your enterprise has **disabled** the policy described in [AUTOTITLE](/admin/enforcing-policies/enforcing-policies-for-your-enterprise/control-offboarding). +* The user does **not** have the enterprise owner or enterprise billing manager role. + +### What happens if a user remains in the enterprise? + +In **any** other situation, a user who loses access to all organizations remains in the enterprise. + +* If the user has the enterprise owner or enterprise billing manager role, they remain in the enterprise with this role. +* If the user doesn't have one of those roles, the user becomes an unaffiliated user. + +Users without organization membership cannot access internal repositories in the enterprise. They also do not consume a {% data variables.product.prodname_enterprise %} license, unless they meet another criterion listed in [AUTOTITLE](/billing/reference/github-license-users#organizations-on-github-enterprise-cloud). However, they keep other privileges including enterprise roles and {% data variables.product.prodname_copilot %} licenses granted directly from the enterprise. + +For more information, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/abilities-of-roles). diff --git a/content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md b/content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md index c06bc3fcebe1..532b29e8fc25 100644 --- a/content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md +++ b/content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md @@ -16,19 +16,27 @@ redirect_from: ## Currently unavailable features -The following features are currently unavailable on {% data variables.enterprise.data_residency_site %}. +The following features are currently unavailable on {% data variables.enterprise.data_residency_site %}, but may be planned for future development. | Feature | Details | More information | | :- | :- | :- | -| {% data variables.product.prodname_copilot_short %} Metrics API | Currently unavailable | [AUTOTITLE](/rest/copilot/copilot-metrics) | +| {% data variables.product.prodname_copilot_short %} Metrics API | Currently unavailable. | [AUTOTITLE](/rest/copilot/copilot-metrics) | | {% data variables.product.prodname_github_codespaces %} | Currently unavailable. | [AUTOTITLE](/codespaces/quickstart) | -| {% data variables.product.prodname_importer %} (the "Import repository" button on {% data variables.product.prodname_dotcom_the_website %}) | Instead, the **{% data variables.product.prodname_importer_proper_name %}** is available to migrate data. See [AUTOTITLE](/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer). | [AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer) | -| {% data variables.product.prodname_marketplace %} | Currently, apps from {% data variables.product.prodname_marketplace %} are unavailable. {% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %} may not function as expected. For more information, see [{% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %}](#github-actions-workflows-from-github-marketplace). | [AUTOTITLE](/search-github/searching-on-github/searching-github-marketplace)
[AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features) in the {% data variables.product.prodname_ghe_server %} documentation | -| {% data variables.product.prodname_github_models %} | Currently unavailable | [AUTOTITLE](/github-models/about-github-models) | | macOS runners for {% data variables.product.prodname_actions %} | Currently unavailable. | [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners) | | Maven and Gradle support for {% data variables.product.prodname_registry %} | Currently unavailable. | [AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) | -| {% data variables.product.prodname_spark_short %} | Unavailable due to dependency on {% data variables.product.prodname_github_codespaces %} | [AUTOTITLE](/copilot/concepts/spark) | -| Some features currently in {% data variables.release-phases.public_preview %} or {% data variables.release-phases.private_preview %} | Certain features that are in a preview phase on {% data variables.product.prodname_dotcom_the_website %} may not be available on {% data variables.enterprise.data_residency_site %} | | +| {% data variables.product.prodname_spark_short %} | Currently unavailable. | [AUTOTITLE](/copilot/concepts/spark) | +| {% data variables.product.prodname_marketplace %} | {% data variables.product.prodname_marketplace %}, as a means of searching for, purchasing, and directly installing apps and actions, is unavailable. Ecosystem apps and actions can still be discovered and installed from their source, but they may require modification to work on {% data variables.enterprise.data_residency_site %}. | [{% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %}](#github-actions-workflows-from-github-marketplace) | +| Certain features of {% data variables.product.prodname_github_connect %} | Although you can connect an enterprise on {% data variables.enterprise.data_residency_site %} to a {% data variables.product.prodname_ghe_server %} instance, certain features of {% data variables.product.prodname_github_connect %} are not available, including resolution of actions from {% data variables.product.prodname_dotcom_the_website %}. | [{% data variables.product.prodname_github_connect %}](#github-connect) | +| Some features currently in {% data variables.release-phases.public_preview %} or {% data variables.release-phases.private_preview %} | Certain features that are in a preview phase on {% data variables.product.prodname_dotcom_the_website %} may not be available on {% data variables.enterprise.data_residency_site %} until GA. | | + +## Permanently unavailable features + +By design, the following features are permanently unavailable on {% data variables.enterprise.data_residency_site %}. This is generally because they are not intended for large enterprises with strict compliance requirements. + +| Feature | Details | More information | +| :- | :- | :- | +| Features unavailable with {% data variables.product.prodname_emus %} | Because {% data variables.product.prodname_emus %} is the only option for identity management on {% data variables.enterprise.data_residency_site %}, features that are unavailable with {% data variables.product.prodname_emus %} on {% data variables.product.prodname_dotcom_the_website %} are also unavailable on {% data variables.enterprise.data_residency_site %}. Notably, these include gists and public repositories. | [AUTOTITLE](/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts) | +| {% data variables.product.prodname_importer %} (the "Import repository" button on {% data variables.product.prodname_dotcom_the_website %}) | Instead, the **{% data variables.product.prodname_importer_proper_name %}** is available to migrate data. See [AUTOTITLE](/migrations/using-github-enterprise-importer/understanding-github-enterprise-importer/about-github-enterprise-importer). | [AUTOTITLE](/migrations/importing-source-code/using-github-importer/about-github-importer) | ## Features that work differently diff --git a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/control-offboarding.md b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/control-offboarding.md index 7baede596346..ad0977cf895a 100644 --- a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/control-offboarding.md +++ b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/control-offboarding.md @@ -14,14 +14,17 @@ type: how_to By default, when a user loses access to all organizations in your enterprise, the user remains in your enterprise as an unaffiliated user. This can happen when you remove a user from organizations explicitly or remove an organization from your enterprise. -Unaffiliated users retain team membership, enterprise roles, and {% data variables.product.prodname_copilot %} licenses granted directly from the enterprise account. +Unaffiliated users retain enterprise-level team membership, enterprise roles, and {% data variables.product.prodname_copilot %} licenses granted directly from the enterprise account. -You can set a policy to instead remove users from the enterprise completely when they are removed from every organization. Removed users will lose all privileges and licenses granted from the enterprise. This is useful if you have an offboarding process that depends on removing users from organizations, for example using team synchronization from an identity provider. +You can set a policy to instead remove users from the enterprise completely when they are removed from every organization. Removed users will lose all privileges and licenses granted from the enterprise. This is useful if your enterprise offboarding process involves removing users from organizations, whether through organization-level SCIM deprovisioning, the GitHub web UI, or a non-SCIM REST API endpoint. For more information, see the link that corresponds to your use case: +- [AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-scim-for-organizations) +- [Revoking the user's membership](/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization#revoking-the-users-membership) +- [Remove organization membership for a user](/rest/orgs/members?apiVersion=2022-11-28#remove-organization-membership-for-a-user) in the REST API documentation. This policy: -* Applies regardless of how users lose their organization membership (through direct removal, a team, or removing an organization). -* Does **not** apply to users with the enterprise owner or enterprise billing manager role. These users remain in the enterprise regardless of their organization membership and the policy setting. +* Applies regardless of how users are removed from an organization. +* Does **not** apply to users with the enterprise owner or enterprise billing manager role. These users remain in the enterprise regardless of their organization membership and the policy setting. For more details on how to remove an enterprise owner or enterprise billing manager from the enterprise, see [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise#removing-a-member-from-your-enterprise) and [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise#removing-an-enterprise-administrator-from-your-enterprise-account). ## Setting the policy diff --git a/content/admin/guides.md b/content/admin/guides.md index 71d9467e8881..b39b6d2800f7 100644 --- a/content/admin/guides.md +++ b/content/admin/guides.md @@ -40,12 +40,12 @@ includeGuides: - /admin/configuring-settings/configuring-network-settings/changing-the-hostname-for-your-instance - /admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance - /admin/configuring-settings/configuring-network-settings/configuring-built-in-firewall-rules - - /admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance + - /code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-code-scanning-for-your-appliance - /admin/configuration/configuring-data-encryption-for-your-enterprise - - /admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance + - /code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-dependency-review-for-your-appliance - /admin/configuring-settings/configuring-network-settings/configuring-dns-nameservers - /admin/configuring-settings/configuring-user-applications-for-your-enterprise/configuring-rate-limits - - /admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance + - /code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-secret-scanning-for-your-appliance - /admin/configuring-settings/hardening-security-for-your-enterprise/configuring-tls - /admin/configuring-settings/configuring-user-applications-for-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise - /admin/configuring-settings/configuring-user-applications-for-your-enterprise/managing-github-mobile-for-your-enterprise diff --git a/content/admin/index.md b/content/admin/index.md index 96fe29cdba14..af3785d184dc 100644 --- a/content/admin/index.md +++ b/content/admin/index.md @@ -79,7 +79,7 @@ featuredLinks: guideCards: - '{% ifversion ghes %}/admin/managing-github-actions-for-your-enterprise/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server{% endif %}' - '{% ifversion ghes %}/admin/configuring-packages/getting-started-with-github-packages-for-your-enterprise{% endif %}' - - '{% ifversion ghes %}/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise{% endif %}' + - '{% ifversion ghes < 3.15 %}/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise{% endif %}' - '{% ifversion ghec %}/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise{% endif %}' - '{% ifversion ghec %}/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise{% endif %}' - '{% ifversion ghec %}/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise{% endif %}' diff --git a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise.md b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise.md index d635e25cf7cb..122e8300ff52 100644 --- a/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise.md @@ -1,7 +1,7 @@ --- title: Removing a member from your enterprise -intro: You can remove an enterprise member from an enterprise. -permissions: Enterprise owners can remove an enterprise member from an enterprise. +intro: Offboard users from an enterprise by following the recommended approach for your enterprise type. +permissions: Enterprise owners or IdP administrators versions: feature: remove-enterprise-members type: how_to @@ -12,23 +12,38 @@ redirect_from: - /admin/user-management/managing-users-in-your-enterprise/removing-a-member-from-your-enterprise --- -## About removal of enterprise members +The recommended offboarding approach for your enterprise depends on whether you use personal accounts or {% data variables.product.prodname_emus %}. To learn more about the effects of offboarding users, see [AUTOTITLE](/admin/concepts/identity-and-access-management/user-offboarding). -If your enterprise does not use {% data variables.product.prodname_emus %}, you can remove an enterprise member from your enterprise on {% data variables.product.prodname_dotcom_the_website %}. When you remove a member from your enterprise, the member is removed from all organizations owned by your enterprise and loses access to any {% data variables.copilot.copilot_business_short %} licenses assigned through those organizations. Removing a member from your enterprise also removes any of the member's administrative roles, such as the owner or billing manager roles. See [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise). +## Removing a member from an enterprise with personal accounts -If the enterprise member you're removing is the last owner of an organization owned by your enterprise, you will become an owner of that organization. - -If your enterprise or any of the organizations owned by your enterprise uses an identity provider (IdP) to manage organization membership, the member may be added back to the organization by the IdP. Make sure to also make any necessary changes in your IdP. +When you remove a member from your enterprise, the member is removed from all organizations owned by your enterprise and loses privileges granted through the enterprise, such as roles or licenses. -If your enterprise does use {% data variables.product.prodname_emus %}, you must remove the enterprise members through your identity provider (IdP) and the SCIM integration instead. See [AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users#about-organization-membership-management). - -## Removing a member from your enterprise +If the enterprise member you're removing is the last owner of an organization owned by your enterprise, you will become an owner of that organization. -> [!NOTE] -> If an enterprise member uses only {% data variables.product.prodname_ghe_server %}, and not {% data variables.product.prodname_ghe_cloud %}, you cannot remove the enterprise member this way. +>[!TIP] For automated offboarding, you can also remove users with the GraphQL API. See [AUTOTITLE](/graphql/reference/mutations#removeenterprisemember). -{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.access-enterprise-personal-accounts %} {% data reusables.enterprise-accounts.people-tab %} 1. To the right of the person you want to remove, select the {% octicon "kebab-horizontal" aria-label="Member settings" %} dropdown menu and click **Remove from enterprise**. ![Screenshot of a user in the list of enterprise members. A dropdown menu, labeled with a kebab icon, is highlighted with an orange outline.](/assets/images/help/business-accounts/remove-member.png) + +1. If your enterprise uses SAML SSO, or if any of your organizations use SAML and SCIM provisioning, **remove the user's access to {% data variables.product.github %} apps on your identity provider**. A user may be assigned access directly or via an IdP group assigned to the app: make sure to remove the user from both. For organizations with SCIM provisioning enabled, this should trigger a SCIM deprovisioning call, which ensures that the user's associated SAML and SCIM identities are fully removed from the organization. + + This is a good practice for security, and it also helps ensure that users cannot rejoin the organization using the SAML endpoint when SAML is configured at the organization level (see [AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on#adding-members-to-an-organization-using-saml-sso)). + +If the user is still listed as an enterprise member, this may be because the user is a member of a {% data variables.product.prodname_ghe_server %} instance that is linked to your enterprise via {% data variables.product.prodname_github_connect %}. You will need to remove this user from the {% data variables.product.prodname_ghe_server %} settings. + +## Suspending a user with {% data variables.product.prodname_emus %} + +With {% data variables.product.prodname_emus %}, including all enterprises on {% data variables.enterprise.data_residency_site %}, you manage user access from your identity provider (IdP). + +To offboard a user, you will suspend their account rather than removing them from the enterprise completely. + +1. Trigger a deprovisioning call for the user. For more information about the types of deprovisioning and the actions that trigger it for different integrations, see [AUTOTITLE](/admin/managing-iam/provisioning-user-accounts-with-scim/deprovisioning-and-reinstating-users#triggers-of-soft-deprovisioning). +1. Check if the user's organization membership is managed directly or managed by IdP groups. See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/viewing-people-in-your-enterprise#filtering-by-member-type-in-an-enterprise-with-managed-users). +1. If the user's organization membership is managed directly, remove the user manually from all organizations. See [AUTOTITLE](/organizations/managing-membership-in-your-organization/removing-a-member-from-your-organization). + +## Removing an outside collaborator + +In enterprises that use personal accounts, you cannot remove outside collaborators using the enterprise settings. However, an organization owner can remove an outside collaborator from all repositories in an organization. See [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/removing-an-outside-collaborator-from-an-organization-repository). diff --git a/content/admin/managing-code-security/index.md b/content/admin/managing-code-security/index.md index cd0a3494a912..1b4dc4ff87bc 100644 --- a/content/admin/managing-code-security/index.md +++ b/content/admin/managing-code-security/index.md @@ -10,8 +10,6 @@ topics: - Enterprise children: - /managing-github-advanced-security-for-your-enterprise - - /managing-supply-chain-security-for-your-enterprise - - /securing-your-enterprise redirect_from: - /admin/code-security --- diff --git a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/index.md b/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/index.md index 59b719622f0f..2f9a50cbf329 100644 --- a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/index.md +++ b/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/index.md @@ -1,7 +1,7 @@ --- -title: '{% ifversion ghes %}Setting up {% data variables.product.prodname_GHAS %} features on your appliance{% else %}Configuring infrastructure for {% data variables.product.prodname_GHAS %} features{% endif %}' -shortTitle: '{% ifversion ghes %}Set up{% else %}Configure{% endif %} {% data variables.product.prodname_GHAS %}' -intro: 'You can {% ifversion ghes %}set up{% else %}configure{% endif %} {% data variables.product.prodname_AS %}{% ifversion ghas-products %} products{% endif %} to suit your enterprise''s needs.' +title: 'Setting up {% data variables.product.prodname_GHAS %} features on your appliance' +shortTitle: 'Set up {% data variables.product.prodname_GHAS %}' +intro: You can set up {% data variables.product.prodname_AS %} to suit your enterprise's needs. allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.ghas-ghec %}' redirect_from: @@ -10,14 +10,9 @@ redirect_from: - /admin/advanced-security - /admin/code-security/managing-github-advanced-security-for-your-enterprise versions: - ghec: '*' - ghes: '*' + ghes: '<= 3.15' topics: - Enterprise children: - - /enabling-github-advanced-security-for-your-enterprise - /managing-github-advanced-security-features-for-your-enterprise - - /configuring-code-scanning-for-your-appliance - - /configuring-dependency-review-for-your-appliance - - /configuring-secret-scanning-for-your-appliance --- diff --git a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/index.md b/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/index.md deleted file mode 100644 index ab81395a6bcf..000000000000 --- a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing supply chain security for your enterprise -shortTitle: Supply chain security -intro: 'You can visualize, maintain, and secure the dependencies in your developers'' software supply chain.' -versions: - ghes: '*' -topics: - - Enterprise -children: - - /about-supply-chain-security-for-your-enterprise - - /enabling-the-dependency-graph-for-your-enterprise - - /viewing-the-vulnerability-data-for-your-enterprise - - /configuring-dependabot-to-work-with-limited-internet-access -redirect_from: - - /admin/code-security/managing-supply-chain-security-for-your-enterprise ---- - diff --git a/content/admin/managing-code-security/securing-your-enterprise/index.md b/content/admin/managing-code-security/securing-your-enterprise/index.md deleted file mode 100644 index 600ed42b44cb..000000000000 --- a/content/admin/managing-code-security/securing-your-enterprise/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Securing your enterprise -shortTitle: Securing your enterprise -intro: '{% ifversion security-configurations-cloud %}Enable the {% data variables.product.prodname_github_security_configuration %} or c{% elsif security-configurations-ghes-only %}C{% endif %}reate and apply {% data variables.product.prodname_custom_security_configurations %} to quickly secure your enterprise.' -product: '{% data reusables.gated-features.ghas-ghec %}' -versions: - feature: security-configuration-enterprise-level -topics: - - Alerts - - Advanced Security - - Dependency graph - - Dependabot - - Repositories -children: - - /about-security-configurations - - /applying-the-github-recommended-security-configuration-to-your-enterprise - - /creating-a-custom-security-configuration-for-your-enterprise - - /applying-a-custom-security-configuration-to-your-enterprise - - /configuring-additional-secret-scanning-settings-for-your-enterprise - - /editing-a-custom-security-configuration - - /deleting-a-custom-security-configuration ---- diff --git a/content/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes.md b/content/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes.md index 1e90c192a404..2f7a2718ab44 100644 --- a/content/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes.md +++ b/content/admin/managing-iam/provisioning-user-accounts-with-scim/user-provisioning-with-scim-on-ghes.md @@ -45,6 +45,8 @@ The following IdPs are partner IdPs. They offer an application that you can use When you use a single partner IdP for both authentication and provisioning, {% data variables.product.company_short %} provides support for the application on the partner IdP and the IdP's integration with {% data variables.product.prodname_dotcom %}. Support for PingFederate is in {% data variables.release-phases.public_preview %}. +We do not have a supported partner application when using Entra ID for Azure Government. + ### Other identity management systems If you cannot use a single partner IdP for both authentication and provisioning, you can use another identity management system or combination of systems. The system must: diff --git a/content/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md b/content/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md index 909197f39f8d..989289f5d230 100644 --- a/content/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md +++ b/content/admin/managing-iam/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise.md @@ -73,6 +73,8 @@ For more information about connecting Microsoft Entra ID (previously known as Az For more information about connecting Entra ID to your enterprise, see [Tutorial: Microsoft Entra SSO integration with GitHub Enterprise Server](https://learn.microsoft.com/en-us/entra/identity/saas-apps/github-ae-tutorial) in Microsoft Docs. +We do not have a supported partner application when using Entra ID for Azure Government. + ## Username considerations with SAML {% data reusables.enterprise_user_management.consider-usernames-for-external-authentication %} For more information, see [AUTOTITLE](/admin/identity-and-access-management/managing-iam-for-your-enterprise/username-considerations-for-external-authentication). diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md index c652ad0983bc..51016f4acfb0 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/displaying-ip-addresses-in-the-audit-log-for-your-enterprise.md @@ -38,6 +38,8 @@ If members of your enterprise access {% data variables.location.product_location {% data variables.product.github %} does not display IP addresses in the audit log for `api.request` events that do not have repository context, such as requests triggered by GraphQL or requests to endpoints that reference only a user or organization. +{% data variables.product.github %} does not display IP addresses in the audit log for certain events where the actor recorded in the audit log differs from the person or system that performed the action. {% data variables.product.github %} also does not display IP addresses when a bot or automated system performs the action. + ## Enabling display of IP addresses in the audit log {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/admin/monitoring-and-managing-your-instance/index.md b/content/admin/monitoring-and-managing-your-instance/index.md index 0bafdd26d4b8..59d00719c48a 100644 --- a/content/admin/monitoring-and-managing-your-instance/index.md +++ b/content/admin/monitoring-and-managing-your-instance/index.md @@ -15,5 +15,6 @@ children: - /configuring-clustering - /configuring-high-availability - /caching-repositories + - /multiple-data-disks shortTitle: 'Monitor and manage your instance' --- diff --git a/content/admin/monitoring-and-managing-your-instance/multiple-data-disks/configuring-multiple-data-disks.md b/content/admin/monitoring-and-managing-your-instance/multiple-data-disks/configuring-multiple-data-disks.md new file mode 100644 index 000000000000..b15f3bccd687 --- /dev/null +++ b/content/admin/monitoring-and-managing-your-instance/multiple-data-disks/configuring-multiple-data-disks.md @@ -0,0 +1,222 @@ +--- +title: Configuring multiple data disks +product: '{% data variables.product.prodname_ghe_server %}' +intro: 'You can configure additional data disks and use them to host MySQL and repositories data.' +versions: + ghes: '>= 3.19' +type: overview +topics: + - Enterprise +--- + +> [!NOTE] +> The ability to configure and use multiple data disks is in {% data variables.release-phases.public_preview %} and subject to change. We would love to hear your feedback on the preview. You can share it with your customer success team, or leave a comment in the [community discussion post](https://github.com/orgs/community/discussions/181173). Our preferred option is sharing your feedback with your customer success team. + +## Why introduce more disks to the GHES instance? + +* Improved resource distribution: + * Different services have unique disk requirements. + * MySQL is mostly latency and IOPS sensitive. + * Some resources (such as repositories) don't benefit as much from expensive block storage. +* Maximized VM limits: + * A single disk is often not able to max out the limitations of an instance. + * From a cost perspective, it is usually not feasible or worthwhile to run everything on the most expensive or fastest storage. +* Clearer separation between resource allocation and services: + * Resources can be allocated in a targeted way, preventing critical services from being starved. +* Scaling: + * Customers on both standalone and high-availability topologies can scale out as needed. + +## Constraints + +* Multi-data disks are only supported on Standalone and High Availability (HA) topologies. +* Once multiple data disks are configured in a deployment, this change cannot be undone for that deployment. +* Setting up multi-data disks and migrating data typically requires some downtime. + * You can minimize this by configuring a replica with multi-data disks, replicating data from the primary, and then failing over to the replica. + * If you are adding multi-data disks directly to the primary, expect a much longer downtime. +* During the public preview, multi-data disks should be used only in non-production environments. +* It is not recommended to migrate MySQL and repositories to the same disk. +* Currently, only MySQL and repositories can be migrated to additional disks. + +## Resource recommendations + +If you add disks that are as fast or faster than your current ones, you should see improved performance. Storage devices are typically measured by IOPS (Input/Output Operations Per Second), throughput, and latency. For MySQL, we recommend using a disk with lower latency and higher IOPS than your existing data disk. For repositories, choose a disk with higher IOPS and throughput than your current data disk. + +In high availability setups, it is best to use multi-data disks on both the primary and all replicas. Mixing configurations, where the primary has multi-data disks but the replica does not, is not recommended. + +## Setting up multiple data disks and data paths + +### Prerequisites + +* We recommend taking a recent backup of your data before getting started. +* Create a test environment to try the feature. + * During the public preview, we recommend **only** using the feature in a test environment. + * Once the feature becomes generally available, we recommend testing the feature in a non-production environment before using it in production. + +### Instructions + +1. You can perform fresh installation of GHES or use an existing GHES instance. It should have the data disk configured at `/data/user`. + +1. Once `/data/user` is set up, add additional block storage devices to the instance. + + Currently, `ghe-storage-find` chooses the first block storage for setting up `/data/user` based on the alphabetical order of the block storage path. This happens on the first boot of the GHES appliance. + + To have more control over which disk is used for `/data/user`, it is better to complete the initialization process with only one disk attached initially. + +1. Initialize the multi-disk setup using the new block storage devices. To initialize multi-disk support, run `ghe-storage-multi-disk init`. On every reboot, the `ghe-multi-disk.service` will automatically remount the existing data disks at the correct paths. + + ``` shell copy + /usr/local/share/enterprise/ghe-storage-multi-disk init /dev/nvme2n1 db + ``` + + ``` shell copy + /usr/local/share/enterprise/ghe-storage-multi-disk init /dev/nvme3n1 git + ``` + + Please note that `/dev/nvme2n1` and `/dev/nvme3n1` are example paths only. They might not match the paths on your system. Similarly, `db` and `git` are examples. You may choose different names. + +1. Switch to maintenance mode. + + ``` shell copy + gh es maintenance set --enabled true + ``` + +1. Migrate your desired data paths. + + To migrate MySQL: + + ``` shell copy + /usr/local/share/enterprise/ghe-storage-migrate-mysql db + ``` + + To migrate repositories: + + ``` shell copy + /usr/local/share/enterprise/ghe-storage-migrate-repositories git + ``` + +1. Exit maintenance mode. + + ``` shell copy + gh es maintenance set --enabled false + ``` + +1. Test the instance for a period of time to make sure everything works as expected. +1. **Only after sufficient testing**, remove `/data/user/mysql-backup` and `/data/user/repositories-backup`. + + Keeping these folders during testing allows you to roll back in an emergency. After sufficient testing, you should remove those backup folders to free up space. + +### Guidance for high availability configurations + +The following guidance helps reduce downtime in high availability (HA) topologies. If you are using a standalone topology, we do not have similar additional guidance at this time. + +For HA topologies, the best approach is to stand up a new replica with multiple data disks configured, replicate data from the primary, and then promote the replica to primary. Migrating data to additional disks on the current primary is not recommended, as this process can lead to significant downtime. + +1. Set up a new HA replica with better disks. + + To plan for the data migration, use `du -sh /data/user/mysql` and `du -sh /data/user/repositories` on the primary to calculate disk space requirements for the new replica. + +1. Set up multi-disk on the new HA replica. +1. Allow the HA primary to replicate to the replica. +1. Follow the failover sequence as documented in [AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-high-availability/initiating-a-failover-to-your-replica-appliance). + +While the replication process can take a long time, the advantage is that it runs in the background, so the actual disruption from maintenance mode is dramatically reduced. + +## Example: configuring two additional disks + +This example demonstrates the required commands and outputs for disk initialization and data migration. Specifically, `/data/user/mysql` is migrated to `/data/multi-disk/db/mysql`, and `/data/user/repositories` is migrated to `/data/multi-disk/git/repositories`. + +```shell +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-multi-disk status +Checking system status... + +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-multi-disk info +Dumping disk status and information... + +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-multi-disk init /dev/nvme2n1 db +Starting initialization sequence for /dev/nvme2n1 at /data/multi-disk/db... + +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-multi-disk init /dev/nvme3n1 git +Starting initialization sequence for /dev/nvme3n1 at /data/multi-disk/git... + +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-migrate-mysql db +Start mysql migration to /data/multi-disk/db... +Running checks.. +Error: maintenance mode must be enabled before being able to proceed. +ERROR: Last Command: return 1 LINE: 36 ghe-storage-migrate-mysql +Script exited with exit code: 1 + +admin@ghe-test-primary:~$ ghe-maintenance -s + +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-migrate-mysql db +Start repository migration to /data/multi-disk/db... +Success: /data/user/mysql moved to /data/multi-disk/db/mysql +Script exited with exit code: 0 + +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-migrate-repositories git +Start repository migration to /data/multi-disk/git... +Success: /data/user/repositories moved to /data/multi-disk/git +Script exited with exit code: 0 + +admin@ghe-test-primary:~$ ghe-maintenance -u + +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-multi-disk status +Checking system status... +/data/user/mysql -> /data/multi-disk/db/mysql is correctly symlinked. +Repositories migration was detected... +/data/user/repositories -> /data/multi-disk/git/repositories is correctly symlinked. + +admin@ghe-test-primary:~$ /usr/local/share/enterprise/ghe-storage-multi-disk info +Dumping disk status and information... +# Multi disk configuration /data/user/multi-disk-config: +DISK_DB="lvm" +DISK_GIT="lvm" +MYSQL_MIGRATION_PATH="/data/multi-disk/db/mysql" +REPOSITORIES_MIGRATION_PATH="/data/multi-disk/git/repositories" + +admin@ghe-test-primary:~$ ls /var/log/multi-disk/ +ghe-storage-init-db.log ghe-storage-init-git.log ghe-storage-migrate-mysql.log ghe-storage-migrate-repositories.log + +``` + +## Hygiene checks + +Both `/usr/local/share/enterprise/ghe-storage-multi-disk status` and `/usr/local/share/enterprise/ghe-storage-multi-disk info` are helpful for checking your setup. + +To view the current multi-disk configuration, use: + +```shell +$ cat /data/user/multi-disk-config +DISK_DB="lvm" +DISK_GIT="lvm" +MYSQL_MIGRATION_PATH="/data/multi-disk/db/mysql" +REPOSITORIES_MIGRATION_PATH="/data/multi-disk/git/repositories" +``` + +To review multi-disk logs, including disk initialization and migration events, run: + +```shell +$ ls -l /var/log/multi-disk/ +total 56 +-rw-r--r-- 1 root root 2398 Mar 3 13:22 ghe-storage-init-db.log +-rw-r--r-- 1 root root 2497 Mar 3 13:23 ghe-storage-init-git.log +-rw-r--r-- 1 root root 2201 Mar 3 13:28 ghe-storage-migrate-mysql.log +-rw-r--r-- 1 root root 37296 Mar 3 13:30 ghe-storage-migrate-repositories.log +``` + +## Commands for managing multiple disks + +These commands make it possible to add multiple disks and migrate specific services or folder paths to those disks. The original folder paths are maintained and kept static. Other services are unaware that anything has changed. The static folder paths are symlinked to the newly migrated paths. + +The commands include: + +* ghe-storage-multi-disk + * `status` + * `init` + * `info` + * `mount` + * `start-services` (only recommended for debugging) + * `stop-services` (only recommended for debugging) +* ghe-storage-migrate-repositories + * Migrates `/data/user/repositories` to any disk path created using `ghe-storage-multi-disk init`. +* ghe-storage-migrate-mysql + * Migrates `/data/user/mysql` to any disk path created using `ghe-storage-multi-disk init`. diff --git a/content/admin/monitoring-and-managing-your-instance/multiple-data-disks/index.md b/content/admin/monitoring-and-managing-your-instance/multiple-data-disks/index.md new file mode 100644 index 000000000000..f96a3755812c --- /dev/null +++ b/content/admin/monitoring-and-managing-your-instance/multiple-data-disks/index.md @@ -0,0 +1,10 @@ +--- +title: Multiple data disks +intro: 'You can configure additional data disks and use them to host MySQL and repositories data.' +versions: + ghes: '>= 3.19' +topics: + - Enterprise +children: + - /configuring-multiple-data-disks +--- diff --git a/content/admin/overview/establishing-a-governance-framework-for-your-enterprise.md b/content/admin/overview/establishing-a-governance-framework-for-your-enterprise.md index 6203f9f24848..2e357e0e12a6 100644 --- a/content/admin/overview/establishing-a-governance-framework-for-your-enterprise.md +++ b/content/admin/overview/establishing-a-governance-framework-for-your-enterprise.md @@ -94,7 +94,7 @@ With **{% data variables.product.prodname_secret_scanning %}**, you can scan you To learn more, see [AUTOTITLE](/code-security/secret-scanning/introduction/about-secret-scanning). -{% data variables.product.prodname_secret_scanning_caps %} can be enabled at the enterprise, organization, and repository level. See {% ifversion ghes %}[AUTOTITLE](/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance){% elsif ghec %}[AUTOTITLE](/admin/managing-code-security/securing-your-enterprise/about-security-configurations){% endif %} for enablement at enterprise level. +{% data variables.product.prodname_secret_scanning_caps %} can be enabled at the enterprise, organization, and repository level. See {% ifversion ghes %}[AUTOTITLE](/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance){% elsif ghec %}[AUTOTITLE](/code-security/concepts/security-at-scale/about-security-configurations){% endif %} for enablement at enterprise level. ### Push protection @@ -137,4 +137,4 @@ Many industries have regulations that require regular security assessments and v To get started quickly with {% data variables.product.prodname_code_scanning %}, we recommend you use the default setup. See [AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning). -{% data variables.product.prodname_code_scanning_caps %} can be enabled at the enterprise, organization, and repository level. See {% ifversion ghes %}[AUTOTITLE](/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance){% elsif ghec %}[AUTOTITLE](/admin/managing-code-security/securing-your-enterprise/about-security-configurations){% endif %} for enablement at enterprise level. +{% data variables.product.prodname_code_scanning_caps %} can be enabled at the enterprise, organization, and repository level. See {% ifversion ghes %}[AUTOTITLE](/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance){% elsif ghec %}[AUTOTITLE](/code-security/concepts/security-at-scale/about-security-configurations){% endif %} for enablement at enterprise level. diff --git a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md index 0da4f95c8461..9cc6c1285c71 100644 --- a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md +++ b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md @@ -144,6 +144,7 @@ Below are some example URLs that generate the tokens we see most often: * [GitHub Models access](https://github.com/settings/personal-access-tokens/new?name=GitHub+Models+token&description=Used%20to%20call%20GitHub%20Models%20APIs%20to%20easily%20run%20LLMs%3A%20https%3A%2F%2Fdocs.github.com%2Fgithub-models%2Fquickstart%23step-2-make-an-api-call&user_models=read) * [Update code and open a PR](https://github.com/settings/personal-access-tokens/new?name=Core-loop+token&description=Write%20code%20and%20push%20it%20to%20main%21%20Includes%20permission%20to%20edit%20workflow%20files%20for%20Actions%20-%20remove%20%60workflows%3Awrite%60%20if%20you%20don%27t%20need%20to%20do%20that&contents=write&pull_requests=write&workflows=write) * [Manage Copilot licenses in an organization](https://github.com/settings/personal-access-tokens/new?name=Core-loop+token&description=Enable%20or%20disable%20copilot%20access%20for%20users%20with%20the%20Seat%20Management%20APIs%3A%20https%3A%2F%2Fdocs.github.com%2Frest%2Fcopilot%2Fcopilot-user-management%0ABe%20sure%20to%20select%20an%20organization%20for%20your%20resource%20owner%20below%21&organization_copilot_seat_management=write) +* [Make Copilot requests](https://github.com/settings/personal-access-tokens/new?name=Copilot+requests+token&description=Make%20Copilot%20API%20requests%20on%20behalf%20of%20the%20user%2C%20consuming%20premium%20requests%3A%20https%3A%2F%2Fdocs.github.com%2Fcopilot%2Fconcepts%2Fbilling%2Fcopilot-requests&copilot_requests=write) #### Supported Query Parameters @@ -173,6 +174,7 @@ Account permissions are only used when the current user is set as the resource o | `codespaces_user_secrets` | Codespaces user secrets | `read`, `write` | | `copilot_messages` | Copilot Chat | `read` | | `copilot_editor_context` | Copilot Editor Context | `read` | +| `copilot_requests` | Copilot requests | `write` | | `emails` | Email addresses | `read`, `write` | | `user_events` | Events | `read` | | `followers` | Followers | `read`, `write` | @@ -189,6 +191,12 @@ Account permissions are only used when the current user is set as the resource o | `starring` | Starring | `read`, `write` | | `watching` | Watching | `read`, `write` | +{% ifversion copilot %} + +> [!NOTE] +> The `copilot_requests` permission enables making {% data variables.product.prodname_copilot_short %} requests for the given user, which count towards the user's premium request allowance or are charged to overage billing if the allowance is exceeded. For more information about {% data variables.product.prodname_copilot_short %} requests and billing, see [AUTOTITLE](/copilot/concepts/billing/copilot-requests). + +{% endif %} ##### Repository Permissions Repository permissions work for both user and organization resource owners. diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md index df82a8e5e0ed..25a1bfec7649 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md @@ -20,7 +20,13 @@ shortTitle: Configure 2FA recovery --- In addition to securely storing your two-factor authentication (2FA) recovery codes, we strongly recommend configuring two or more authentication methods to avoid losing access to your account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key). -## Downloading your two-factor authentication recovery codes +As well as configuring authentication methods, we'd also strongly suggest setting up some 2FA recovery methods which may be helpful if you were ever to lose your authentication methods. Recovery methods available to be configured include: the account's recovery codes file, SSH key(s), {% data variables.product.pat_generic_caps_plural %} (PATs) and verified device(s). + +## About the recovery codes file + +The recovery codes file includes one-time codes for account recovery if you can’t access your two-factor authentication method. You should download and store these codes securely. + +### Downloading your two-factor authentication recovery codes {% data reusables.two_fa.about-recovery-codes %} You can also download your recovery codes at any point after enabling two-factor authentication. @@ -36,7 +42,7 @@ If you generate new recovery codes or disable and re-enable 2FA, the recovery co * To save a hard copy of your recovery codes, click **Print**. * To copy your recovery codes for storage in a password manager, click **Copy**. -## Generating a new set of recovery codes +### Generating a new set of recovery codes Once you use a recovery code to regain access to your account, it cannot be reused. If you've used all 16 recovery codes, you can generate another list of codes. Generating a new set of recovery codes will invalidate any codes you previously generated. @@ -45,7 +51,7 @@ Once you use a recovery code to regain access to your account, it cannot be reus {% data reusables.two_fa.show-recovery-codes %} 1. Under "Generate new recovery codes", click **Generate new recovery codes**. -## Configuring backups for your time-based one-time password (TOTP) app +### Configuring backups for your time-based one-time password (TOTP) app Most TOTP apps support backups. If you lose access to your authentication device, you can use your TOTP app backup to access your authentication method and account credentials on a different authentication device, ensuring continued access to your 2FA-enabled account. @@ -55,6 +61,20 @@ The process of configuring backups is different for each TOTP app. For some exam * [Google Authenticator](https://security.googleblog.com/2023/04/google-authenticator-now-supports.html) * [Microsoft Authenticator](https://support.microsoft.com/en-us/account-billing/back-up-and-recover-account-credentials-in-the-authenticator-app-bb939936-7a8d-4e88-bc43-49bc1a700a40) +## SSH keys + +SSH keys can be configured and used for account recovery if ever required. To set up 1 or more SSH keys that can be used to recover access to your 2FA-enabled account, see [AUTOTITLE](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). + +> [!NOTE] +> Be sure to choose 'authentication' as the key's type during this process. + +## {% data variables.product.pat_generic_caps_plural %} + +{% data variables.product.pat_generic_caps_plural %} (PATs) can be configured and used for recovery if ever needed. To set up 1 or more PATs that can be used to recover access, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic). + +> [!NOTE] +> Be sure to choose 'repo' when choosing the 'scopes' available during this process. + ## Further reading * [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication) diff --git a/content/billing/concepts/product-billing/github-actions.md b/content/billing/concepts/product-billing/github-actions.md index 2a1d7b6841ee..b32451888bf0 100644 --- a/content/billing/concepts/product-billing/github-actions.md +++ b/content/billing/concepts/product-billing/github-actions.md @@ -130,14 +130,11 @@ For full details of minute costs for different types of runners, see [AUTOTITLE] ### Example minutes cost calculation for {% data variables.product.github %}-hosted runners -For example, if your organization uses {% data variables.product.prodname_team %}, using 5,000 minutes beyond the included quota on {% data variables.product.github %}-hosted runners would have a total actions minutes cost of $56 USD currently, if you used baseline Linux and Windows runners. +For example, if your organization uses {% data variables.product.prodname_team %}, using 5,000 minutes beyond the included quota on {% data variables.product.github %}-hosted runners would have a total actions minutes cost of $38 USD currently, if you used baseline Linux and Windows runners. -* 5,000 (3,000 Linux and 2,000 Windows) minutes = $56 USD ($24 USD + $32 USD). - * 3,000 Linux minutes at $0.008 USD per minute = $24 USD. - * 2,000 Windows minutes at $0.016 USD per minute = $32 USD. - ->[!TIP] -> The cost for these runners will reduce from January 1, 2026. +* 5,000 (3,000 Linux and 2,000 Windows) minutes = $38 USD ($18 USD + $20 USD). + * 3,000 Linux minutes at $0.006 USD per minute = $18 USD. + * 2,000 Windows minutes at $0.010 USD per minute = $20 USD. ### Example artifact storage cost calculation diff --git a/content/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md b/content/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md index 1690daa42872..337b1e280b60 100644 --- a/content/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md +++ b/content/billing/how-tos/manage-plan-and-licenses/view-enterprise-usage.md @@ -86,8 +86,8 @@ If your {% data variables.product.github %} license includes {% data variables.v * Under "User licenses", view your total licenses, number of consumed licenses, and your subscription expiration date. * To view details for license usage or download a JSON file with license details, click **View users** or **Export license usage**. -* Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses. -* If you have purchased {% data variables.product.prodname_AS %}, you can review your total licenses used as well as a per-organization breakdown of active committers. See [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise). +* Review your current {% data variables.product.prodname_enterprise %} license, as well as consumed and available user licenses.{% ifversion ghes < 3.15 %} +* If you have purchased {% data variables.product.prodname_AS %}, you can review your total licenses used as well as a per-organization breakdown of active committers. See [AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise).{% endif %} ## Reporting license information using the REST API diff --git a/content/billing/tutorials/estimate-spending.md b/content/billing/how-tos/products/estimate-spending.md similarity index 91% rename from content/billing/tutorials/estimate-spending.md rename to content/billing/how-tos/products/estimate-spending.md index 39892e8c77b2..bd26270d401a 100644 --- a/content/billing/tutorials/estimate-spending.md +++ b/content/billing/how-tos/products/estimate-spending.md @@ -1,6 +1,8 @@ --- -title: Estimating spending -intro: Use the new billing platform to understand where your spending is trending based on the usage across products. +title: Viewing and estimating your spending +shortTitle: View and estimate spending +allowTitleToDifferFromFilename: true +intro: 'View current usage and spending trends across paid {% data variables.product.github %} products, so you can estimate costs and make informed budgeting decisions.' versions: feature: enhanced-billing-platform redirect_from: @@ -8,21 +10,21 @@ redirect_from: - /billing/using-the-new-billing-platform/estimating-spending-for-your-enterprise - /billing/using-the-new-billing-platform/estimating-spending - /billing/managing-your-billing/estimating-spending + - /billing/tutorials/estimate-spending topics: - Billing - Enterprise - Team permissions: '{% data reusables.permissions.enhanced-billing-platform %}' product: '{% data reusables.billing.enhanced-billing-platform-product %}' -shortTitle: Estimate spending -contentType: tutorials +contentType: how-tos --- The new billing platform provides a high-level view of your spending trends based on the usage across products. You can use this information to estimate your spending and make informed decisions about your budget. {% ifversion fpt %} -## Viewing your spending for your personal account +## Viewing spending for your personal account {% data reusables.user-settings.access_settings %} 1. In the "Access" section of the sidebar, click **{% octicon "credit-card" aria-hidden="true" aria-label="credit-card" %} Billing & Licensing**. @@ -41,7 +43,7 @@ At the top of the page, under "Next payment due", you can see the date of your n {% endif %} -## Viewing your spending for your {% data variables.enterprise.enterprise_or_org %} +## Viewing spending for your {% data variables.enterprise.enterprise_or_org %} The "Overview" page provides a high-level view of your spending and budgets. diff --git a/content/billing/how-tos/products/index.md b/content/billing/how-tos/products/index.md index b25806e3de3c..2716a0b94d57 100644 --- a/content/billing/how-tos/products/index.md +++ b/content/billing/how-tos/products/index.md @@ -26,8 +26,10 @@ children: - /view-productlicense-use - /download-license-use - /buy-advanced-security + - /estimate-spending - /use-cost-centers - /manage-ghas-licenses - /view-ghas-committers contentType: how-tos --- + diff --git a/content/billing/reference/actions-runner-pricing.md b/content/billing/reference/actions-runner-pricing.md index 800b326ff1f1..c6adba7c0ae5 100644 --- a/content/billing/reference/actions-runner-pricing.md +++ b/content/billing/reference/actions-runner-pricing.md @@ -20,47 +20,47 @@ redirect_from: ## x64-powered {% data variables.actions.hosted_runners %} -| Operating system | Billing SKU | Per-minute rate until January 1, 2026 (USD) | January 1, 2026 onward | Percentage change | -| --------------------- | -------------------------- | ----------------- |---------------|------| -| Linux Advanced 2-core | `linux_2_core_advanced` | $0.008 | $0.006 | -25% | -| Linux 4-core | `linux_4_core` | $0.016 | $0.012 | -25% | -| Linux 8-core | `linux_8_core` | $0.032 | $0.022 | -31% | -| Linux 16-core | `linux_16_core` | $0.064 | $0.042 | -34% | -| Linux 32-core | `linux_32_core` | $0.128 | $0.082 | -36% | -| Linux 64-core | `linux_64_core` | $0.256 | $0.162 | -37% | -| Linux 96-core | `linux_96_core` | $0.384 | $0.252 | -34% | -| Windows 4-core | `windows_4_core` | $0.032 | $0.022 | -31% | -| Windows 8-core | `windows_8_core` | $0.064 | $0.042 | -34% | -| Windows 16-core | `windows_16_core` | $0.128 | $0.082 | -36% | -| Windows 32-core | `windows_32_core` | $0.256 | $0.162 | -37% | -| Windows 64-core | `windows_64_core` | $0.512 | $0.322 | -37% | -| Windows 96-core | `windows_96_core` | $0.768 | $0.552 | -28% | -| macOS 12-core | `macos_l` | $0.120 | $0.077 | -36% | +| Operating system | Billing SKU | Per-minute rate (USD) | +| --------------------- | -------------------------- | --------------------- | +| Linux Advanced 2-core | `linux_2_core_advanced` | $0.006 | +| Linux 4-core | `linux_4_core` | $0.012 | +| Linux 8-core | `linux_8_core` | $0.022 | +| Linux 16-core | `linux_16_core` | $0.042 | +| Linux 32-core | `linux_32_core` | $0.082 | +| Linux 64-core | `linux_64_core` | $0.162 | +| Linux 96-core | `linux_96_core` | $0.252 | +| Windows 4-core | `windows_4_core` | $0.022 | +| Windows 8-core | `windows_8_core` | $0.042 | +| Windows 16-core | `windows_16_core` | $0.082 | +| Windows 32-core | `windows_32_core` | $0.162 | +| Windows 64-core | `windows_64_core` | $0.322 | +| Windows 96-core | `windows_96_core` | $0.552 | +| macOS 12-core | `macos_l` | $0.077 | ## arm64-powered {% data variables.actions.hosted_runners %} -| Operating system | Billing SKU | Per-minute rate until January 1, 2026 (USD) | January 1, 2026 onward | Percentage change | -| --------------------- | --------------------- | ----------------- |---------------|------| -| Linux 2-core | `linux_2_core_arm` | $0.005 | $0.005 |     0% | -| Linux 4-core | `linux_4_core_arm` | $0.010 | $0.008 | -20% | -| Linux 8-core | `linux_8_core_arm` | $0.020 | $0.014 | -30% | -| Linux 16-core | `linux_16_core_arm` | $0.040 | $0.026 | -35% | -| Linux 32-core | `linux_32_core_arm` | $0.080 | $0.050 | -38% | -| Linux 64-core | `linux_64_core_arm` | $0.160 | $0.098 | -39% | -| Windows 2-core | `windows_2_core_arm` | $0.010 | $0.008 | -20% | -| Windows 4-core | `windows_4_core_arm` | $0.020 | $0.014 | -30% | -| Windows 8-core | `windows_8_core_arm` | $0.040 | $0.026 | -35% | -| Windows 16-core | `windows_16_core_arm` | $0.080 | $0.050 | -38% | -| Windows 32-core | `windows_32_core_arm` | $0.160 | $0.098 | -39% | -| Windows 64-core | `windows_64_core_arm` | $0.320 | $0.194 | -39% | -| macOS 5-core (M2 Pro) | `macos_xl` | $0.160 | $0.102 | -36% | +| Operating system | Billing SKU | Per-minute rate (USD) | +| --------------------- | --------------------- | --------------------- | +| Linux 2-core | `linux_2_core_arm` | $0.005 | +| Linux 4-core | `linux_4_core_arm` | $0.008 | +| Linux 8-core | `linux_8_core_arm` | $0.014 | +| Linux 16-core | `linux_16_core_arm` | $0.026 | +| Linux 32-core | `linux_32_core_arm` | $0.050 | +| Linux 64-core | `linux_64_core_arm` | $0.098 | +| Windows 2-core | `windows_2_core_arm` | $0.008 | +| Windows 4-core | `windows_4_core_arm` | $0.014 | +| Windows 8-core | `windows_8_core_arm` | $0.026 | +| Windows 16-core | `windows_16_core_arm` | $0.050 | +| Windows 32-core | `windows_32_core_arm` | $0.098 | +| Windows 64-core | `windows_64_core_arm` | $0.194 | +| macOS 5-core (M2 Pro) | `macos_xl` | $0.102 | ## GPU-powered {% data variables.actions.hosted_runners %} -| Operating system | Billing SKU | Per-minute rate until January 1, 2026 (USD) | January 1, 2026 onward | Percentage change | -| ------------------ | ------------------------ | ------------- |------------|------| -| Linux 4-core | `linux_4_core_gpu` | $0.070 | $0.052 | -26% | -| Windows 4-core | `windows_4_core_gpu` | $0.14 | $0.102 | -27% | +| Operating system | Billing SKU | Per-minute rate (USD) | +| ------------------ | ---------------------| ----------------------| +| Linux 4-core | `linux_4_core_gpu` | $0.052 | +| Windows 4-core | `windows_4_core_gpu` | $0.102 | ## Points to note about rates for runners diff --git a/content/billing/reference/cost-center-allocation.md b/content/billing/reference/cost-center-allocation.md index 243f6e225592..9e41e955204a 100644 --- a/content/billing/reference/cost-center-allocation.md +++ b/content/billing/reference/cost-center-allocation.md @@ -29,33 +29,24 @@ This article contains reference information for how spending is assigned to cost | Git Large File Storage | The repository or organization where Git LFS is used. | | {% data variables.product.prodname_registry %} | The repository or organization that owns the package. | | {% data variables.product.prodname_prus_caps %} | The user who triggered the use of the {% data variables.product.prodname_pru %} (priority), or the organization they belong to. | -| {% data variables.product.prodname_GH_cs_and_sp %} | A user who uses a license. | +| {% data variables.product.prodname_GHAS %} | A user who uses a license (priority), or the organization that is billed for the license. | ## Details for license-based products To ensure your cost centers reflect spending as intended, it's important to understand how the cost of licenses is allocated to cost centers, and how changes are reflected in your bill. -### {% data variables.product.prodname_GH_cs_and_sp %} - -| User associated with a cost center | License usage charged | -|--|--| -| Direct assignment | To the cost center the user is assigned to | -| By organization membership only | To the enterprise | - -### {% data variables.product.prodname_enterprise %} and {% data variables.product.prodname_copilot %} - -Cost center allocation is slightly different for {% data variables.product.prodname_enterprise %} licenses and {% data variables.product.prodname_copilot %} licenses and usage. - -| User associated with a cost center | {% data variables.product.prodname_copilot_short %} license granted | License and product costs charged | +| User associated with a cost center | License granted | License and product costs charged | |--|--|--| -| Direct assignment | By any organization | To the cost center the user is assigned to | -| By organization membership only | By an organization assigned to a cost center | To the **cost center** the organization belongs to. If the organization does not belong to a cost center, to the **enterprise** | +| Direct assignment | By any organization | To the **cost center** the user is assigned to. | +| By organization membership only | By an organization assigned to a cost center | To the **cost center** the organization belongs to. If the organization does not belong to a cost center, to the **enterprise**. | Users who belong to multiple organizations in an enterprise or who receive a {% data variables.product.prodname_copilot_short %} license from multiple organizations: -* **{% data variables.product.prodname_enterprise %}** license usage is allocated to the oldest organization and charges are allocated to the cost center containing that organization. +* **{% data variables.product.prodname_enterprise %}** and **{% data variables.product.prodname_GHAS %}** license usage is allocated to the oldest organization and charges are allocated to the cost center containing that organization. * **{% data variables.product.prodname_copilot_short %}** license and product usage is allocated to one of the organizations and charges are allocated to the cost center containing that organization. +To confirm which organization is charged for a given user's license, you can request a detailed usage report. See [AUTOTITLE](/billing/reference/billing-reports#detailed-usage-report). + See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/about-billing-for-github-copilot-in-your-enterprise#about-seat-assignment-for-copilot-in-your-enterprise). ## Understanding cost center usage and attribution diff --git a/content/billing/reference/index.md b/content/billing/reference/index.md index 63c969028970..37858423da95 100644 --- a/content/billing/reference/index.md +++ b/content/billing/reference/index.md @@ -23,6 +23,6 @@ children: - /product-usage-included - /roles-for-visual-studio - /supported-payment-methods + - /previous-billing-platform-endpoints contentType: reference --- - diff --git a/content/billing/reference/previous-billing-platform-endpoints.md b/content/billing/reference/previous-billing-platform-endpoints.md new file mode 100644 index 000000000000..39109a86dcd7 --- /dev/null +++ b/content/billing/reference/previous-billing-platform-endpoints.md @@ -0,0 +1,105 @@ +--- +title: Migrating from the endpoints used for the previous billing platform +shortTitle: Previous billing platform endpoints +intro: 'If your organization previously used the billing platform that predated metered billing, this article explains how to migrate existing usage reporting to the current billing usage endpoints.' +versions: + fpt: '*' + ghec: '*' +topics: + - Enterprise + - Billing + - REST +permissions: 'Enterprise owners, organization owners, and billing managers' +product: '{% data reusables.billing.enhanced-billing-platform-product %}' +contentType: reference +--- + + + + +After you transition to metered billing, the endpoints you used to get data from the previous billing platform will no longer return accurate usage information. + +You will need to upgrade all calls using the previous `/ACCOUNT-TYPE/NAME/settings/billing/PRODUCT` REST API endpoints to use the equivalent `/ACCOUNT-TYPE/NAME/settings/billing/usage` endpoint. + +## Changes in authentication + +If you used a {% data variables.product.pat_v2 %} to authenticate with the previous endpoints, you will need create a {% data variables.product.pat_v1 %} to authenticate with the new endpoint. + +In addition, you may want to use the new query parameters to specify a time period or cost center. + +## Calculating {% data variables.product.prodname_actions %} information from the new response data + +Example of the previous response + +```json +{"total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } } +``` + +Example of the new response + +```json +{ "usageItems": [ { "date": "2023-08-01", "product": "Actions", "sku": "Actions Linux", "quantity": 100, "unitType": "minutes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example"} ] } +``` + +To get the same values from the new response data: + +{% rowheaders %} + +| Previous property | Calculate from new API response | +|------ |----------- | +| `total_minutes_used` |
  1. Filter results by `"product": "Actions"` and `"unitType": "minutes"`
  2. Sum `quantity`
| +| `total_paid_minutes_used`| This is now represented as a $ amount via `netAmount`.
  1. Filter results by `"product": "Actions"` and `"unitType": "minutes"`
  2. Sum `netAmount`
| +| `included_minutes` | This is now represented as a $ amount via `discountAmount`.
  1. Filter results by `"product": "Actions"` and `"unitType": "minutes"`
  2. Sum `discountAmount`
| +| `minutes_used_breakdown` |
  1. Filter results by `"product": "Actions"` and `"unitType": "minutes"`
  2. Sum `quantity` grouped by `sku`
| + +{% endrowheaders %} + +## Calculating {% data variables.product.prodname_registry %} information from the new response data + +Example of the previous response + +```json +{ "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 } +``` + +Example of the new response + +```json +{ "usageItems": [ { "date": "2023-08-01", "product": "Packages", "sku": "Packages data transfer", "quantity": 100, "unitType": "gigabytes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example" } ] } +``` + +{% rowheaders %} + +| Previous property | Calculate from new API response | +|------ |----------- | +| `total_gigabytes_bandwidth_used` |
  1. Filter results by `"product": "Packages"` and `"unitType": "gigabytes"`
  2. Sum `quantity`
| +| `total_paid_gigabytes_bandwidth_used`| This is now represented as a $ amount via `netAmount`.
  1. Filter results by `"product": "Packages"` and `"unitType": "gigabytes"`
  2. Sum `netAmount`
| +| `included_gigabytes_bandwidth` | This is now represented as a $ amount via `discountAmount`.
  1. Filter results by `"product": "Packages"` and `"unitType": "gigabytes"`
  2. Sum `discountAmount`
| + +{% endrowheaders %} + +## Calculating shared storage information from the new response data + +Example of the previous response + +```json +{ "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 } +``` + +Example of the new response + +```json +{ "usageItems": [ { "date": "2023-08-01", "product": "Packages", "sku": "Packages storage", "quantity": 100, "unitType": "GigabyteHours", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example" } ] } +``` + +{% rowheaders %} + +| Previous property | Calculate from new API response | +|------ |----------- | +| `days_left_in_billing_cycle` | Not available. This information can be inferred by subtracting the current day of the month from the number of days in the current month. | +| `estimated_paid_storage_for_month`| This is now represented as a $ amount via `netAmount`.

Prerequisite: pass the `month` and `year` query parameters.

For Actions storage
  1. Filter results by `"product": "Actions"` and `"unitType": "GigabyteHours"`
  2. Sum `netAmount`
For Packages storage
  1. Filter results by `"product": "Packages"` and `"unitType": "GigabyteHours"`
  2. Sum `netAmount`
| +| `estimated_storage_for_month` | Prerequisite: pass the `month` and `year` query parameters.

For Actions storage
  1. Filter results by `"product": "Actions"` and `"unitType": "GigabyteHours"`
  2. Sum `quantity`
For Packages storage
  1. Filter results by `"product": "Packages"` and `"unitType": "GigabyteHours"`
  2. Sum `quantity`
| + +{% endrowheaders %} + + diff --git a/content/billing/tutorials/automate-usage-reporting.md b/content/billing/tutorials/automate-usage-reporting.md index 5f7b2dd11e47..9aaf87fe285c 100644 --- a/content/billing/tutorials/automate-usage-reporting.md +++ b/content/billing/tutorials/automate-usage-reporting.md @@ -17,141 +17,170 @@ product: '{% data reusables.billing.enhanced-billing-platform-product %}' contentType: tutorials --- -You can automatically pull data from {% data variables.product.github %} to populate the business systems you use to monitor costs and usage using the REST API. If you haven't used the {% data variables.product.github %} REST API before, see [AUTOTITLE](/rest/using-the-rest-api). +After you transition to metered billing, you may want to automatically track usage and costs for paid {% data variables.product.github %} features in your internal reporting systems. For example, you might want to monitor spend over time, reconcile invoices, or feed usage data into finance or BI tools. -## Overview of endpoints +In this tutorial, you’ll learn how to use the REST API to retrieve billing usage data, filter it by time period or cost center, and automate recurring reports at the user, organization, or enterprise level. You’ll also learn how to interpret key fields in the response so you can turn raw usage data into meaningful cost insights. -You need to use different endpoints to gather data depending on your account type and the information level you want. +## Prerequisites -{% rowheaders %} +Before you begin this tutorial, make sure that: -| Account | Report | Access | Endpoint | More information | -|---------|--------|--------|----------|------------------| -| Users | Premium request consumption, with details of quota and billed usage | Account holder | `/users/{username}/settings/billing/premium_request/usage` | [AUTOTITLE](/rest/billing/usage?apiVersion=2022-11-28#get-billing-premium-request-usage-report-for-a-user) | -| Users | Usage data for all paid products | Account holder | `/users/{username}/settings/billing/usage/summary` | [AUTOTITLE](/rest/billing/usage?apiVersion=2022-11-28#get-billing-usage-summary-for-a-user) | -| Organizations | Premium request consumption, with details of quota and billed usage | Organization owners and billing managers | `/organizations/{org}/settings/billing/premium_request/usage` | [AUTOTITLE](/rest/billing/usage?apiVersion=2022-11-28#get-billing-premium-request-usage-report-for-an-organization) | -| Organizations | Usage data for all paid products | Organization owners and billing managers | `/organizations/{org}/settings/billing/usage/summary` | [AUTOTITLE](/rest/billing/usage?apiVersion=2022-11-28#get-billing-usage-summary-for-an-organization) | -| Enterprises | Premium request consumption, with details of quota and billed usage | Enterprise owners and billing managers | `/enterprises/{enterprise}/settings/billing/premium_request/usage` | [AUTOTITLE](/rest/billing/usage?apiVersion=2022-11-28#get-billing-premium-request-usage-report-for-an-enterprise) | -| Enterprises | Usage data for all paid products | Enterprise owners and billing managers | `/enterprises/{enterprise}/settings/billing/usage/summary` | [AUTOTITLE](/rest/billing/usage?apiVersion=2022-11-28#get-billing-usage-summary-for-an-enterprise) | +* You have access to billing data at the level you want to report on: + * User-level reports: account holder + * Organization-level reports: organization owner or billing manager + * Enterprise-level reports: enterprise administrator or billing manager -{% endrowheaders %} +* You’re familiar with making authenticated requests to the REST API. For an introduction, see [AUTOTITLE](/rest/using-the-rest-api). +* You authenticate using a {% data variables.product.pat_v1 %}. The billing usage endpoints do not support {% data variables.product.pat_v2_plural %}. -## Getting premium request consumption +Depending on your reporting needs, you may also want access to an internal system (such as a spreadsheet, database, or BI tool) where you can store and analyze the usage data retrieved from the API. -1. Authenticate with {% data variables.product.github %} with one of the following methods: - * **{% data variables.product.prodname_cli %}:** use the `gh auth login` command to authenticate, see [AUTOTITLE](/github-cli/github-cli/quickstart). - * **Create a {% data variables.product.pat_v1 %}:** and pass the token to in your API call, see [Creating a {% data variables.product.pat_v1 %}](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic). +## Step 1: Decide what level to report on -1. Call the required `premium_request/usage` endpoint, specifying the enterprise, organization, or user that you want data for. +Decide which account level you want to report on. This determines **which REST API endpoint you’ll call** and what your report will include. -## Getting usage data for all paid products +Choose the reporting level that best matches your goal: -1. Authenticate with {% data variables.product.github %} with one of the following methods: - * **{% data variables.product.prodname_cli %}:** use the `gh auth login` command to authenticate, see [AUTOTITLE](/github-cli/github-cli/quickstart). - * **Create a {% data variables.product.pat_v1 %}:** and pass the token to in your API call, see [Creating a {% data variables.product.pat_v1 %}](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic). +| Reporting level | When to use it | +| ----------------- | ---------------- | +| **User** | You want a report for a single account, for example to understand personal usage and costs. | +| **Organization** | You want to track usage and costs for a specific organization, for example for team-level monitoring or chargeback. | +| **Enterprise** | You want a centralized view across multiple organizations, for example for finance reporting or cost center reporting. | -1. Call the required `usage` endpoint, specifying the enterprise, organization, or user that you want data for. +Once you’ve chosen a reporting level, you’ll use the corresponding endpoint in the next step to retrieve usage data and build an automated report. -1. By default, data for all products for the current year is reported. For enterprises, only data that is not associated with a cost center is reported. +## Step 2: Retrieve usage data for paid products - You can request more specific data using query parameters. - * Specify time period by setting one or more of the following parameters: `year`, `month`, `day`, and `hour`. - * Specify a cost center to report on by identifier using the `cost_center_id` query parameter (enterprise endpoint only). +After you’ve decided which level to report on, use the REST API to retrieve usage data for paid {% data variables.product.github %} products. For all endpoints, see [AUTOTITLE](/rest/billing/usage). -For more detailed information and an example calls and responses, see: -* [Get billing usage report for an enterprise](/rest/enterprise-admin/billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-enterprise) -* [Get billing usage report for an organization](/rest/billing/enhanced-billing?apiVersion=2022-11-28#get-billing-usage-report-for-an-organization) -* [Get billing usage report for a user](/rest/billing/enhanced-billing?apiVersion=2022-11-28#get-billing-usage-report-for-a-user) +{% data variables.product.github %} provides two types of billing usage data: - - +* **Usage summaries** – aggregated usage and cost data for all paid products. +* **Premium request usage** – detailed usage and billing data for premium requests, including quotas and overage usage. -## Migrating from the endpoints used for the previous billing platform +In most reporting scenarios, you’ll start with a **usage summary** to understand overall usage and spend, and then use premium request usage data when you need deeper insight into premium request consumption. -After you transition to metered billing, the endpoints you used to get data from the previous billing platform will no longer return accurate usage information. +### Retrieve a usage summary -* Upgrade all calls of the form: `/ACCOUNT-TYPE/NAME/settings/billing/PRODUCT` -* To use the equivalent: `/ACCOUNT-TYPE/NAME/settings/billing/usage` endpoint +Use the usage summary endpoint that corresponds to the reporting level you chose in Step 1. -### Changes in authentication +For example, to retrieve a usage summary for an enterprise, make a request to: -If you used a {% data variables.product.pat_v2 %} to authenticate with the previous endpoints, you will need create a {% data variables.product.pat_v1 %} to authenticate with the new endpoint. +`/enterprises/{enterprise}/settings/billing/usage/summary` -In addition, you may want to use the new query parameters to specify a time period or cost center. +You must authenticate your request to this endpoint. -### Calculating {% data variables.product.prodname_actions %} information from the new response data +**Example using curl** -Example of the previous response - -```json -{"total_minutes_used": 305, "total_paid_minutes_used": 0, "included_minutes": 3000, "minutes_used_breakdown": { "UBUNTU": 205, "MACOS": 10, "WINDOWS": 90 } } +```bash +curl -L \ + -H "Authorization: Bearer $GITHUB_TOKEN" \ + -H "X-GitHub-Api-Version: 2022-11-28" \ + https://api.github.com/enterprises/ENTERPRISE/settings/billing/usage/summary ``` -Example of the new response +Replace `ENTERPRISE` with the enterprise slug and set the `GITHUB_TOKEN` environment variable to a {% data variables.product.pat_generic %} with the required billing permissions. + +**Example using the {% data variables.product.prodname_cli %}** -```json -{ "usageItems": [ { "date": "2023-08-01", "product": "Actions", "sku": "Actions Linux", "quantity": 100, "unitType": "minutes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example"} ] } +```bash +gh api \ + -H "X-GitHub-Api-Version: 2022-11-28" \ + /enterprises/ENTERPRISE/settings/billing/usage/summary ``` -To get the same values from the new response data: +This endpoint returns aggregated usage data for all paid products for the current year by default. Each entry includes information such as the product, unit type, quantity used, and billed amount. -{% rowheaders %} +You can use the same approach to retrieve usage summaries for an organization or user by calling the equivalent endpoint for that account level. -| Previous property | Calculate from new API response | -|------ |----------- | -| `total_minutes_used` | | -| `total_paid_minutes_used`| This is now represented as a $ amount via `netAmount`.| -| `included_minutes` | This is now represented as a $ amount via `discountAmount`.| -| `minutes_used_breakdown` | | +### Retrieve premium request usage -{% endrowheaders %} +If you need to report specifically on premium request consumption, use the `premium_request/usage` endpoint for the same account level. This endpoint provides additional details such as included usage, billed overages, and remaining quota. -### Calculating {% data variables.product.prodname_registry %} information from the new response data +In the next step, you’ll learn how to filter usage data by time period or cost center so you can generate more targeted reports. -Example of the previous response +## Step 3: Filter usage data by time period or cost center -```json -{ "total_gigabytes_bandwidth_used": 50, "total_paid_gigabytes_bandwidth_used": 40, "included_gigabytes_bandwidth": 10 } -``` +By default, usage summary endpoints return data for the **current year**. To generate more targeted reports or analyze trends over time, you can filter usage data using query parameters. + +### Filter by time period + +You can limit the usage data returned by specifying one or more of the following query parameters: + +* `year` +* `month` +* `day` +* `hour` -Example of the new response +For example, to retrieve usage data for a specific month, include the `year` and `month` parameters in your request: -```json -{ "usageItems": [ { "date": "2023-08-01", "product": "Packages", "sku": "Packages data transfer", "quantity": 100, "unitType": "gigabytes", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example" } ] } + ```http +GET /enterprises/{enterprise}/settings/billing/usage/summary?year=2024&month=12 ``` -{% rowheaders %} +Filtering by time period is useful when you want to: -| Previous property | Calculate from new API response | -|------ |----------- | -| `total_gigabytes_bandwidth_used` | | -| `total_paid_gigabytes_bandwidth_used`| This is now represented as a $ amount via `netAmount`. | -| `included_gigabytes_bandwidth` | This is now represented as a $ amount via `discountAmount`. | +* Generate monthly or daily usage reports +* Compare usage before and after a change, such as enabling a new feature +* Reconcile usage with invoices for a specific billing period -{% endrowheaders %} +### Filter by cost center (enterprise only) -### Calculating shared storage information from the new response data +If you’re retrieving enterprise-level usage data, you can also filter results by cost center using the `cost_center_id` query parameter. -Example of the previous response +Filtering by cost center allows you to: -```json -{ "days_left_in_billing_cycle": 20, "estimated_paid_storage_for_month": 15, "estimated_storage_for_month": 40 } -``` +* Attribute usage and costs to specific teams or business units +* Generate cost center–specific reports for finance or leadership stakeholders -Example of the new response +Cost center filtering is available only for enterprise usage summary endpoints. -```json -{ "usageItems": [ { "date": "2023-08-01", "product": "Packages", "sku": "Packages storage", "quantity": 100, "unitType": "GigabyteHours", "pricePerUnit": 0.008, "grossAmount": 0.8, "discountAmount": 0, "netAmount": 0.8, "organizationName": "GitHub", "repositoryName": "github/example" } ] } -``` +In the next step, you’ll learn how to automate these API calls to generate recurring usage reports. + +## Step 4: Automate recurring usage reports + +Once you’ve identified the usage data you want to collect and how to filter it, you can automate your reporting by running the same API requests on a recurring schedule. + +Common automation patterns include: + +* Running scheduled API requests (for example, daily or monthly) to collect usage data +* Storing the results in an internal system such as a database, spreadsheet, or BI tool +* Using the data to monitor trends, detect changes in usage, or support cost reviews + +When automating reports, consistency matters. Use the same reporting level, filters, and time ranges each time so that usage trends are comparable over time. + +For example, you might: + +* Run a monthly enterprise-level usage summary to track overall spend +* Generate cost center–specific reports for internal chargeback or showback +* Monitor usage growth after enabling new paid features + +In the next step, you’ll learn how to interpret the usage and cost fields returned by the API so you can turn raw data into meaningful insights. + +## Step 5: Interpret usage and cost fields in the API response + +The usage summary response includes both **usage** and **cost** information. Understanding how these fields relate to each other helps you interpret spend, included usage, and billed overages. + +Each usage item includes: + +* A **quantity**, which represents the amount of usage for a specific product and unit type +* A **netAmount**, which represents the billed cost for that usage +* A **discountAmount**, which represents usage covered by included quotas or discounts + +In general: + +* Use **quantity** to understand how much of a product was consumed +* Use **netAmount** to understand what was billed +* Use **discountAmount** to understand how much usage was included or discounted + +For example, a high quantity with a low netAmount may indicate that most usage was covered by included quotas, while a rising netAmount over time may indicate increased paid usage. + +Different products report usage using different unit types (such as minutes, gigabytes, or requests). To calculate product-specific metrics or reproduce values from the previous billing platform, you may need to filter usage items by product and unit type and aggregate the results. Detailed examples are available in the reference documentation linked in the next step. -{% rowheaders %} +## Step 6: Calculate product-specific usage metrics -| Previous property | Calculate from new API response | -|------ |----------- | -| `days_left_in_billing_cycle` | Not available. This information can be inferred by subtracting the current day of the month from the number of days in the current month. | -| `estimated_paid_storage_for_month`| This is now represented as a $ amount via `netAmount`.

Prerequisite: pass the `month` and `year` query parameters.

For Actions storage For Packages storage | -| `estimated_storage_for_month` | Prerequisite: pass the `month` and `year` query parameters.

For Actions storage For Packages storage | +In some cases, you may need to calculate product-specific usage metrics from the usage summary response. This is most relevant if you want to generate custom reports for a specific product or reproduce values used in legacy reporting. -{% endrowheaders %} +To calculate these metrics, you typically filter usage items by `product` and `unitType`, then aggregate fields such as `quantity`, `netAmount`, and `discountAmount`. - +For detailed examples and product-specific calculations, see [AUTOTITLE](/billing/reference/previous-billing-platform-endpoints). diff --git a/content/billing/tutorials/index.md b/content/billing/tutorials/index.md index 72fd055f7cd0..5bd2dd64e6a4 100644 --- a/content/billing/tutorials/index.md +++ b/content/billing/tutorials/index.md @@ -12,9 +12,9 @@ children: - /automate-usage-reporting - /set-up-budgets - /control-costs-at-scale - - /estimate-spending - /gather-insights contentType: tutorials redirect_from: - /billing/tutorials/estimate-actions-costs --- + diff --git a/content/code-security/code-quality/concepts/index.md b/content/code-security/code-quality/concepts/index.md deleted file mode 100644 index e5f79fa0cff0..000000000000 --- a/content/code-security/code-quality/concepts/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Concepts for GitHub Code Quality -shortTitle: Concepts -allowTitleToDifferFromFilename: true -intro: 'Discover how {% data variables.product.prodname_code_quality %} works, its core features, and key terms.' -versions: - feature: code-quality -topics: - - Code Quality -children: - - /about-code-quality -contentType: concepts ---- \ No newline at end of file diff --git a/content/code-security/code-quality/get-started/index.md b/content/code-security/code-quality/get-started/index.md deleted file mode 100644 index 50aef24023d2..000000000000 --- a/content/code-security/code-quality/get-started/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Get started with GitHub Code Quality -shortTitle: Get started -intro: 'Try out {% data variables.product.prodname_code_quality %} for your repository.' -versions: - feature: code-quality -topics: - - Code Quality -children: - - /quickstart -contentType: get-started ---- diff --git a/content/code-security/code-quality/how-tos/index.md b/content/code-security/code-quality/how-tos/index.md deleted file mode 100644 index b90704a761e1..000000000000 --- a/content/code-security/code-quality/how-tos/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: How-to guides for GitHub Code Quality -shortTitle: How-to guides -intro: 'Learn how to use {% data variables.product.prodname_code_quality %} with these detailed guides.' -versions: - feature: code-quality -topics: - - Code Quality -contentType: how-tos -children: - - /enable-code-quality - - /interpret-results - - /set-pr-thresholds - - /unblock-your-pr - - /allow-in-enterprise ---- diff --git a/content/code-security/code-quality/index.md b/content/code-security/code-quality/index.md deleted file mode 100644 index 072501794b5d..000000000000 --- a/content/code-security/code-quality/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: GitHub Code Quality documentation -shortTitle: GitHub Code Quality -intro: '{% data variables.product.prodname_code_quality %} helps you catch and fix code health risks, maintain high standards, and track code quality within your {% data variables.product.github %} workflow.' -versions: - feature: code-quality -topics: - - Code Quality -children: - - /get-started - - /concepts - - /how-tos - - /reference - - /tutorials - - /responsible-use ---- diff --git a/content/code-security/code-quality/reference/codeql-queries/index.md b/content/code-security/code-quality/reference/codeql-queries/index.md deleted file mode 100644 index 87e6de910bfc..000000000000 --- a/content/code-security/code-quality/reference/codeql-queries/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Queries for CodeQL detection -shortTitle: CodeQL queries -intro: 'Explore the {% data variables.product.prodname_codeql %} queries that {% data variables.product.prodname_code_quality_short %} uses to detect code quality issues in supported languages.' -versions: - feature: code-quality -topics: - - Code Quality -contentType: reference -children: - - csharp-queries - - go-queries - - java-queries - - javascript-queries - - python-queries - - ruby-queries ---- \ No newline at end of file diff --git a/content/code-security/code-quality/reference/index.md b/content/code-security/code-quality/reference/index.md deleted file mode 100644 index 188d0f76f4de..000000000000 --- a/content/code-security/code-quality/reference/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Reference for GitHub Code Quality -shortTitle: Reference -intro: 'Reference documentation for {% data variables.product.prodname_code_quality %}.' -versions: - feature: code-quality -topics: - - Code Quality -contentType: reference -children: - - metrics-and-ratings - - codeql-detection - - codeql-queries ---- diff --git a/content/code-security/code-quality/responsible-use/index.md b/content/code-security/code-quality/responsible-use/index.md deleted file mode 100644 index 1ead734e7dad..000000000000 --- a/content/code-security/code-quality/responsible-use/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Responsible use of GitHub Code Quality -shortTitle: Responsible use -intro: 'Use {% data variables.product.prodname_code_quality %} responsibly by understanding its purposes, capabilities, and limitations.' -versions: - feature: code-quality -topics: - - Code Quality -children: - - code-quality -contentType: rai ---- \ No newline at end of file diff --git a/content/code-security/code-quality/tutorials/index.md b/content/code-security/code-quality/tutorials/index.md deleted file mode 100644 index 0c3955d5f7c1..000000000000 --- a/content/code-security/code-quality/tutorials/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Tutorials for GitHub Code Quality -shortTitle: Tutorials -intro: 'Build skills and knowledge about {% data variables.product.prodname_code_quality %} through examples.' -versions: - feature: code-quality -topics: - - Code Quality -contentType: tutorials -children: - - /fix-findings-in-prs - - /improve-your-codebase - - /improve-recent-merges ---- diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md b/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md deleted file mode 100644 index 9f5c7c757dcd..000000000000 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Creating an advanced setup for {% data variables.product.prodname_code_scanning %} -shortTitle: 'Create advanced setup' -intro: 'For more granular control over your {% data variables.product.prodname_code_scanning %} configuration, you can secure your code with advanced setup for {% data variables.product.prodname_code_scanning %}.' -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning -children: - - /configuring-advanced-setup-for-code-scanning - - /customizing-your-advanced-setup-for-code-scanning - - /codeql-code-scanning-for-compiled-languages - - /configuring-advanced-setup-for-code-scanning-with-codeql-at-scale - - /recommended-hardware-resources-for-running-codeql - - /running-codeql-code-scanning-in-a-container ---- diff --git a/content/code-security/code-scanning/enabling-code-scanning/index.md b/content/code-security/code-scanning/enabling-code-scanning/index.md deleted file mode 100644 index cb3b69415318..000000000000 --- a/content/code-security/code-scanning/enabling-code-scanning/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Enabling code scanning -shortTitle: Enable code scanning -intro: 'You can quickly and easily secure your code with default setup for {% data variables.product.prodname_code_scanning %}.' -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /configuring-default-setup-for-code-scanning - - /evaluating-default-setup-for-code-scanning - - /configuring-default-setup-for-code-scanning-at-scale ---- diff --git a/content/code-security/code-scanning/index.md b/content/code-security/code-scanning/index.md deleted file mode 100644 index eb388fe9d6b7..000000000000 --- a/content/code-security/code-scanning/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Finding security vulnerabilities and errors in your code with code scanning -shortTitle: Code scanning -allowTitleToDifferFromFilename: true -intro: 'Keep your code secure by using {% data variables.product.prodname_code_scanning %} to identify and fix potential security vulnerabilities and other errors in your code.' -product: '{% data reusables.gated-features.code-scanning %}' -redirect_from: - - /github/managing-security-vulnerabilities/finding-security-vulnerabilities-in-your-projects-code - - /github/finding-security-vulnerabilities-and-errors-in-your-code - - /code-security/secure-coding -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /introduction-to-code-scanning - - /enabling-code-scanning - - /creating-an-advanced-setup-for-code-scanning - - /managing-code-scanning-alerts - - /managing-your-code-scanning-configuration - - /integrating-with-code-scanning - - /troubleshooting-code-scanning - - /troubleshooting-sarif-uploads - - /reference ---- diff --git a/content/code-security/code-scanning/introduction-to-code-scanning/index.md b/content/code-security/code-scanning/introduction-to-code-scanning/index.md deleted file mode 100644 index 18fa779c08eb..000000000000 --- a/content/code-security/code-scanning/introduction-to-code-scanning/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Introduction to code scanning -shortTitle: Introduction -intro: 'Learn what {% data variables.product.prodname_code_scanning %} is, how it helps you secure your code, and what {% data variables.product.prodname_code_scanning %} tools are available.' -product: '{% data reusables.gated-features.code-scanning %}' -redirect_from: - - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors - - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors - - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /about-code-scanning - - /about-code-scanning-with-codeql ---- diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/index.md b/content/code-security/code-scanning/managing-code-scanning-alerts/index.md deleted file mode 100644 index 301fdb8042e2..000000000000 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Managing code scanning alerts -shortTitle: Manage alerts -intro: 'Learn how to triage, track, and resolve {% data variables.product.prodname_code_scanning %} alerts.' -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Code Security - - Code scanning - - CodeQL -redirect_from: - - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/tracking-code-scanning-alerts-in-issues-using-task-lists - - /code-security/code-scanning/managing-code-scanning-alerts/tracking-code-scanning-alerts-in-issues-using-task-lists -children: - - /about-code-scanning-alerts - - /responsible-use-autofix-code-scanning - - /disabling-autofix-for-code-scanning - - /assessing-code-scanning-alerts-for-your-repository - - /resolving-code-scanning-alerts - - /best-practices-for-participating-in-a-security-campaign - - /fixing-alerts-in-security-campaign - - /triaging-code-scanning-alerts-in-pull-requests ---- diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md b/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md deleted file mode 100644 index be0d34cbce84..000000000000 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Managing your code scanning configuration -shortTitle: Manage code scanning -intro: You can manage your existing {% data variables.product.prodname_code_scanning %} configuration with the help of metrics and logging outputs generated by your analysis. -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /about-the-tool-status-page - - /editing-your-configuration-of-default-setup - - /codeql-query-suites - - /set-code-scanning-merge-protection - - /enabling-delegated-alert-dismissal-for-code-scanning - - /configuring-larger-runners-for-default-setup - - /viewing-code-scanning-logs ---- - diff --git a/content/code-security/code-scanning/reference/index.md b/content/code-security/code-scanning/reference/index.md deleted file mode 100644 index c2d1591d66a3..000000000000 --- a/content/code-security/code-scanning/reference/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Reference for code scanning -shortTitle: Reference -intro: Reference documentation for {% data variables.product.prodname_code_scanning %}. -product: '{% data reusables.gated-features.code-scanning %}' -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /code-ql-built-in-queries ---- \ No newline at end of file diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/index.md b/content/code-security/code-scanning/troubleshooting-sarif-uploads/index.md deleted file mode 100644 index 1c0149b8e2a6..000000000000 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Troubleshooting SARIF uploads -intro: 'Learn how to resolve problems uploading SARIF files of {% data variables.product.prodname_code_scanning %} results to {% data variables.product.prodname_dotcom %}.' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - Integration -children: - - /ghas-required - - /default-setup-enabled - - /missing-token - - /sarif-invalid - - /file-too-large - - /results-exceed-limit -redirect_from: - - /code-security/code-scanning/troubleshooting-sarif ---- diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md b/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md deleted file mode 100644 index 93dd23013097..000000000000 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Getting started with the CodeQL CLI -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to locally develop, test and run {% data variables.product.prodname_codeql %} queries on software projects.' -shortTitle: Getting started -product: '{% data reusables.gated-features.codeql %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /about-the-codeql-cli - - /setting-up-the-codeql-cli - - /preparing-your-code-for-codeql-analysis - - /analyzing-your-code-with-codeql-queries - - /uploading-codeql-analysis-results-to-github - - /customizing-analysis-with-codeql-packs -redirect_from: - - /code-security/codeql-cli/using-the-codeql-cli ---- diff --git a/content/code-security/codeql-cli/index.md b/content/code-security/codeql-cli/index.md deleted file mode 100644 index 5838d18c1dd8..000000000000 --- a/content/code-security/codeql-cli/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Use the CodeQL CLI to secure your code -shortTitle: CodeQL CLI -allowTitleToDifferFromFilename: true -intro: 'Use {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} analyses locally.' -product: '{% data reusables.gated-features.codeql %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /getting-started-with-the-codeql-cli - - /using-the-advanced-functionality-of-the-codeql-cli - - /codeql-cli-manual ---- diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md b/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md deleted file mode 100644 index 9abdd52bd070..000000000000 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Using the advanced functionality of the CodeQL CLI -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to locally develop, test and run {% data variables.product.prodname_codeql %} queries on software projects.' -product: '{% data reusables.gated-features.codeql %}' -shortTitle: Advanced functionality -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /advanced-setup-of-the-codeql-cli - - /about-codeql-workspaces - - /using-custom-queries-with-the-codeql-cli - - /creating-codeql-query-suites - - /testing-custom-queries - - /testing-query-help-files - - /creating-and-working-with-codeql-packs - - /publishing-and-using-codeql-packs - - /specifying-command-options-in-a-codeql-configuration-file - - /query-reference-files - - /sarif-output - - /csv-output - - /extractor-options - - /exit-codes - - /creating-database-bundle-for-troubleshooting -redirect_from: - - /code-security/codeql-cli/codeql-cli-reference ---- diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/index.md b/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/index.md deleted file mode 100644 index 10ae6348e145..000000000000 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Getting started with the {% data variables.product.prodname_codeql %} for Visual Studio Code extension -shortTitle: Getting started -intro: 'The {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %} makes it easy to run a query to find problems in codebases.' -product: '{% data reusables.gated-features.codeql %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /about-codeql-for-vs-code - - /installing-codeql-for-vs-code - - /managing-codeql-databases - - /running-codeql-queries - - /exploring-data-flow-with-path-queries - - /running-codeql-queries-at-scale-with-multi-repository-variant-analysis -redirect_from: - - /code-security/codeql-for-vs-code/setting-up-codeql-in-visual-studio-code ---- diff --git a/content/code-security/codeql-for-vs-code/index.md b/content/code-security/codeql-for-vs-code/index.md deleted file mode 100644 index eabad0d0f0d4..000000000000 --- a/content/code-security/codeql-for-vs-code/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Use CodeQL inside Visual Studio Code -shortTitle: CodeQL for VS Code -allowTitleToDifferFromFilename: true -intro: 'Use the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension to write, run, and test {% data variables.product.prodname_codeql %} queries inside {% data variables.product.prodname_vscode %}.' -product: '{% data reusables.gated-features.codeql %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /getting-started-with-codeql-for-vs-code - - /using-the-advanced-functionality-of-the-codeql-for-vs-code-extension - - /troubleshooting-codeql-for-vs-code ---- diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/index.md b/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/index.md deleted file mode 100644 index 83b89930ee8c..000000000000 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Using the advanced functionality of the {% data variables.product.prodname_codeql %} for VS Code extension -shortTitle: Advanced functionality -intro: 'The {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %} adds rich language support for {% data variables.product.prodname_codeql %} and supports writing queries to find problems in codebases.' -product: '{% data reusables.gated-features.codeql %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Code Security - - Code scanning - - CodeQL -children: - - /using-the-codeql-model-editor - - /creating-a-custom-query - - /managing-codeql-packs - - /exploring-the-structure-of-your-source-code - - /testing-codeql-queries-in-vs-code - - /customizing-settings - - /setting-up-a-codeql-workspace - - /configuring-access-to-the-codeql-cli - - /telemetry-in-codeql-for-visual-studio-code ---- diff --git a/content/code-security/code-quality/concepts/about-code-quality.md b/content/code-security/concepts/about-code-quality.md similarity index 93% rename from content/code-security/code-quality/concepts/about-code-quality.md rename to content/code-security/concepts/about-code-quality.md index 6d9b4bcd87b3..0e22b6e47814 100644 --- a/content/code-security/code-quality/concepts/about-code-quality.md +++ b/content/code-security/concepts/about-code-quality.md @@ -1,13 +1,18 @@ --- title: About GitHub Code Quality -shortTitle: About Code Quality -intro: 'Use {% data variables.product.prodname_code_quality %} to flag code quality issues in pull requests and repository scans, apply {% data variables.product.prodname_copilot_short %}-powered autofixes, and enforce standards with rulesets.' +shortTitle: GitHub Code Quality +allowTitleToDifferFromFilename: true +intro: Use {% data variables.product.prodname_code_quality %} to flag code quality issues in pull requests and repository scans, apply {% data variables.product.prodname_copilot_short %}-powered autofixes, and enforce standards with rulesets. product: '{% data reusables.gated-features.code-quality-availability %}' versions: feature: code-quality topics: - Code Quality contentType: concepts +redirect_from: + - /code-security/code-quality/concepts/about-code-quality + - /code-security/code-quality/concepts + - /code-security/code-quality --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts.md b/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md similarity index 98% rename from content/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts.md rename to content/code-security/concepts/code-scanning/about-code-scanning-alerts.md index d42823b1d5da..84498e140b82 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts.md +++ b/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md @@ -1,5 +1,6 @@ --- title: About code scanning alerts +shortTitle: Code scanning alerts intro: Learn about the different types of code scanning alerts and the information that helps you understand the problem each alert highlights. permissions: '{% data reusables.permissions.code-scanning-all-alerts %}' product: '{% data reusables.gated-features.code-scanning %}' @@ -9,11 +10,12 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts -type: overview + - /code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts topics: - Code Security - Code scanning - CodeQL +contentType: concepts --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning.md b/content/code-security/concepts/code-scanning/about-code-scanning.md similarity index 94% rename from content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning.md rename to content/code-security/concepts/code-scanning/about-code-scanning.md index bb7427c590eb..6155aee36c77 100644 --- a/content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning.md +++ b/content/code-security/concepts/code-scanning/about-code-scanning.md @@ -1,6 +1,7 @@ --- title: About code scanning -intro: 'You can use {% data variables.product.prodname_code_scanning %} to find security vulnerabilities and errors in the code for your project on {% data variables.product.prodname_dotcom %}.' +shortTitle: Introduction +intro: You can use {% data variables.product.prodname_code_scanning %} to find security vulnerabilities and errors in the code for your project on {% data variables.product.prodname_dotcom %}. product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/managing-security-vulnerabilities/about-automated-code-scanning @@ -9,14 +10,15 @@ redirect_from: - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning + - /code-security/code-scanning/introduction-to-code-scanning/about-code-scanning versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Code Security - Code scanning +contentType: concepts --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md b/content/code-security/concepts/code-scanning/about-integration-with-code-scanning.md similarity index 84% rename from content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md rename to content/code-security/concepts/code-scanning/about-integration-with-code-scanning.md index 897f4ceeccd8..7e3d8246dba3 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning.md +++ b/content/code-security/concepts/code-scanning/about-integration-with-code-scanning.md @@ -1,23 +1,24 @@ --- title: About integration with code scanning -shortTitle: About integration -intro: 'You can perform {% data variables.product.prodname_code_scanning %} externally and then display the results in {% data variables.product.prodname_dotcom %}, or configure webhooks that listen to {% data variables.product.prodname_code_scanning %} activity in your repository.' +shortTitle: Integration with code scanning +intro: You can perform {% data variables.product.prodname_code_scanning %} externally and then display the results in {% data variables.product.prodname_dotcom %}, or configure webhooks that listen to {% data variables.product.prodname_code_scanning %} activity in your repository. product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning - /code-security/secure-coding/about-integration-with-code-scanning - /code-security/secure-coding/integrating-with-code-scanning/about-integration-with-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning/about-integration-with-code-scanning + - /code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Code Security - Code scanning - Webhooks - Integration +contentType: concepts --- ## About integration with code scanning diff --git a/content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql.md b/content/code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql.md similarity index 94% rename from content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql.md rename to content/code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql.md index 715d80e42d21..7fd63e0d0ad5 100644 --- a/content/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql.md +++ b/content/code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql.md @@ -1,20 +1,21 @@ --- title: About code scanning with CodeQL -shortTitle: About CodeQL code scanning -intro: 'You can use {% data variables.product.prodname_codeql %} to identify vulnerabilities and errors in your code. The results are shown as {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.prodname_dotcom %}.' +shortTitle: CodeQL code scanning +intro: You can use {% data variables.product.prodname_codeql %} to identify vulnerabilities and errors in your code. The results are shown as {% data variables.product.prodname_code_scanning %} alerts in {% data variables.product.prodname_dotcom %}. product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql + - /code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Code Security - Code scanning - CodeQL +contentType: concepts --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/about-codeql-for-vs-code.md b/content/code-security/concepts/code-scanning/codeql/about-codeql-for-vs-code.md similarity index 92% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/about-codeql-for-vs-code.md rename to content/code-security/concepts/code-scanning/codeql/about-codeql-for-vs-code.md index aa5f947f004d..c805c19c4ef7 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/about-codeql-for-vs-code.md +++ b/content/code-security/concepts/code-scanning/codeql/about-codeql-for-vs-code.md @@ -1,6 +1,6 @@ --- title: About CodeQL for VS Code -shortTitle: About the extension +shortTitle: CodeQL for VS Code versions: fpt: '*' ghec: '*' @@ -10,10 +10,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can write, run, and test {% data variables.product.prodname_codeql %} queries inside {% data variables.product.prodname_vscode %} with the {% data variables.product.prodname_codeql %} extension.' +intro: You can write, run, and test {% data variables.product.prodname_codeql %} queries inside {% data variables.product.prodname_vscode %} with the {% data variables.product.prodname_codeql %} extension. redirect_from: - /code-security/codeql-for-vs-code/about-codeql-for-visual-studio-code + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/about-codeql-for-vs-code +contentType: concepts --- ## About {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/about-codeql-workspaces.md b/content/code-security/concepts/code-scanning/codeql/about-codeql-workspaces.md similarity index 98% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/about-codeql-workspaces.md rename to content/code-security/concepts/code-scanning/codeql/about-codeql-workspaces.md index bcc3465277bd..e31017373b11 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/about-codeql-workspaces.md +++ b/content/code-security/concepts/code-scanning/codeql/about-codeql-workspaces.md @@ -1,5 +1,6 @@ --- title: About CodeQL workspaces +shortTitle: CodeQL workspaces intro: '{% data variables.product.prodname_codeql %} workspaces allow you to develop and maintain a group of {% data variables.product.prodname_codeql %} packs that depend on each other.' product: '{% data reusables.gated-features.codeql %}' versions: @@ -13,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/about-codeql-workspaces - /code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/about-codeql-workspaces +contentType: concepts --- ## About {% data variables.product.prodname_codeql %} workspaces diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli.md b/content/code-security/concepts/code-scanning/codeql/about-the-codeql-cli.md similarity index 95% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli.md rename to content/code-security/concepts/code-scanning/codeql/about-the-codeql-cli.md index 0ea0c8df55f5..e11ce95aed6b 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli.md +++ b/content/code-security/concepts/code-scanning/codeql/about-the-codeql-cli.md @@ -1,6 +1,7 @@ --- title: About the CodeQL CLI -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.github %}.' +shortTitle: CodeQL CLI +intro: You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.github %}. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -22,6 +23,8 @@ redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-code-scanning-in-your-ci-system - /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli - /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli +contentType: concepts --- Software developers and security researchers can secure their code diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites.md b/content/code-security/concepts/code-scanning/codeql/codeql-query-suites.md similarity index 97% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites.md rename to content/code-security/concepts/code-scanning/codeql/codeql-query-suites.md index 5d890931aeaf..1f7b6fef4094 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites.md +++ b/content/code-security/concepts/code-scanning/codeql/codeql-query-suites.md @@ -10,11 +10,11 @@ versions: redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/built-in-codeql-query-suites - /code-security/code-scanning/managing-your-code-scanning-configuration/built-in-codeql-query-suites -type: reference + - /code-security/code-scanning/managing-your-code-scanning-configuration/codeql-query-suites topics: - Code scanning - CodeQL -contentType: other +contentType: concepts --- ## About {% data variables.product.prodname_codeql %} query suites diff --git a/content/code-security/concepts/code-scanning/codeql/index.md b/content/code-security/concepts/code-scanning/codeql/index.md new file mode 100644 index 000000000000..91accd1bae58 --- /dev/null +++ b/content/code-security/concepts/code-scanning/codeql/index.md @@ -0,0 +1,19 @@ +--- +title: Concepts for CodeQL +shortTitle: CodeQL +intro: Understand the core concepts behind {% data variables.product.prodname_codeql %} and how it helps you find vulnerabilities and errors in your code. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code scanning +contentType: concepts +children: + - /about-code-scanning-with-codeql + - /codeql-query-suites + - /about-the-codeql-cli + - /about-codeql-for-vs-code + - /about-codeql-workspaces + - /query-reference-files +--- diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/query-reference-files.md b/content/code-security/concepts/code-scanning/codeql/query-reference-files.md similarity index 95% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/query-reference-files.md rename to content/code-security/concepts/code-scanning/codeql/query-reference-files.md index 74b51325aaeb..7a10739f5b56 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/query-reference-files.md +++ b/content/code-security/concepts/code-scanning/codeql/query-reference-files.md @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/query-reference-files - /code-security/codeql-cli/codeql-cli-reference/query-reference-files + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/query-reference-files +contentType: concepts --- ## About query reference files diff --git a/content/code-security/code-scanning/enabling-code-scanning/evaluating-default-setup-for-code-scanning.md b/content/code-security/concepts/code-scanning/evaluating-default-setup-for-code-scanning.md similarity index 93% rename from content/code-security/code-scanning/enabling-code-scanning/evaluating-default-setup-for-code-scanning.md rename to content/code-security/concepts/code-scanning/evaluating-default-setup-for-code-scanning.md index e4f8d1d72ef1..f0da7b96cca4 100644 --- a/content/code-security/code-scanning/enabling-code-scanning/evaluating-default-setup-for-code-scanning.md +++ b/content/code-security/concepts/code-scanning/evaluating-default-setup-for-code-scanning.md @@ -1,9 +1,8 @@ --- title: Evaluating default setup for code scanning shortTitle: Evaluate code scanning -intro: 'Learn how to assess how code scanning is working for you, and how you can customize your setup to best meet your needs.' +intro: Learn how to assess how code scanning is working for you, and how you can customize your setup to best meet your needs. permissions: '{% data reusables.permissions.security-repo-enable %}' -type: how_to topics: - Code Security - Code scanning @@ -11,6 +10,9 @@ versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/enabling-code-scanning/evaluating-default-setup-for-code-scanning +contentType: concepts --- When you first start using {% data variables.product.prodname_code_scanning %}, you'll likely use default setup. This guide describes how to evaluate how default setup for {% data variables.product.prodname_code_scanning %} is working for you, and what steps to take if something isn't working as you expect. This guide also describes how you can customize {% data variables.product.prodname_code_scanning %} if you find that you have a specific use case that your new configuration doesn't fit. diff --git a/content/code-security/concepts/code-scanning/index.md b/content/code-security/concepts/code-scanning/index.md new file mode 100644 index 000000000000..2620e78e8208 --- /dev/null +++ b/content/code-security/concepts/code-scanning/index.md @@ -0,0 +1,21 @@ +--- +title: Concepts for code scanning +shortTitle: Code scanning +intro: Learn core concepts for {% data variables.product.github %}'s code scanning features. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +redirect_from: + - /code-security/code-scanning/introduction-to-code-scanning +topics: + - Code Security + - Code scanning +contentType: concepts +children: + - /about-code-scanning + - /about-code-scanning-alerts + - /evaluating-default-setup-for-code-scanning + - /about-integration-with-code-scanning + - /codeql +--- diff --git a/content/code-security/concepts/index.md b/content/code-security/concepts/index.md new file mode 100644 index 000000000000..edd87776204a --- /dev/null +++ b/content/code-security/concepts/index.md @@ -0,0 +1,24 @@ +--- +title: Concepts for security and code quality +shortTitle: Concepts +intro: Learn core concepts for {% data variables.product.github %}'s security and code quality features. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: concepts +children: + - /secret-security + - /code-scanning + - /about-code-quality + - supply-chain-security + - /vulnerability-reporting-and-management + - /security-at-scale diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts.md b/content/code-security/concepts/secret-security/about-alerts.md similarity index 95% rename from content/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts.md rename to content/code-security/concepts/secret-security/about-alerts.md index 71804d1c4919..fa0666477c11 100644 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts.md +++ b/content/code-security/concepts/secret-security/about-alerts.md @@ -1,20 +1,22 @@ --- title: About secret scanning alerts -intro: 'Learn about the different types of {% data variables.secret-scanning.alerts %}.' +intro: Learn about the different types of {% data variables.secret-scanning.alerts %}. permissions: '{% data reusables.permissions.secret-scanning-alerts %}' product: '{% data reusables.gated-features.secret-scanning %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Secret scanning - Secret Protection - Alerts - Repositories -shortTitle: About alerts +shortTitle: Secret scanning alerts allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/secret-scanning/managing-alerts-from-secret-scanning/about-alerts +contentType: concepts --- ## About types of alerts diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection.md b/content/code-security/concepts/secret-security/about-delegated-bypass-for-push-protection.md similarity index 86% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection.md rename to content/code-security/concepts/secret-security/about-delegated-bypass-for-push-protection.md index ed96fac24dd6..6f138c5f0ccf 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection.md +++ b/content/code-security/concepts/secret-security/about-delegated-bypass-for-push-protection.md @@ -6,13 +6,16 @@ versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Secret scanning - Secret Protection - Alerts - Repositories -shortTitle: About delegated bypass +shortTitle: Delegated bypass +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection +contentType: concepts --- ## About delegated bypass for push protection diff --git a/content/code-security/secret-scanning/introduction/about-push-protection.md b/content/code-security/concepts/secret-security/about-push-protection.md similarity index 95% rename from content/code-security/secret-scanning/introduction/about-push-protection.md rename to content/code-security/concepts/secret-security/about-push-protection.md index 923f97fbb630..5e2b86f23b02 100644 --- a/content/code-security/secret-scanning/introduction/about-push-protection.md +++ b/content/code-security/concepts/secret-security/about-push-protection.md @@ -1,6 +1,6 @@ --- title: About push protection -intro: 'Push protection blocks contributors from pushing secrets to a repository and generates an alert whenever a contributor bypasses the block.{% ifversion secret-scanning-push-protection-for-users %} Push protection can be applied at the repository, organization, and user account level{% else %} You can apply push protection at repository or organization level{% endif %}.' +intro: Push protection blocks contributors from pushing secrets to a repository and generates an alert whenever a contributor bypasses the block.{% ifversion secret-scanning-push-protection-for-users %} Push protection can be applied at the repository, organization, and user account level{% else %} You can apply push protection at repository or organization level{% endif %}. product: '{% data reusables.gated-features.push-protection-for-repos %}' versions: fpt: '*' @@ -10,13 +10,14 @@ redirect_from: - /early-access/code-security/secret-scanning/protecting-pushes-with-secret-scanning - /code-security/secret-scanning/protecting-pushes-with-secret-scanning - /code-security/secret-scanning/push-protection-for-repositories-and-organizations -type: overview + - /code-security/secret-scanning/introduction/about-push-protection topics: - Secret scanning - Secret Protection - Alerts - Repositories shortTitle: Push protection +contentType: concepts --- ## About push protection diff --git a/content/code-security/secret-scanning/introduction/about-secret-scanning-for-partners.md b/content/code-security/concepts/secret-security/about-secret-scanning-for-partners.md similarity index 81% rename from content/code-security/secret-scanning/introduction/about-secret-scanning-for-partners.md rename to content/code-security/concepts/secret-security/about-secret-scanning-for-partners.md index d69f24a76854..b526b75ce4a7 100644 --- a/content/code-security/secret-scanning/introduction/about-secret-scanning-for-partners.md +++ b/content/code-security/concepts/secret-security/about-secret-scanning-for-partners.md @@ -1,15 +1,17 @@ --- title: About secret scanning for partners -intro: 'When {% data variables.product.prodname_secret_scanning %} detects authentication details for a service provider in a public repository on {% data variables.product.prodname_dotcom %}, an alert is sent directly to the provider. This allows service providers who are {% data variables.product.prodname_dotcom %} partners to promptly take action to secure their systems.' +intro: When {% data variables.product.prodname_secret_scanning %} detects authentication details for a service provider in a public repository on {% data variables.product.prodname_dotcom %}, an alert is sent directly to the provider. This allows service providers who are {% data variables.product.prodname_dotcom %} partners to promptly take action to secure their systems. product: '{% data reusables.gated-features.secret-scanning-partner-alerts %}' versions: fpt: '*' ghec: '*' -type: overview topics: - Secret scanning - Secret Protection shortTitle: Secret scanning for partners +redirect_from: + - /code-security/secret-scanning/introduction/about-secret-scanning-for-partners +contentType: concepts --- ## About {% data variables.secret-scanning.partner_alerts %} diff --git a/content/code-security/secret-scanning/introduction/about-secret-scanning.md b/content/code-security/concepts/secret-security/about-secret-scanning.md similarity index 99% rename from content/code-security/secret-scanning/introduction/about-secret-scanning.md rename to content/code-security/concepts/secret-security/about-secret-scanning.md index 2bbc52e356d1..524ded0d9457 100644 --- a/content/code-security/secret-scanning/introduction/about-secret-scanning.md +++ b/content/code-security/concepts/secret-security/about-secret-scanning.md @@ -12,15 +12,16 @@ redirect_from: - /github/administering-a-repository/about-secret-scanning - /code-security/secret-security/about-secret-scanning - /code-security/secret-scanning/about-secret-scanning + - /code-security/secret-scanning/introduction/about-secret-scanning versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Secret scanning - Secret Protection shortTitle: Secret scanning +contentType: concepts --- ## About {% data variables.product.prodname_secret_scanning %} @@ -124,7 +125,6 @@ Define your own patterns for secrets used by your organization that {% data vari * [AUTOTITLE](/code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository) * [AUTOTITLE](/code-security/secret-scanning/introduction/about-push-protection) -* [AUTOTITLE](/code-security/secret-scanning/working-with-secret-scanning-and-push-protection) * [AUTOTITLE](/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization) * [AUTOTITLE](/code-security/getting-started/securing-your-repository) * [AUTOTITLE](/authentication/keeping-your-account-and-data-secure) diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-security-with-github.md b/content/code-security/concepts/secret-security/about-secret-security-with-github.md similarity index 89% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-security-with-github.md rename to content/code-security/concepts/secret-security/about-secret-security-with-github.md index 992648d7dc45..a741c63bebc1 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-security-with-github.md +++ b/content/code-security/concepts/secret-security/about-secret-security-with-github.md @@ -1,9 +1,9 @@ --- -title: 'About secret security with GitHub' -shortTitle: 'Secret protection tools' -intro: 'Learn how {% data variables.product.github %}''s security tools can help you identify, remediate, and prevent secret leaks.' +title: About secret security with GitHub +shortTitle: Secret protection tools +intro: Learn how {% data variables.product.github %}'s security tools can help you identify, remediate, and prevent secret leaks. product: '{% data reusables.gated-features.secret-protection %}' -permissions: 'Organizations on {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %}' +permissions: Organizations on {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} contentType: concepts versions: feature: secret-risk-assessment @@ -15,6 +15,7 @@ topics: - Security redirect_from: - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-risk-assessment + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-security-with-github --- {% data variables.product.github %} provides tools to help you understand and address your organization's exposure to leaked secrets: diff --git a/content/code-security/concepts/secret-security/index.md b/content/code-security/concepts/secret-security/index.md new file mode 100644 index 000000000000..f728ef8235f1 --- /dev/null +++ b/content/code-security/concepts/secret-security/index.md @@ -0,0 +1,24 @@ +--- +title: Concepts for secret security +shortTitle: Secret security +intro: Learn core concepts for {% data variables.product.github %}'s secret security features. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning +contentType: concepts +children: + - /about-secret-scanning + - /about-push-protection + - /about-secret-security-with-github + - /about-alerts + - /about-delegated-bypass-for-push-protection + - /about-secret-scanning-for-partners + - /working-with-push-protection-and-the-github-mcp-server + - /working-with-push-protection-from-the-rest-api +redirect_from: + - /code-security/secret-scanning/introduction +--- diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-and-the-github-mcp-server.md b/content/code-security/concepts/secret-security/working-with-push-protection-and-the-github-mcp-server.md similarity index 79% rename from content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-and-the-github-mcp-server.md rename to content/code-security/concepts/secret-security/working-with-push-protection-and-the-github-mcp-server.md index 0f857fe6f5db..f66820d1030a 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-and-the-github-mcp-server.md +++ b/content/code-security/concepts/secret-security/working-with-push-protection-and-the-github-mcp-server.md @@ -1,18 +1,20 @@ --- title: Working with push protection and the GitHub MCP server shortTitle: Push protection and the GitHub MCP server -intro: 'Learn how you are protected from leaking secrets during interactions with the {% data variables.product.github %} MCP server, and how to bypass a push protection block if you need to.' -product: 'Public repositories on {% data variables.product.prodname_dotcom_the_website %}' +intro: Learn how you are protected from leaking secrets during interactions with the {% data variables.product.github %} MCP server, and how to bypass a push protection block if you need to. +product: Public repositories on {% data variables.product.prodname_dotcom_the_website %} permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: feature: copilot -type: how_to topics: - Secret scanning - Secret Protection - Alerts - Repositories - Copilot +redirect_from: + - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-and-the-github-mcp-server +contentType: concepts --- ## About push protection and the {% data variables.product.github %} MCP server diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api.md b/content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md similarity index 80% rename from content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api.md rename to content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md index 7f765bef0931..b22021be8bd4 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api.md +++ b/content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md @@ -1,16 +1,18 @@ --- title: Working with push protection from the REST API shortTitle: Push protection from the REST API -intro: 'Learn your options for unblocking your push to {% data variables.product.prodname_dotcom %} using the REST API if {% data variables.product.prodname_secret_scanning %} detects a secret in the content of your API request.' +intro: Learn your options for unblocking your push to {% data variables.product.prodname_dotcom %} using the REST API if {% data variables.product.prodname_secret_scanning %} detects a secret in the content of your API request. permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: feature: secret-scanning-push-protection-content-endpoints -type: how_to topics: - Secret scanning - Secret Protection - Alerts - Repositories +redirect_from: + - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api +contentType: concepts --- ## About push protection from the REST API diff --git a/content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale.md b/content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md similarity index 94% rename from content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale.md rename to content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md index adab203f4061..a0018c57f237 100644 --- a/content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale.md +++ b/content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md @@ -1,7 +1,7 @@ --- title: About enabling security features at scale -shortTitle: About organization security -intro: 'You can quickly secure your organization at scale with {% data variables.product.prodname_security_configurations %} and {% data variables.product.prodname_global_settings %}.' +shortTitle: Organization security +intro: You can quickly secure your organization at scale with {% data variables.product.prodname_security_configurations %} and {% data variables.product.prodname_global_settings %}. versions: feature: security-configurations topics: @@ -9,6 +9,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale +contentType: concepts --- ## About securing your organization diff --git a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/about-security-campaigns.md b/content/code-security/concepts/security-at-scale/about-security-campaigns.md similarity index 94% rename from content/code-security/securing-your-organization/fixing-security-alerts-at-scale/about-security-campaigns.md rename to content/code-security/concepts/security-at-scale/about-security-campaigns.md index b2eb14d899b3..19e3654ff130 100644 --- a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/about-security-campaigns.md +++ b/content/code-security/concepts/security-at-scale/about-security-campaigns.md @@ -1,10 +1,9 @@ --- -title: 'About security campaigns' -shortTitle: 'About security campaigns' -intro: 'You can fix security alerts at scale by creating security campaigns and collaborating with developers to burn down your security backlog.' +title: About security campaigns +shortTitle: Security campaigns +intro: You can fix security alerts at scale by creating security campaigns and collaborating with developers to burn down your security backlog. product: '{% data reusables.gated-features.security-campaigns %}' allowTitleToDifferFromFilename: true -type: overview audience: - driver contentType: concepts @@ -15,6 +14,8 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/fixing-security-alerts-at-scale/about-security-campaigns --- Once you have identified security alerts the next step is to identify the most urgent alerts and get them fixed. Security campaigns are a way to group alerts and share them with developers, so you can collaborate to remediate vulnerabilities in the code{% ifversion security-campaigns-secrets %} and any exposed secrets{% endif %}. diff --git a/content/admin/managing-code-security/securing-your-enterprise/about-security-configurations.md b/content/code-security/concepts/security-at-scale/about-security-configurations.md similarity index 92% rename from content/admin/managing-code-security/securing-your-enterprise/about-security-configurations.md rename to content/code-security/concepts/security-at-scale/about-security-configurations.md index 5e2269fe1e97..d79d163110db 100644 --- a/content/admin/managing-code-security/securing-your-enterprise/about-security-configurations.md +++ b/content/code-security/concepts/security-at-scale/about-security-configurations.md @@ -1,13 +1,16 @@ --- title: About security configurations shortTitle: Security configurations -intro: 'Security configurations are collections of security settings that you can apply across your enterprise.' +intro: Security configurations are collections of security settings that you can apply across your enterprise. versions: feature: security-configuration-enterprise-level topics: - Advanced Security - Enterprise - Security +redirect_from: + - /admin/managing-code-security/securing-your-enterprise/about-security-configurations +contentType: concepts --- ## About {% data variables.product.prodname_security_configurations %} diff --git a/content/code-security/security-overview/about-security-overview.md b/content/code-security/concepts/security-at-scale/about-security-overview.md similarity index 96% rename from content/code-security/security-overview/about-security-overview.md rename to content/code-security/concepts/security-at-scale/about-security-overview.md index 425c5034f324..69d0d9af7264 100644 --- a/content/code-security/security-overview/about-security-overview.md +++ b/content/code-security/concepts/security-at-scale/about-security-overview.md @@ -1,6 +1,7 @@ --- title: About security overview -intro: 'You can gain insights into the overall security landscape of your organization or enterprise and identify repositories that require intervention using security overview.' +shortTitle: Security overview +intro: You can gain insights into the overall security landscape of your organization or enterprise and identify repositories that require intervention using security overview. product: | {% data reusables.gated-features.security-overview-general %}{% ifversion secret-risk-assessment %} @@ -8,11 +9,12 @@ product: | redirect_from: - /code-security/security-overview/exploring-security-alerts - /code-security/security-overview/about-the-security-overview + - /code-security/security-overview/about-security-overview + - /code-security/security-overview versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Security overview - Code Security @@ -23,6 +25,7 @@ topics: - Organizations - Secret scanning - Teams +contentType: concepts --- {% ifversion fpt %} @@ -140,7 +143,7 @@ If you're an owner of an {% data variables.enterprise.prodname_emu_enterprise %} ## Further reading -* [AUTOTITLE](/code-security/getting-started/securing-your-repository){% ifversion security-configurations %} -* [AUTOTITLE](/code-security/securing-your-organization){% else %} -* [AUTOTITLE](/code-security/getting-started/quickstart-for-securing-your-organization){% endif %} +* [AUTOTITLE](/code-security/getting-started/securing-your-repository){% ifversion fpt or ghec %} +* [AUTOTITLE](/code-security/securing-your-organization){% elsif ghes %} +* [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage){% endif %} * [AUTOTITLE](/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale) diff --git a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/about-supply-chain-security-for-your-enterprise.md b/content/code-security/concepts/security-at-scale/about-supply-chain-security-for-your-enterprise.md similarity index 89% rename from content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/about-supply-chain-security-for-your-enterprise.md rename to content/code-security/concepts/security-at-scale/about-supply-chain-security-for-your-enterprise.md index d0d39008a3c2..e5b19841d439 100644 --- a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/about-supply-chain-security-for-your-enterprise.md +++ b/content/code-security/concepts/security-at-scale/about-supply-chain-security-for-your-enterprise.md @@ -1,17 +1,18 @@ --- title: About supply chain security for your enterprise intro: You can enable features that help your developers understand and update the dependencies their code relies on. -shortTitle: About supply chain security +shortTitle: Supply chain security permissions: '' versions: ghes: '*' -type: how_to topics: - Enterprise - Security - Dependency graph redirect_from: - /admin/code-security/managing-supply-chain-security-for-your-enterprise/about-supply-chain-security-for-your-enterprise + - /admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/about-supply-chain-security-for-your-enterprise +contentType: concepts --- You can allow users to identify their projects' dependencies by enabling the dependency graph for {% data variables.product.prodname_ghe_server %}. For more information, see [Enabling the dependency graph for your enterprise](/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise). diff --git a/content/code-security/getting-started/auditing-security-alerts.md b/content/code-security/concepts/security-at-scale/auditing-security-alerts.md similarity index 98% rename from content/code-security/getting-started/auditing-security-alerts.md rename to content/code-security/concepts/security-at-scale/auditing-security-alerts.md index 828b49091621..76ed72fece18 100644 --- a/content/code-security/getting-started/auditing-security-alerts.md +++ b/content/code-security/concepts/security-at-scale/auditing-security-alerts.md @@ -5,7 +5,6 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Repositories - Dependencies @@ -14,6 +13,9 @@ topics: - Code Security - Secret Protection shortTitle: Audit security alerts +redirect_from: + - /code-security/getting-started/auditing-security-alerts +contentType: concepts --- ## About security tools for auditors diff --git a/content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/choosing-a-security-configuration-for-your-repositories.md b/content/code-security/concepts/security-at-scale/choosing-a-security-configuration-for-your-repositories.md similarity index 91% rename from content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/choosing-a-security-configuration-for-your-repositories.md rename to content/code-security/concepts/security-at-scale/choosing-a-security-configuration-for-your-repositories.md index 0711ce802aa5..b2cf2064d4b6 100644 --- a/content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/choosing-a-security-configuration-for-your-repositories.md +++ b/content/code-security/concepts/security-at-scale/choosing-a-security-configuration-for-your-repositories.md @@ -1,7 +1,7 @@ --- title: Choosing a security configuration for your repositories shortTitle: Choose security configuration -intro: 'Find out which type of {% data variables.product.prodname_security_configuration %} will meet the security needs of the repositories in your organization.' +intro: Find out which type of {% data variables.product.prodname_security_configuration %} will meet the security needs of the repositories in your organization. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations-cloud @@ -10,6 +10,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/choosing-a-security-configuration-for-your-repositories +contentType: concepts --- ## About choosing a {% data variables.product.prodname_security_configuration %} diff --git a/content/code-security/concepts/security-at-scale/index.md b/content/code-security/concepts/security-at-scale/index.md new file mode 100644 index 000000000000..0ddf7dc5070a --- /dev/null +++ b/content/code-security/concepts/security-at-scale/index.md @@ -0,0 +1,30 @@ +--- +title: Concepts for security at scale +shortTitle: Security at scale +intro: Learn about the concepts behind managing code security at scale in your organization or enterprise. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Secret Protection + - Organizations + - Security + - Advanced Security + - Enterprise +contentType: concepts +children: + - /about-enabling-security-features-at-scale + - /about-security-configurations + - /choosing-a-security-configuration-for-your-repositories + - /about-security-overview + - /about-security-campaigns + - /auditing-security-alerts + - /about-supply-chain-security-for-your-enterprise +redirect_from: + - /admin/managing-code-security/managing-supply-chain-security-for-your-enterprise + - /admin/code-security/managing-supply-chain-security-for-your-enterprise + - /admin/managing-code-security/securing-your-enterprise + - /code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale +--- diff --git a/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md b/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md new file mode 100644 index 000000000000..8d24d59b6d75 --- /dev/null +++ b/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md @@ -0,0 +1,82 @@ +--- +title: About Dependabot alerts +intro: '{% data variables.product.prodname_dependabot_alerts %} help you find and fix vulnerable dependencies before they become security risks.' +product: '{% data reusables.gated-features.dependabot-alerts %}' +redirect_from: + - /articles/about-security-alerts-for-vulnerable-dependencies + - /github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies + - /github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies + - /code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies + - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies + - /code-security/dependabot/dependabot-alerts/about-dependabot-alerts +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Dependabot + - Alerts + - Vulnerabilities + - Repositories + - Dependencies +shortTitle: Dependabot alerts +contentType: concepts +--- + +Software often relies on packages from various sources, creating dependency relationships that can unknowingly introduce security vulnerabilities. When your code depends on packages with known security vulnerabilities, you become a target for attackers seeking to exploit your system—potentially gaining access to your code, data, customers, or contributors. {% data variables.product.prodname_dependabot_alerts %} notify you about vulnerable dependencies so you can upgrade to secure versions and protect your project. + +## When {% data variables.product.prodname_dependabot %} sends alerts + +{% data variables.product.prodname_dependabot %} scans your repository's default branch and sends alerts when: + +{% ifversion fpt or ghec %} +* A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}{% else %} +* New advisory data is synchronized to {% data variables.product.prodname_dotcom %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} +* Your dependency graph changes—for example, when you push commits that update packages or versions + +For supported ecosystems, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems#supported-package-ecosystems). + +## Understanding alerts + +When {% data variables.product.github %} detects a vulnerable dependency, a {% data variables.product.prodname_dependabot %} alert appears on the repository's **Security** tab and dependency graph. Each alert includes: + +* A link to the affected file +* Details about the vulnerability and its severity +* Information about a fixed version (when available) + +For information about notifications, viewing, and managing alerts, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts). + +## Enabling alerts + +Repository administrators and organization owners can enable {% data variables.product.prodname_dependabot_alerts %} for their repositories{% ifversion fpt or ghec %} and organizations{% endif %}. When enabled, {% data variables.product.github %} immediately generates the dependency graph and creates alerts for any vulnerable dependencies it identifies. By default, people with write, maintain, or admin permissions receive notifications.{% ifversion fpt or ghec %} Repository administrators can grant access to additional people or teams.{% endif %} + +{% data reusables.repositories.enable-security-alerts %} + +See [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts). + +## Limitations + +{% data variables.product.prodname_dependabot_alerts %} have some limitations: + +* Alerts can't catch every security issue. Always review your dependencies and keep manifest and lock files up to date for accurate detection. +* New vulnerabilities may take time to appear in the {% data variables.product.prodname_advisory_database %} and trigger alerts. +* Only advisories reviewed by {% data variables.product.github %} trigger alerts. +* {% data variables.product.prodname_dependabot %} doesn't scan archived repositories. +* {% data variables.product.prodname_dependabot %} doesn't generate alerts for malware. +* {% data reusables.dependabot.dependabot-alert-actions-semver %} + +{% ifversion fpt or ghec %}{% data variables.product.github %} never publicly discloses vulnerabilities for any repository. {% endif %} + +{% ifversion copilot-chat-ghas-alerts %} + +## Asking {% data variables.copilot.copilot_chat %} about alerts + +With a {% data variables.copilot.copilot_enterprise %} license, you can ask {% data variables.copilot.copilot_chat_short %} questions about {% data variables.product.prodname_dependabot_alerts %} in your organization's repositories. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features). + +{% endif %} + +## Further reading + +* [AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts) +* [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates) +* [AUTOTITLE](/code-security/getting-started/auditing-security-alerts) diff --git a/content/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules.md b/content/code-security/concepts/supply-chain-security/about-dependabot-auto-triage-rules.md similarity index 96% rename from content/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules.md rename to content/code-security/concepts/supply-chain-security/about-dependabot-auto-triage-rules.md index d71ae8559afb..a4df89b333ab 100644 --- a/content/code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules.md +++ b/content/code-security/concepts/supply-chain-security/about-dependabot-auto-triage-rules.md @@ -6,17 +6,19 @@ versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Dependabot - Alerts - Vulnerabilities - Repositories - Dependencies -shortTitle: About auto-triage rules +shortTitle: Dependabot auto-triage rules redirect_from: - /code-security/dependabot/dependabot-alerts/using-alert-rules-to-prioritize-dependabot-alerts - /code-security/dependabot/dependabot-alert-rules/about-dependabot-alert-rules + - /code-security/dependabot/dependabot-auto-triage-rules/about-dependabot-auto-triage-rules + - /code-security/dependabot/dependabot-auto-triage-rules +contentType: concepts --- ## About {% data variables.dependabot.auto_triage_rules %} diff --git a/content/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners.md b/content/code-security/concepts/supply-chain-security/about-dependabot-on-github-actions-runners.md similarity index 98% rename from content/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners.md rename to content/code-security/concepts/supply-chain-security/about-dependabot-on-github-actions-runners.md index 611dfdded5c2..a836eb578a65 100644 --- a/content/code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners.md +++ b/content/code-security/concepts/supply-chain-security/about-dependabot-on-github-actions-runners.md @@ -1,11 +1,10 @@ --- title: About Dependabot on GitHub Actions runners intro: '{% data variables.product.prodname_dotcom %} automatically runs the jobs that generate {% data variables.product.prodname_dependabot %} pull requests on {% data variables.product.prodname_actions %} if you have {% data variables.product.prodname_actions %} enabled for the repository. When {% data variables.product.prodname_dependabot %} is enabled, these jobs will run by bypassing Actions policy checks and disablement at the repository or organization level.' -shortTitle: About Dependabot on Actions +shortTitle: Dependabot on Actions product: '{% data reusables.gated-features.dependabot-on-actions %}' versions: feature: dependabot-on-actions-opt-in -type: how_to topics: - Dependabot - Security updates @@ -13,6 +12,9 @@ topics: - Actions - Dependencies - Repositories +redirect_from: + - /code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners +contentType: concepts --- ## About {% data variables.product.prodname_dependabot %} on {% data variables.product.prodname_actions %} runners diff --git a/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md b/content/code-security/concepts/supply-chain-security/about-dependabot-security-updates.md similarity index 98% rename from content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md rename to content/code-security/concepts/supply-chain-security/about-dependabot-security-updates.md index 641be85859d0..92278743715e 100644 --- a/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md +++ b/content/code-security/concepts/supply-chain-security/about-dependabot-security-updates.md @@ -8,11 +8,11 @@ redirect_from: - /github/managing-security-vulnerabilities/about-dependabot-security-updates - /code-security/supply-chain-security/about-dependabot-security-updates - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-dependabot-security-updates + - /code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Dependabot - Security updates @@ -20,6 +20,7 @@ topics: - Repositories - Dependencies - Pull requests +contentType: concepts --- diff --git a/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md b/content/code-security/concepts/supply-chain-security/about-dependabot-version-updates.md similarity index 92% rename from content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md rename to content/code-security/concepts/supply-chain-security/about-dependabot-version-updates.md index 32dc812632ee..479454039982 100644 --- a/content/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates.md +++ b/content/code-security/concepts/supply-chain-security/about-dependabot-version-updates.md @@ -1,6 +1,6 @@ --- title: About Dependabot version updates -intro: 'You can use {% data variables.product.prodname_dependabot %} to keep the packages you use updated to the latest versions.' +intro: You can use {% data variables.product.prodname_dependabot %} to keep the packages you use updated to the latest versions. product: '{% data reusables.gated-features.dependabot-version-updates %}' redirect_from: - /github/administering-a-repository/about-dependabot @@ -10,11 +10,13 @@ redirect_from: - /code-security/supply-chain-security/about-dependabot-version-updates - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/upgrading-from-dependabotcom-to-github-native-dependabot - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates + - /code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates + - /code-security/dependabot/dependabot-version-updates + - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Dependabot - Version updates @@ -22,6 +24,7 @@ topics: - Dependencies - Pull requests shortTitle: Dependabot version updates +contentType: concepts --- {% data reusables.dependabot.enterprise-enable-dependabot %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md b/content/code-security/concepts/supply-chain-security/about-dependency-review.md similarity index 96% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md rename to content/code-security/concepts/supply-chain-security/about-dependency-review.md index e850217b2203..8759beed9469 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md +++ b/content/code-security/concepts/supply-chain-security/about-dependency-review.md @@ -1,13 +1,12 @@ --- title: About dependency review -intro: 'Dependency review lets you catch insecure dependencies before you introduce them to your environment, and provides information on license, dependents, and age of dependencies.' +intro: Dependency review lets you catch insecure dependencies before you introduce them to your environment, and provides information on license, dependents, and age of dependencies. product: '{% data reusables.gated-features.dependency-review %}' shortTitle: Dependency review versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Code Security - Dependency review @@ -16,6 +15,8 @@ topics: - Pull requests redirect_from: - /code-security/supply-chain-security/about-dependency-review + - /code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review +contentType: concepts --- ## About dependency review diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security.md b/content/code-security/concepts/supply-chain-security/about-supply-chain-security.md similarity index 99% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security.md rename to content/code-security/concepts/supply-chain-security/about-supply-chain-security.md index 4d2990608701..fdf9ad43a1e9 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security.md +++ b/content/code-security/concepts/supply-chain-security/about-supply-chain-security.md @@ -1,14 +1,14 @@ --- title: About supply chain security intro: '{% data variables.product.github %} helps you secure your supply chain, from understanding the dependencies in your environment, to knowing about vulnerabilities in those dependencies, and patching them.' -shortTitle: Supply chain security +shortTitle: Supply chain features redirect_from: - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies + - /code-security/supply-chain-security/understanding-your-software-supply-chain/about-supply-chain-security versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Code Security - Dependency review @@ -17,6 +17,7 @@ topics: - Dependencies - Pull requests - Repositories +contentType: concepts --- ## About supply chain security at GitHub diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md b/content/code-security/concepts/supply-chain-security/about-the-dependency-graph.md similarity index 97% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md rename to content/code-security/concepts/supply-chain-security/about-the-dependency-graph.md index cd928cdf98f6..f12a8b42bb6e 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md +++ b/content/code-security/concepts/supply-chain-security/about-the-dependency-graph.md @@ -5,16 +5,17 @@ product: '{% data reusables.gated-features.dependency-graph %}' redirect_from: - /github/visualizing-repository-data-with-graphs/about-the-dependency-graph - /code-security/supply-chain-security/about-the-dependency-graph + - /code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Dependency graph - Dependencies - Repositories shortTitle: Dependency graph +contentType: concepts --- diff --git a/content/code-security/dependabot/maintain-dependencies/best-practices-for-maintaining-dependencies.md b/content/code-security/concepts/supply-chain-security/best-practices-for-maintaining-dependencies.md similarity index 96% rename from content/code-security/dependabot/maintain-dependencies/best-practices-for-maintaining-dependencies.md rename to content/code-security/concepts/supply-chain-security/best-practices-for-maintaining-dependencies.md index 8283cef2a3d9..b01fe39fe2d6 100644 --- a/content/code-security/dependabot/maintain-dependencies/best-practices-for-maintaining-dependencies.md +++ b/content/code-security/concepts/supply-chain-security/best-practices-for-maintaining-dependencies.md @@ -1,12 +1,11 @@ --- title: Best practices for maintaining dependencies -intro: 'Guidance and recommendations for maintaining the dependencies you use, including {% data variables.product.github %}''s security products that can help.' +intro: Guidance and recommendations for maintaining the dependencies you use, including {% data variables.product.github %}'s security products that can help. allowTitleToDifferFromFilename: true versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Security updates @@ -14,7 +13,10 @@ topics: - Repositories - Dependencies - Pull requests -shortTitle: Dependency management best practices +shortTitle: Dependency best practices +redirect_from: + - /code-security/dependabot/maintain-dependencies/best-practices-for-maintaining-dependencies +contentType: concepts --- ## Best practices for maintaining dependencies diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases.md b/content/code-security/concepts/supply-chain-security/immutable-releases.md similarity index 90% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases.md rename to content/code-security/concepts/supply-chain-security/immutable-releases.md index 9237a2f5bff0..69926d385f8c 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases.md +++ b/content/code-security/concepts/supply-chain-security/immutable-releases.md @@ -1,14 +1,16 @@ --- title: Immutable releases -intro: 'Learn about immutable releases and how they can help you maintain the integrity of your software supply chain.' +intro: Learn about immutable releases and how they can help you maintain the integrity of your software supply chain. versions: fpt: '*' ghec: '*' -type: overview topics: - Code Security - Vulnerabilities - Dependencies +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/immutable-releases +contentType: concepts --- **Immutable releases** are releases where the assets and associated Git tag cannot be changed after publication. The use of this type of release increases security by blocking supply chain attacks. Attackers cannot: diff --git a/content/code-security/concepts/supply-chain-security/index.md b/content/code-security/concepts/supply-chain-security/index.md new file mode 100644 index 000000000000..a36c4d78ab51 --- /dev/null +++ b/content/code-security/concepts/supply-chain-security/index.md @@ -0,0 +1,22 @@ +--- +title: Supply chain security +intro: '{% data variables.product.github %}''s security features help you keep track of your projects'' dependencies and built artifacts.' +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: concepts +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain +children: + - about-supply-chain-security + - best-practices-for-maintaining-dependencies + - about-the-dependency-graph + - about-dependency-review + - about-dependabot-alerts + - about-dependabot-security-updates + - about-dependabot-version-updates + - about-dependabot-auto-triage-rules + - about-dependabot-on-github-actions-runners + - immutable-releases +--- diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities.md b/content/code-security/concepts/vulnerability-reporting-and-management/about-coordinated-disclosure-of-security-vulnerabilities.md similarity index 98% rename from content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities.md rename to content/code-security/concepts/vulnerability-reporting-and-management/about-coordinated-disclosure-of-security-vulnerabilities.md index e81845badbaa..bf207bd74fc4 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/about-coordinated-disclosure-of-security-vulnerabilities.md @@ -6,10 +6,11 @@ redirect_from: - /code-security/repository-security-advisories/about-coordinated-disclosure-of-security-vulnerabilities - /code-security/security-advisories/repository-security-advisories/about-coordinated-disclosure-of-security-vulnerabilities - /code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities + - /code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities versions: fpt: '*' ghec: '*' -type: overview +contentType: concepts topics: - Security advisories - Vulnerabilities diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories.md b/content/code-security/concepts/vulnerability-reporting-and-management/about-global-security-advisories.md similarity index 83% rename from content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories.md rename to content/code-security/concepts/vulnerability-reporting-and-management/about-global-security-advisories.md index ca1bd0286f7b..f8eb2afc3773 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/about-global-security-advisories.md @@ -1,11 +1,12 @@ --- title: About global security advisories -intro: 'Global security advisories live in the {% data variables.product.prodname_advisory_database %}, a collection of CVEs and {% data variables.product.company_short %}-originated advisories affecting the open source world. You can contribute to improving global security advisories.' +shortTitle: Global security advisories +intro: Global security advisories live in the {% data variables.product.prodname_advisory_database %}, a collection of CVEs and {% data variables.product.company_short %}-originated advisories affecting the open source world. You can contribute to improving global security advisories. versions: fpt: '*' ghec: '*' ghes: '*' -type: overview +contentType: concepts topics: - Security advisories - Alerts @@ -13,6 +14,7 @@ topics: - CVEs redirect_from: - /code-security/security-advisories/global-security-advisories/about-global-security-advisories + - /code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories --- ## About global security advisories diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories.md b/content/code-security/concepts/vulnerability-reporting-and-management/about-repository-security-advisories.md similarity index 93% rename from content/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories.md rename to content/code-security/concepts/vulnerability-reporting-and-management/about-repository-security-advisories.md index 2a841ae8058c..4cc4b288de64 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/about-repository-security-advisories.md @@ -1,7 +1,7 @@ --- title: About repository security advisories -intro: 'You can use repository security advisories to privately discuss, fix, and publish information about security vulnerabilities in your public repository.' -shortTitle: About repository security advisories +intro: You can use repository security advisories to privately discuss, fix, and publish information about security vulnerabilities in your public repository. +shortTitle: Repository security advisories redirect_from: - /articles/about-maintainer-security-advisories - /github/managing-security-vulnerabilities/about-maintainer-security-advisories @@ -9,10 +9,11 @@ redirect_from: - /code-security/security-advisories/about-github-security-advisories - /code-security/repository-security-advisories/about-github-security-advisories-for-repositories - /code-security/security-advisories/repository-security-advisories/about-repository-security-advisories + - /code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories versions: fpt: '*' ghec: '*' -type: overview +contentType: concepts product: '{% data reusables.gated-features.private-vulnerability-reporting %}' topics: - Security advisories diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md b/content/code-security/concepts/vulnerability-reporting-and-management/about-the-github-advisory-database.md similarity index 97% rename from content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md rename to content/code-security/concepts/vulnerability-reporting-and-management/about-the-github-advisory-database.md index f0bc22d06690..24cf0c5fdd59 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/about-the-github-advisory-database.md @@ -5,7 +5,8 @@ versions: fpt: '*' ghec: '*' ghes: '*' -type: overview +contentType: concepts +shortTitle: GitHub Advisory database topics: - Security advisories - Alerts @@ -13,6 +14,7 @@ topics: - CVEs redirect_from: - /code-security/security-advisories/global-security-advisories/about-the-github-advisory-database + - /code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-the-github-advisory-database --- ## About the {% data variables.product.prodname_advisory_database %} diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/about-your-exposure-to-vulnerable-dependencies.md b/content/code-security/concepts/vulnerability-reporting-and-management/about-your-exposure-to-vulnerabilities-in-your-code-and-in-dependencies.md similarity index 95% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/about-your-exposure-to-vulnerable-dependencies.md rename to content/code-security/concepts/vulnerability-reporting-and-management/about-your-exposure-to-vulnerabilities-in-your-code-and-in-dependencies.md index 4333e57f5c62..695424c126c2 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/about-your-exposure-to-vulnerable-dependencies.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/about-your-exposure-to-vulnerabilities-in-your-code-and-in-dependencies.md @@ -1,7 +1,7 @@ --- title: About exposure to vulnerabilities in your code and in dependencies shortTitle: Vulnerability exposure -intro: 'Understanding your organization’s exposure to vulnerabilities in first-party code and in all dependencies is essential for enabling you to efficiently assess, prioritize, and remediate vulnerabilities, reducing the likelihood of security breaches.' +intro: Understanding your organization’s exposure to vulnerabilities in first-party code and in all dependencies is essential for enabling you to efficiently assess, prioritize, and remediate vulnerabilities, reducing the likelihood of security breaches. allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.ghas-billing %}' versions: @@ -14,6 +14,7 @@ topics: - Security redirect_from: - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/about-your-exposure-to-vulnerable-dependencies + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/about-your-exposure-to-vulnerable-dependencies --- ## About exposure to vulnerable code diff --git a/content/code-security/concepts/vulnerability-reporting-and-management/index.md b/content/code-security/concepts/vulnerability-reporting-and-management/index.md new file mode 100644 index 000000000000..569b4054157a --- /dev/null +++ b/content/code-security/concepts/vulnerability-reporting-and-management/index.md @@ -0,0 +1,18 @@ +--- +title: Concepts for vulnerability reporting and management +shortTitle: Vulnerability reporting +intro: Learn core concepts relating to vulnerability reporting and management on {% data variables.product.github %}. +versions: + fpt: '*' + ghec: '*' +topics: + - Security advisories + - Vulnerabilities +contentType: concepts +children: + - /about-the-github-advisory-database + - /about-repository-security-advisories + - /about-global-security-advisories + - /about-coordinated-disclosure-of-security-vulnerabilities + - /about-your-exposure-to-vulnerabilities-in-your-code-and-in-dependencies +--- diff --git a/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md deleted file mode 100644 index af2783255d32..000000000000 --- a/content/code-security/dependabot/dependabot-alerts/about-dependabot-alerts.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -title: About Dependabot alerts -intro: '{% data variables.product.github %} sends {% data variables.product.prodname_dependabot_alerts %} when we detect that your repository uses a vulnerable dependency.' -product: '{% data reusables.gated-features.dependabot-alerts %}' -redirect_from: - - /articles/about-security-alerts-for-vulnerable-dependencies - - /github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies - - /github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies - - /code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies - - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/about-alerts-for-vulnerable-dependencies -versions: - fpt: '*' - ghes: '*' - ghec: '*' -type: overview -topics: - - Dependabot - - Alerts - - Vulnerabilities - - Repositories - - Dependencies -shortTitle: Dependabot alerts ---- - - -{% data variables.product.prodname_dependabot_alerts %} tell you when your code depends on a package that is insecure. Often, software is built using open-source code packages from a large variety of sources. The complex relationships between these dependencies, and the ease with which malicious actors can insert malware into upstream code, mean that you may unknowingly be using dependencies that have security flaws, also known as vulnerabilities. - -If your code depends on a package with a security vulnerability, this can cause a range of problems for your project or the people who use it. Using a vulnerable package makes you a soft target for malicious users looking to exploit your system. For example, they may seek to get access to your code and data from your customers or contributors. You should upgrade to a secure version of the package as soon as possible. If your code uses malware, you need to replace the package with a secure alternative. - -{% data reusables.dependabot.no-dependabot-alerts-for-malware %} - -{% data reusables.dependabot.quickstart-link %} - -## Detection of insecure dependencies - -{% data variables.product.prodname_dependabot %} performs a scan of the default branch of your repository to detect insecure dependencies, and sends {% data variables.product.prodname_dependabot_alerts %} when: - -{% ifversion fpt or ghec %} -* A new advisory is added to 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/browsing-security-advisories-in-the-github-advisory-database).{% else %} - -* New advisory data is synchronized to {% data variables.product.prodname_dotcom %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %} - - > [!NOTE] - > Only advisories that have been reviewed by {% data variables.product.company_short %} will trigger {% data variables.product.prodname_dependabot_alerts %}. - -* The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% ifversion fpt or ghec %}, or when the code of one of the dependencies changes{% endif %}. For more information, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph). - -> [!NOTE] -> {% data variables.product.prodname_dependabot %} doesn't scan archived repositories. - -{% data reusables.repositories.dependency-review %} - -As {% data variables.product.prodname_dependabot_alerts %} rely on the dependency graph, the ecosystems that are supported by {% data variables.product.prodname_dependabot_alerts %} are the same as those supported by the dependency graph. For a list of these ecosystems, see [AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems#supported-package-ecosystems). - -> [!NOTE] -> It is important to keep your manifest and lock files up to date. If the dependency graph doesn't accurately reflect your current dependencies and versions, then you could miss alerts for insecure dependencies that you use. You may also get alerts for dependencies that you no longer use. - -{% data reusables.dependabot.dependabot-alert-actions-semver %} - -## Configuration of {% data variables.product.prodname_dependabot_alerts %} - -{% data reusables.repositories.enable-security-alerts %} - -{% ifversion fpt or ghec %}Repository owners or people with admin access can enable {% data variables.product.prodname_dependabot_alerts %} for their repositories. You can also enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your user account or organization. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts). - -For information about access requirements for actions related to {% data variables.product.prodname_dependabot_alerts %}, see [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#access-requirements-for-security-features). - -{% data variables.product.github %} starts generating the dependency graph immediately and generates alerts for any insecure dependencies as soon as they are identified. The graph is usually populated within minutes but this may take longer for repositories with many dependencies. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#enabling-or-disabling-security-and-analysis-features-for-private-repositories). -{% endif %} - -When {% data variables.product.github %} identifies a vulnerable dependency, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the **Security** tab for the repository and in the repository's dependency graph. The alert includes a link to the affected file in the project, and information about a fixed version. - -{% data variables.product.github %} may also notify the maintainers of affected repositories about new alerts according to their notification preferences. When {% data variables.product.prodname_dependabot %} is first enabled, {% data variables.product.github %} does not send notifications for all vulnerable dependencies found in your repository, only for new vulnerable dependencies identified after {% data variables.product.prodname_dependabot %} is enabled. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts). - -{% data reusables.dependabot.dependabot-alert-create-PR %} - -{% data reusables.dependabot.dependabot-alert-rules %} - -> [!WARNING] -> {% data variables.product.github %}'s security features do not claim to catch all vulnerabilities. We actively maintain {% data variables.product.prodname_advisory_database %} and generate alerts with the most up-to-date information. However, we cannot catch everything or tell you about known vulnerabilities within a guaranteed time frame. These features are not substitutes for human review of each dependency for potential vulnerabilities or any other issues, and we recommend consulting with a security service or conducting a thorough dependency review when necessary. - -## Access to {% data variables.product.prodname_dependabot_alerts %} - -You can see all of the alerts that affect a particular project{% ifversion fpt or ghec %} on the repository's **Security** tab or{% endif %} in the repository's dependency graph. For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts). - -By default, we notify people with write, maintain, or admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}. {% ifversion fpt or ghec %}{% data variables.product.github %} never publicly discloses insecure dependencies for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working with repositories that you own or have admin permissions for. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts). -{% endif %} - -{% data reusables.notifications.vulnerable-dependency-notification-enable %} -{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} For more information, see [AUTOTITLE](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts). - -You can also see all the {% data variables.product.prodname_dependabot_alerts %} that correspond to a particular advisory in the {% data variables.product.prodname_advisory_database %}. {% data reusables.security-advisory.link-browsing-advisory-db %} - -{% ifversion copilot-chat-ghas-alerts %} - -## Asking {% data variables.copilot.copilot_chat %} about {% data variables.product.prodname_dependabot_alerts %} - -With a {% data variables.copilot.copilot_enterprise %} license, you can ask {% data variables.copilot.copilot_chat_short %} for help to better understand security alerts, including {% data variables.product.prodname_dependabot_alerts %}, in repositories in your organization. For more information, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom#asking-questions-about-alerts-from-github-advanced-security-features). - -{% endif %} - -## Further reading - -* [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates) -* [AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts) -* [AUTOTITLE](/code-security/getting-started/auditing-security-alerts) -{% ifversion fpt or ghec %}- [AUTOTITLE](/get-started/privacy-on-github){% endif %} diff --git a/content/code-security/dependabot/dependabot-alerts/index.md b/content/code-security/dependabot/dependabot-alerts/index.md deleted file mode 100644 index ddccbfa0b753..000000000000 --- a/content/code-security/dependabot/dependabot-alerts/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Identifying vulnerabilities in your project's dependencies with Dependabot alerts -shortTitle: Dependabot alerts -intro: '{% data variables.product.prodname_dependabot %} generates {% data variables.product.prodname_dependabot_alerts %} when known vulnerabilities are detected in dependencies that your project uses.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Dependabot - - Alerts - - Vulnerabilities - - Repositories - - Dependencies -children: - - /about-dependabot-alerts - - /configuring-dependabot-alerts - - /viewing-and-updating-dependabot-alerts - - /enable-delegated-alert-dismissal - - /configuring-notifications-for-dependabot-alerts ---- diff --git a/content/code-security/dependabot/dependabot-auto-triage-rules/index.md b/content/code-security/dependabot/dependabot-auto-triage-rules/index.md deleted file mode 100644 index 8a7200672013..000000000000 --- a/content/code-security/dependabot/dependabot-auto-triage-rules/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Prioritizing Dependabot alerts with Dependabot auto-triage rules -shortTitle: Dependabot auto-triage rules -intro: 'You can use {% data variables.dependabot.auto_triage_rules %} to prioritize {% data variables.product.prodname_dependabot_alerts %}.' -allowTitleToDifferFromFilename: true -versions: - feature: dependabot-auto-triage-rules -topics: - - Dependabot - - Alerts - - Vulnerabilities - - Repositories - - Dependencies -children: - - /about-dependabot-auto-triage-rules - - /using-github-preset-rules-to-prioritize-dependabot-alerts - - /customizing-auto-triage-rules-to-prioritize-dependabot-alerts - - /managing-automatically-dismissed-alerts -redirect_from: - - /code-security/dependabot/dependabot-alert-rules ---- diff --git a/content/code-security/dependabot/dependabot-security-updates/index.md b/content/code-security/dependabot/dependabot-security-updates/index.md deleted file mode 100644 index 3877a1c866f8..000000000000 --- a/content/code-security/dependabot/dependabot-security-updates/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Automatically updating dependencies with known vulnerabilities with Dependabot security updates -intro: '{% data variables.product.prodname_dependabot %} can help you fix vulnerable dependencies by automatically raising pull requests to update dependencies to secure versions.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Repositories - - Dependabot - - Security updates - - Dependencies - - Pull requests -shortTitle: Dependabot security updates -children: - - /about-dependabot-security-updates - - /configuring-dependabot-security-updates - - /customizing-dependabot-security-prs ---- diff --git a/content/code-security/dependabot/dependabot-version-updates/index.md b/content/code-security/dependabot/dependabot-version-updates/index.md deleted file mode 100644 index 366ec0da3382..000000000000 --- a/content/code-security/dependabot/dependabot-version-updates/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Keeping your dependencies updated automatically with Dependabot version updates -intro: 'You can use {% data variables.product.prodname_dependabot %} to automatically keep the dependencies and packages used in your repository updated to the latest version, even when they don’t have any known vulnerabilities.' -allowTitleToDifferFromFilename: true -redirect_from: - - /github/administering-a-repository/keeping-your-dependencies-updated-automatically - - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically - - /github/administering-a-repository/customizing-dependency-updates - - /code-security/supply-chain-security/customizing-dependency-updates - - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/customizing-dependency-updates - - /code-security/dependabot/dependabot-version-updates/customizing-dependency-updates -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Repositories - - Dependabot - - Version updates - - Dependencies - - Pull requests -children: - - /about-dependabot-version-updates - - /configuring-dependabot-version-updates - - /optimizing-pr-creation-version-updates - - /customizing-dependabot-prs - - /controlling-dependencies-updated -shortTitle: Dependabot version updates ---- diff --git a/content/code-security/dependabot/ecosystems-supported-by-dependabot/index.md b/content/code-security/dependabot/ecosystems-supported-by-dependabot/index.md deleted file mode 100644 index 31e4a7abaf60..000000000000 --- a/content/code-security/dependabot/ecosystems-supported-by-dependabot/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Ecosystems supported by Dependabot -intro: '{% data variables.product.prodname_dependabot %} supports a wide range of ecosystems to help keep your code secure' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Dependabot - - Dependencies - - Alerts - - Vulnerabilities - - Repositories -shortTitle: Dependabot ecosystems -children: - - /supported-ecosystems-and-repositories - - /optimizing-java-packages-dependabot ---- diff --git a/content/code-security/dependabot/index.md b/content/code-security/dependabot/index.md deleted file mode 100644 index 16246ea41cea..000000000000 --- a/content/code-security/dependabot/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Keeping your supply chain secure with Dependabot -shortTitle: Dependabot -intro: 'Monitor vulnerabilities in dependencies used in your project and keep your dependencies up-to-date with {% data variables.product.prodname_dependabot %}.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Dependabot - - Alerts - - Vulnerabilities - - Repositories - - Dependencies -children: - - /ecosystems-supported-by-dependabot - - /dependabot-alerts - - /dependabot-auto-triage-rules - - /dependabot-security-updates - - /dependabot-version-updates - - /working-with-dependabot - - /maintain-dependencies - - /troubleshooting-dependabot ---- diff --git a/content/code-security/dependabot/maintain-dependencies/index.md b/content/code-security/dependabot/maintain-dependencies/index.md deleted file mode 100644 index 7d4d9152d503..000000000000 --- a/content/code-security/dependabot/maintain-dependencies/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Maintaining dependencies at scale -shortTitle: Maintain dependencies at scale -intro: 'You can use {% data variables.product.prodname_dependabot %} to automatically update your dependencies for your repositories and organizations.' -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Dependabot - - Organizations - - Security - - Dependencies -children: - - /best-practices-for-maintaining-dependencies - - /managing-dependabot-on-self-hosted-runners - - /removing-dependabot-access-to-public-registries ---- diff --git a/content/code-security/dependabot/troubleshooting-dependabot/index.md b/content/code-security/dependabot/troubleshooting-dependabot/index.md deleted file mode 100644 index 3ca1c139c11d..000000000000 --- a/content/code-security/dependabot/troubleshooting-dependabot/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Troubleshooting Dependabot -intro: 'If you have problems with {% data variables.product.prodname_dependabot %}, you can use tips in these articles to help resolve issues.' -allowTitleToDifferFromFilename: true -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Dependabot - - Dependencies - - Alerts - - Vulnerabilities - - Repositories -shortTitle: Troubleshoot Dependabot -children: - - /listing-dependencies-configured-for-version-updates - - /viewing-dependabot-job-logs - - /dependabot-updates-stopped - - /troubleshooting-dependabot-errors - - /troubleshooting-dependabot-on-github-actions - - /troubleshooting-the-detection-of-vulnerable-dependencies ---- diff --git a/content/code-security/dependabot/working-with-dependabot/index.md b/content/code-security/dependabot/working-with-dependabot/index.md deleted file mode 100644 index d2439e60ec4b..000000000000 --- a/content/code-security/dependabot/working-with-dependabot/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Working with Dependabot -shortTitle: Work with Dependabot -intro: 'Guidance and recommendations for working with {% data variables.product.prodname_dependabot %}, such as managing pull requests raised by {% data variables.product.prodname_dependabot %}, using {% data variables.product.prodname_actions %} with {% data variables.product.prodname_dependabot %}, and troubleshooting {% data variables.product.prodname_dependabot %} errors.' -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Repositories - - Dependabot - - Version updates - - Security updates - - Dependencies - - Pull requests -children: - - /managing-pull-requests-for-dependency-updates - - /about-dependabot-on-github-actions-runners - - /automating-dependabot-with-github-actions - - /keeping-your-actions-up-to-date-with-dependabot - - /configuring-access-to-private-registries-for-dependabot - - /guidance-for-the-configuration-of-private-registries-for-dependabot - - /configuring-multi-ecosystem-updates - - /dependabot-options-reference - - /setting-dependabot-to-run-on-self-hosted-runners-using-arc - - /setting-dependabot-to-run-on-github-hosted-runners-using-vnet ---- diff --git a/content/code-security/getting-started/github-security-features.md b/content/code-security/getting-started/github-security-features.md index d48b6f6fc8ba..c78c310da9b8 100644 --- a/content/code-security/getting-started/github-security-features.md +++ b/content/code-security/getting-started/github-security-features.md @@ -5,7 +5,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: overview +contentType: get-started topics: - Repositories - Dependencies @@ -124,7 +124,7 @@ Push protection for users automatically protects you from accidentally committin ## Available with {% data variables.product.prodname_GH_secret_protection %} -For accounts on {% ifversion fpt or ghec %}{% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}{% endif %}{% ifversion ghes %} {% data variables.product.prodname_ghe_server %}{% endif %}, you can access additional security features when you purchase **{% data variables.product.prodname_GH_secret_protection %}**. +For accounts on {% ifversion fpt or ghec %}{% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}{% endif %}{% ifversion ghes %} {% data variables.product.prodname_ghe_server %}{% endif %}, you can access additional security features when you purchase **{% data variables.product.prodname_GH_secret_protection %}**. {% data variables.product.prodname_GH_secret_protection %} includes features that help you detect and prevent secret leaks, such as {% data variables.product.prodname_secret_scanning %} and push protection. @@ -179,7 +179,7 @@ Security overview allows you to review the overall security landscape of your or ## Available with {% data variables.product.prodname_GH_code_security %} -For accounts on {% ifversion fpt or ghec %}{% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}{% endif %}{% ifversion ghes %} {% data variables.product.prodname_ghe_server %}{% endif %}, you can access additional security features when you purchase **{% data variables.product.prodname_GH_code_security %}**. +For accounts on {% ifversion fpt or ghec %}{% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}{% endif %}{% ifversion ghes %} {% data variables.product.prodname_ghe_server %}{% endif %}, you can access additional security features when you purchase **{% data variables.product.prodname_GH_code_security %}**. {% data variables.product.prodname_GH_code_security %} includes features that help you find and fix vulnerabilities, like {% data variables.product.prodname_code_scanning %}, premium {% data variables.product.prodname_dependabot %} features, and dependency review. diff --git a/content/code-security/getting-started/index.md b/content/code-security/getting-started/index.md index d7d750b463fa..134020900d50 100644 --- a/content/code-security/getting-started/index.md +++ b/content/code-security/getting-started/index.md @@ -2,7 +2,7 @@ title: Getting started with secure coding shortTitle: Getting started allowTitleToDifferFromFilename: true -intro: 'Introduction to secure coding with {% data variables.product.github %}.' +intro: Introduction to secure coding with {% data variables.product.github %}. versions: fpt: '*' ghes: '*' @@ -13,11 +13,6 @@ topics: - Vulnerabilities children: - /github-security-features - - /dependabot-quickstart-guide - /quickstart-for-securing-your-repository - /quickstart-for-securing-your-organization - - /adding-a-security-policy-to-your-repository - - /auditing-security-alerts - - /best-practices-for-preventing-data-leaks-in-your-organization - - /understanding-github-secret-types --- diff --git a/content/code-security/getting-started/quickstart-for-securing-your-organization.md b/content/code-security/getting-started/quickstart-for-securing-your-organization.md index 875f0ccd503a..e76d595804c8 100644 --- a/content/code-security/getting-started/quickstart-for-securing-your-organization.md +++ b/content/code-security/getting-started/quickstart-for-securing-your-organization.md @@ -6,7 +6,7 @@ redirect_from: - /code-security/getting-started/securing-your-organization versions: feature: pre-security-configurations -type: how_to +contentType: get-started topics: - Organizations - Dependencies diff --git a/content/code-security/getting-started/quickstart-for-securing-your-repository.md b/content/code-security/getting-started/quickstart-for-securing-your-repository.md index 63ffd226810a..c70f36187ae5 100644 --- a/content/code-security/getting-started/quickstart-for-securing-your-repository.md +++ b/content/code-security/getting-started/quickstart-for-securing-your-repository.md @@ -10,7 +10,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: get-started topics: - Repositories - Dependencies diff --git a/content/code-security/how-tos/index.md b/content/code-security/how-tos/index.md new file mode 100644 index 000000000000..9bca368d048f --- /dev/null +++ b/content/code-security/how-tos/index.md @@ -0,0 +1,27 @@ +--- +title: How-tos for security and code quality +shortTitle: How-tos +intro: Learn how to use {% data variables.product.github %}'s security and code quality features. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: how-tos +children: + - /secure-at-scale + - /secure-your-secrets + - /scan-code-for-vulnerabilities + - secure-your-supply-chain + - manage-security-alerts + - /maintain-quality-code + - /report-and-fix-vulnerabilities + - /view-and-interpret-data +--- diff --git a/content/code-security/code-quality/how-tos/enable-code-quality.md b/content/code-security/how-tos/maintain-quality-code/enable-code-quality.md similarity index 92% rename from content/code-security/code-quality/how-tos/enable-code-quality.md rename to content/code-security/how-tos/maintain-quality-code/enable-code-quality.md index 5ccb73a0a132..e109d1bd3d49 100644 --- a/content/code-security/code-quality/how-tos/enable-code-quality.md +++ b/content/code-security/how-tos/maintain-quality-code/enable-code-quality.md @@ -1,7 +1,7 @@ --- title: Enabling {% data variables.product.prodname_code_quality %} shortTitle: Enable Code Quality -intro: 'Use {% data variables.product.prodname_code_quality_short %} to automatically catch, fix, and report on code quality issues in pull requests and on your default branch.' +intro: Use {% data variables.product.prodname_code_quality_short %} to automatically catch, fix, and report on code quality issues in pull requests and on your default branch. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' @@ -9,6 +9,8 @@ permissions: '{% data reusables.permissions.code-quality-repo-enable %}' topics: - Code Quality contentType: how-tos +redirect_from: + - /code-security/code-quality/how-tos/enable-code-quality --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/how-tos/maintain-quality-code/index.md b/content/code-security/how-tos/maintain-quality-code/index.md new file mode 100644 index 000000000000..bc9edf9f5fcf --- /dev/null +++ b/content/code-security/how-tos/maintain-quality-code/index.md @@ -0,0 +1,16 @@ +--- +title: Maintain quality code +intro: Learn how to use {% data variables.product.github %}'s code security and code quality features to maintain high-quality code in your repositories. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /enable-code-quality + - /interpret-results + - /set-pr-thresholds + - /unblock-your-pr +redirect_from: + - /code-security/code-quality/how-tos +--- diff --git a/content/code-security/code-quality/how-tos/interpret-results.md b/content/code-security/how-tos/maintain-quality-code/interpret-results.md similarity index 95% rename from content/code-security/code-quality/how-tos/interpret-results.md rename to content/code-security/how-tos/maintain-quality-code/interpret-results.md index 23869a52345b..9b83534135d2 100644 --- a/content/code-security/code-quality/how-tos/interpret-results.md +++ b/content/code-security/how-tos/maintain-quality-code/interpret-results.md @@ -2,7 +2,7 @@ title: Interpreting the code quality results for your repository shortTitle: Interpret results allowTitleToDifferFromFilename: true -intro: 'View {% data variables.product.prodname_code_quality %} findings for your default branch.' +intro: View {% data variables.product.prodname_code_quality %} findings for your default branch. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' @@ -10,6 +10,8 @@ permissions: '{% data reusables.permissions.code-quality-see-repo-findings %}' topics: - Code Quality contentType: how-tos +redirect_from: + - /code-security/code-quality/how-tos/interpret-results --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/code-quality/how-tos/set-pr-thresholds.md b/content/code-security/how-tos/maintain-quality-code/set-pr-thresholds.md similarity index 94% rename from content/code-security/code-quality/how-tos/set-pr-thresholds.md rename to content/code-security/how-tos/maintain-quality-code/set-pr-thresholds.md index 2e7340721ef5..ffae463e077e 100644 --- a/content/code-security/code-quality/how-tos/set-pr-thresholds.md +++ b/content/code-security/how-tos/maintain-quality-code/set-pr-thresholds.md @@ -1,7 +1,7 @@ --- title: Setting code quality thresholds for pull requests shortTitle: Set PR thresholds -intro: 'Create a {% data variables.product.prodname_code_quality_short %} gate for pull requests to increase the quality of code merged into your repository.' +intro: Create a {% data variables.product.prodname_code_quality_short %} gate for pull requests to increase the quality of code merged into your repository. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' @@ -9,6 +9,8 @@ permissions: '{% data reusables.permissions.code-quality-repo-enable %}' topics: - Code Quality contentType: how-tos +redirect_from: + - /code-security/code-quality/how-tos/set-pr-thresholds --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/code-quality/how-tos/unblock-your-pr.md b/content/code-security/how-tos/maintain-quality-code/unblock-your-pr.md similarity index 95% rename from content/code-security/code-quality/how-tos/unblock-your-pr.md rename to content/code-security/how-tos/maintain-quality-code/unblock-your-pr.md index a51a951aaf97..ccbe109bcc35 100644 --- a/content/code-security/code-quality/how-tos/unblock-your-pr.md +++ b/content/code-security/how-tos/maintain-quality-code/unblock-your-pr.md @@ -1,13 +1,15 @@ --- title: Resolving a block on your pull request shortTitle: Unblock your PR -intro: 'Identify and resolve a code quality block on your pull request so you can merge your changes.' +intro: Identify and resolve a code quality block on your pull request so you can merge your changes. versions: feature: code-quality permissions: '{% data reusables.permissions.code-quality-see-repo-findings %}' topics: - Code Quality contentType: how-tos +redirect_from: + - /code-security/code-quality/how-tos/unblock-your-pr --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/how-tos/manage-security-alerts/index.md b/content/code-security/how-tos/manage-security-alerts/index.md new file mode 100644 index 000000000000..526a97c5ca07 --- /dev/null +++ b/content/code-security/how-tos/manage-security-alerts/index.md @@ -0,0 +1,23 @@ +--- +title: Managing security alerts +shortTitle: Manage security alerts +intro: Manage alerts generated by security features. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +children: + - remediate-alerts-at-scale + - manage-secret-scanning-alerts + - manage-code-scanning-alerts + - manage-dependabot-alerts +--- diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md similarity index 98% rename from content/code-security/code-scanning/managing-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md rename to content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md index c4e0881a92ae..e0d8a003b040 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md @@ -7,12 +7,14 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Code Security - Code scanning - Alerts - Repositories +redirect_from: + - /code-security/code-scanning/managing-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository --- Anyone with read permission for a repository can see {% data variables.product.prodname_code_scanning %} annotations on pull requests. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests). diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/disabling-autofix-for-code-scanning.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/disabling-autofix-for-code-scanning.md similarity index 97% rename from content/code-security/code-scanning/managing-code-scanning-alerts/disabling-autofix-for-code-scanning.md rename to content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/disabling-autofix-for-code-scanning.md index 779b0e4f1498..7db6f7f67fb6 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/disabling-autofix-for-code-scanning.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/disabling-autofix-for-code-scanning.md @@ -6,12 +6,14 @@ intro: You can block availability of {% data variables.copilot.copilot_autofix % product: '{% data reusables.rai.code-scanning.gated-feature-autofix %}' versions: feature: code-scanning-autofix -type: how_to +contentType: how-tos topics: - Code Security - Code scanning - CodeQL - AI +redirect_from: + - /code-security/code-scanning/managing-code-scanning-alerts/disabling-autofix-for-code-scanning --- ## About disabling {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/enabling-delegated-alert-dismissal-for-code-scanning.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/enabling-delegated-alert-dismissal-for-code-scanning.md similarity index 91% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/enabling-delegated-alert-dismissal-for-code-scanning.md rename to content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/enabling-delegated-alert-dismissal-for-code-scanning.md index 89e926e0491b..9936c63a2769 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/enabling-delegated-alert-dismissal-for-code-scanning.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/enabling-delegated-alert-dismissal-for-code-scanning.md @@ -1,16 +1,18 @@ --- title: Enabling delegated alert dismissal for code scanning -intro: 'You can use delegated alert dismissal to control who can dismiss an alert found by {% data variables.product.prodname_code_scanning %}.' +intro: You can use delegated alert dismissal to control who can dismiss an alert found by {% data variables.product.prodname_code_scanning %}. permissions: '{% data reusables.permissions.delegated-alert-dismissal %}' versions: feature: security-delegated-alert-dismissal -type: how_to +contentType: how-tos topics: - Code scanning - Advanced Security - Alerts - Repositories shortTitle: Enable delegated alert dismissal +redirect_from: + - /code-security/code-scanning/managing-your-code-scanning-configuration/enabling-delegated-alert-dismissal-for-code-scanning --- ## About enabling delegated alert dismissal diff --git a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/index.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/index.md new file mode 100644 index 000000000000..e40b56cb56b5 --- /dev/null +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/index.md @@ -0,0 +1,23 @@ +--- +title: Manage code scanning alerts +shortTitle: Code scanning alerts +intro: Discover how to assess, manage, and resolve {% data variables.product.prodname_code_scanning %} alerts to keep your code secure. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - Alerts + - Repositories +redirect_from: + - /code-security/code-scanning/managing-code-scanning-alerts +children: + - assessing-code-scanning-alerts-for-your-repository + - triaging-code-scanning-alerts-in-pull-requests + - resolving-code-scanning-alerts + - enabling-delegated-alert-dismissal-for-code-scanning + - disabling-autofix-for-code-scanning +--- diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/resolving-code-scanning-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md similarity index 98% rename from content/code-security/code-scanning/managing-code-scanning-alerts/resolving-code-scanning-alerts.md rename to content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md index d637bb3fe3d1..53bffe071e7f 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/resolving-code-scanning-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md @@ -1,7 +1,7 @@ --- title: Resolving code scanning alerts shortTitle: Resolve alerts -intro: 'From the security view, you can view, fix, or dismiss alerts for potential vulnerabilities or errors in your project''s code.' +intro: From the security view, you can view, fix, or dismiss alerts for potential vulnerabilities or errors in your project's code. permissions: '{% data reusables.permissions.code-scanning-all-alerts %}' versions: fpt: '*' @@ -16,7 +16,8 @@ redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository - /code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository -type: how_to + - /code-security/code-scanning/managing-code-scanning-alerts/resolving-code-scanning-alerts +contentType: how-tos topics: - Code Security - Code scanning diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md similarity index 98% rename from content/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md rename to content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md index b1c7a7b849f1..393bfd0b209b 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests.md @@ -1,7 +1,7 @@ --- title: Triaging code scanning alerts in pull requests shortTitle: Triage alerts in pull requests -intro: 'When {% data variables.product.prodname_code_scanning %} identifies a problem in a pull request, you can review the highlighted code and resolve the alert.' +intro: When {% data variables.product.prodname_code_scanning %} identifies a problem in a pull request, you can review the highlighted code and resolve the alert. permissions: '{% data reusables.permissions.code-scanning-pr-alerts %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests @@ -9,11 +9,12 @@ redirect_from: - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests + - /code-security/code-scanning/managing-code-scanning-alerts/triaging-code-scanning-alerts-in-pull-requests versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Code Security - Code scanning diff --git a/content/code-security/dependabot/dependabot-alerts/enable-delegated-alert-dismissal.md b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/enable-delegated-alert-dismissal.md similarity index 92% rename from content/code-security/dependabot/dependabot-alerts/enable-delegated-alert-dismissal.md rename to content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/enable-delegated-alert-dismissal.md index b718d5df5acf..837e10cf17f6 100644 --- a/content/code-security/dependabot/dependabot-alerts/enable-delegated-alert-dismissal.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/enable-delegated-alert-dismissal.md @@ -1,17 +1,19 @@ --- title: Enabling delegated alert dismissal for Dependabot -intro: 'Increase your governance over your {% data variables.product.prodname_dependabot_alerts %} with delegated alert dismissal.' +intro: Increase your governance over your {% data variables.product.prodname_dependabot_alerts %} with delegated alert dismissal. permissions: '{% data reusables.permissions.delegated-alert-dismissal %}' shortTitle: Enable delegated alert dismissal versions: feature: dependabot-delegated-alert-dismissal -type: how_to +contentType: how-tos topics: - Dependabot - Code Security - Security updates - Alerts - Dependencies +redirect_from: + - /code-security/dependabot/dependabot-alerts/enable-delegated-alert-dismissal --- ## About enabling delegated alert dismissal diff --git a/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/index.md b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/index.md new file mode 100644 index 000000000000..c5b1e1564bf4 --- /dev/null +++ b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/index.md @@ -0,0 +1,20 @@ +--- +title: Manage Dependabot alerts +shortTitle: Dependabot alerts +intro: Learn how to view, manage, and resolve {% data variables.product.prodname_dependabot_alerts %} to keep your dependencies secure. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Dependabot + - Security updates + - Alerts + - Repositories +children: + - viewing-and-updating-dependabot-alerts + - managing-automatically-dismissed-alerts + - enable-delegated-alert-dismissal +--- diff --git a/content/code-security/dependabot/dependabot-auto-triage-rules/managing-automatically-dismissed-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/managing-automatically-dismissed-alerts.md similarity index 88% rename from content/code-security/dependabot/dependabot-auto-triage-rules/managing-automatically-dismissed-alerts.md rename to content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/managing-automatically-dismissed-alerts.md index a35632b03915..1245b36fb9cc 100644 --- a/content/code-security/dependabot/dependabot-auto-triage-rules/managing-automatically-dismissed-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/managing-automatically-dismissed-alerts.md @@ -1,13 +1,13 @@ --- title: Managing alerts that have been automatically dismissed by a Dependabot auto-triage rule -intro: 'You can filter to see which alerts have been auto-dismissed by a rule, and you can reopen dismissed alerts.' +intro: You can filter to see which alerts have been auto-dismissed by a rule, and you can reopen dismissed alerts. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.dependabot-auto-triage-rules %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Dependabot - Alerts @@ -17,6 +17,7 @@ topics: shortTitle: Manage auto-dismissed alerts redirect_from: - /code-security/dependabot/dependabot-alert-rules/managing-automatically-dismissed-alerts + - /code-security/dependabot/dependabot-auto-triage-rules/managing-automatically-dismissed-alerts --- ## Managing automatically dismissed alerts diff --git a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/viewing-and-updating-dependabot-alerts.md similarity index 98% rename from content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md rename to content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/viewing-and-updating-dependabot-alerts.md index 774d464fec09..312bea82236f 100644 --- a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -1,18 +1,19 @@ --- title: Viewing and updating Dependabot alerts -intro: 'If {% data variables.product.github %} discovers insecure dependencies in your project, you can view details on the Dependabot alerts tab of your repository. Then, you can update your project to resolve or dismiss the alert.' +intro: If {% data variables.product.github %} discovers insecure dependencies in your project, you can view details on the Dependabot alerts tab of your repository. Then, you can update your project to resolve or dismiss the alert. redirect_from: - /articles/viewing-and-updating-vulnerable-dependencies-in-your-repository - /github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository - /code-security/supply-chain-security/viewing-and-updating-vulnerable-dependencies-in-your-repository - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository + - /code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts permissions: '{% data reusables.permissions.dependabot-alerts %}' shortTitle: View Dependabot alerts versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Dependabot - Security updates diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/enabling-delegated-alert-dismissal-for-secret-scanning.md b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/enabling-delegated-alert-dismissal-for-secret-scanning.md similarity index 92% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/enabling-delegated-alert-dismissal-for-secret-scanning.md rename to content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/enabling-delegated-alert-dismissal-for-secret-scanning.md index 8b365c27e855..61dd7dfcccbf 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/enabling-delegated-alert-dismissal-for-secret-scanning.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/enabling-delegated-alert-dismissal-for-secret-scanning.md @@ -1,16 +1,18 @@ --- title: Enabling delegated alert dismissal for secret scanning -intro: 'You can use delegated alert dismissal to control who can dismiss an alert found by {% data variables.product.prodname_secret_scanning %}.' +intro: You can use delegated alert dismissal to control who can dismiss an alert found by {% data variables.product.prodname_secret_scanning %}. permissions: '{% data reusables.permissions.delegated-alert-dismissal %}' versions: feature: security-delegated-alert-dismissal -type: how_to +contentType: how-tos topics: - Secret scanning - Advanced Security - Alerts - Repositories shortTitle: Delegated alert dismissal +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/enabling-delegated-alert-dismissal-for-secret-scanning --- ## About enabling delegated alert dismissal diff --git a/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/index.md b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/index.md new file mode 100644 index 000000000000..c56cf76960df --- /dev/null +++ b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/index.md @@ -0,0 +1,22 @@ +--- +title: Manage secret scanning alerts +shortTitle: Secret scanning alerts +intro: Discover how to monitor, manage, and resolve {% data variables.secret-scanning.alerts %} to keep your sensitive information secure. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Secret scanning + - Secret Protection + - Alerts + - Repositories +redirect_from: + - /code-security/secret-scanning/managing-alerts-from-secret-scanning +children: + - monitoring-alerts + - viewing-alerts + - resolving-alerts + - enabling-delegated-alert-dismissal-for-secret-scanning +--- diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/monitoring-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/monitoring-alerts.md similarity index 91% rename from content/code-security/secret-scanning/managing-alerts-from-secret-scanning/monitoring-alerts.md rename to content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/monitoring-alerts.md index 57a9d2748d01..187008a07372 100644 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/monitoring-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/monitoring-alerts.md @@ -1,12 +1,12 @@ --- title: Monitoring alerts from secret scanning -intro: 'Learn how and when {% data variables.product.github %} will notify you about a secret scanning alert.' +intro: Learn how and when {% data variables.product.github %} will notify you about a secret scanning alert. permissions: '{% data reusables.permissions.secret-scanning-alerts %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection @@ -14,6 +14,8 @@ topics: - Repositories shortTitle: Monitor alerts allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/secret-scanning/managing-alerts-from-secret-scanning/monitoring-alerts --- ## Configuring notifications for {% data variables.secret-scanning.alerts %} diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/resolving-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/resolving-alerts.md similarity index 93% rename from content/code-security/secret-scanning/managing-alerts-from-secret-scanning/resolving-alerts.md rename to content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/resolving-alerts.md index 57bcb2517409..f6eb70c83b16 100644 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/resolving-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/resolving-alerts.md @@ -1,12 +1,12 @@ --- title: Resolving alerts from secret scanning -intro: 'After reviewing the details of a secret scanning alert, you should fix and then close the alert.' -permissions: 'Repository owners, organization owners, security managers, users assigned to {% data variables.secret-scanning.alerts %}, commit authors, and users with the **admin** role' +intro: After reviewing the details of a secret scanning alert, you should fix and then close the alert. +permissions: Repository owners, organization owners, security managers, users assigned to {% data variables.secret-scanning.alerts %}, commit authors, and users with the **admin** role versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection @@ -14,6 +14,8 @@ topics: - Repositories shortTitle: Resolve alerts allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/secret-scanning/managing-alerts-from-secret-scanning/resolving-alerts --- ## Fixing alerts diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/viewing-alerts.md similarity index 96% rename from content/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts.md rename to content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/viewing-alerts.md index 45b3e9fe3c9a..edcbea0d2dd8 100644 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-secret-scanning-alerts/viewing-alerts.md @@ -1,12 +1,12 @@ --- title: Viewing and filtering alerts from secret scanning -intro: 'Learn how to find and filter {% ifversion fpt or ghec %}{% data variables.secret-scanning.user_alerts %}{% else %}{% data variables.secret-scanning.user_alerts %} alerts{% endif %} for your repository.' +intro: Learn how to find and filter {% ifversion fpt or ghec %}{% data variables.secret-scanning.user_alerts %}{% else %}{% data variables.secret-scanning.user_alerts %} alerts{% endif %} for your repository. permissions: '{% data reusables.permissions.secret-scanning-alerts %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection @@ -14,6 +14,8 @@ topics: - Repositories shortTitle: View alerts allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/secret-scanning/managing-alerts-from-secret-scanning/viewing-alerts --- ## About the {% data variables.product.prodname_secret_scanning %} alerts page diff --git a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/creating-managing-security-campaigns.md b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/creating-managing-security-campaigns.md similarity index 97% rename from content/code-security/securing-your-organization/fixing-security-alerts-at-scale/creating-managing-security-campaigns.md rename to content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/creating-managing-security-campaigns.md index e39e16a00e52..d54d9b3d6022 100644 --- a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/creating-managing-security-campaigns.md +++ b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/creating-managing-security-campaigns.md @@ -1,11 +1,10 @@ --- title: Creating and managing security campaigns -shortTitle: Create security campaigns -intro: 'You can manage security campaigns directly from the security overview for your organization.' +shortTitle: Create security campaign +intro: You can manage security campaigns directly from the security overview for your organization. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.security-org-enable %}' product: '{% data reusables.gated-features.security-campaigns %}' -type: how_to audience: - driver contentType: how-tos @@ -18,6 +17,7 @@ topics: - Security redirect_from: - /code-security/securing-your-organization/fixing-security-alerts-at-scale/creating-tracking-security-campaigns + - /code-security/securing-your-organization/fixing-security-alerts-at-scale/creating-managing-security-campaigns --- {% data reusables.security.secrets-campaign-preview %} diff --git a/content/code-security/security-overview/filtering-alerts-in-security-overview.md b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/filtering-alerts-in-security-overview.md similarity index 99% rename from content/code-security/security-overview/filtering-alerts-in-security-overview.md rename to content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/filtering-alerts-in-security-overview.md index 6fa7d4de4554..b5dc4fca9ed7 100644 --- a/content/code-security/security-overview/filtering-alerts-in-security-overview.md +++ b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/filtering-alerts-in-security-overview.md @@ -8,7 +8,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security overview - Code Security @@ -16,9 +16,10 @@ topics: - Alerts - Organizations - Teams -shortTitle: Filter security overview +shortTitle: Filter security alerts redirect_from: - /code-security/security-overview/filtering-alerts-in-the-security-overview + - /code-security/security-overview/filtering-alerts-in-security-overview --- ## About filtering security overview diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign.md b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign.md similarity index 96% rename from content/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign.md rename to content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign.md index 812590741d23..6244b038988c 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign.md +++ b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign.md @@ -1,11 +1,11 @@ --- title: Fixing alerts in a security campaign shortTitle: Fix alerts in campaign -intro: 'Learn how to find and fix alerts in a security campaign.' +intro: Learn how to find and fix alerts in a security campaign. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.code-scanning-all-alerts %}' product: '{% data reusables.gated-features.security-campaigns %}' -type: how_to +contentType: how-tos versions: feature: security-campaigns topics: @@ -13,6 +13,8 @@ topics: - Code scanning - Alerts - Repositories +redirect_from: + - /code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign --- ## Viewing alerts in a security campaign diff --git a/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/index.md b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/index.md new file mode 100644 index 000000000000..f02da370e66e --- /dev/null +++ b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/index.md @@ -0,0 +1,26 @@ +--- +title: Remediate alerts at scale +shortTitle: Remediate at scale +intro: Learn how to remediate large volumes of alerts using clear processes and effective prioritization. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Secret scanning + - Secret Protection + - Code Security + - Code scanning + - Dependabot + - Alerts + - Repositories + - Security updates + - Dependencies +children: + - filtering-alerts-in-security-overview + - creating-managing-security-campaigns + - tracking-security-campaigns + - fixing-alerts-in-security-campaign + - review-alert-dismissal-requests +--- diff --git a/content/code-security/security-overview/review-alert-dismissal-requests.md b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/review-alert-dismissal-requests.md similarity index 86% rename from content/code-security/security-overview/review-alert-dismissal-requests.md rename to content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/review-alert-dismissal-requests.md index a02f08b0f5c6..48e0bd8a02b0 100644 --- a/content/code-security/security-overview/review-alert-dismissal-requests.md +++ b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/review-alert-dismissal-requests.md @@ -1,10 +1,9 @@ --- title: Reviewing alert dismissal requests shortTitle: Review alert dismissal requests -intro: 'Triage and resolve security alerts in your organization or enterprise by regularly reviewing alert dismissal requests.' +intro: Triage and resolve security alerts in your organization or enterprise by regularly reviewing alert dismissal requests. permissions: '{% data reusables.permissions.security-overview %}' -product: 'Organizations or enterprises with {% data variables.product.prodname_GHAS_cs_or_sp %}' -type: how_to +product: Organizations or enterprises with {% data variables.product.prodname_GHAS_cs_or_sp %} topics: - Security overview - Organizations @@ -15,6 +14,9 @@ topics: - Alerts versions: feature: security-delegated-alert-dismissal +redirect_from: + - /code-security/security-overview/review-alert-dismissal-requests +contentType: how-tos --- ## Prerequisites diff --git a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/tracking-security-campaigns.md b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/tracking-security-campaigns.md similarity index 92% rename from content/code-security/securing-your-organization/fixing-security-alerts-at-scale/tracking-security-campaigns.md rename to content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/tracking-security-campaigns.md index 2caf0ed6f666..914762fd3174 100644 --- a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/tracking-security-campaigns.md +++ b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/tracking-security-campaigns.md @@ -1,11 +1,10 @@ --- title: Tracking security campaigns -shortTitle: Track security campaigns -intro: 'You can monitor the progress of all your organization''s security campaigns, and track the status of individual campaigns.' +shortTitle: Track security campaign +intro: You can monitor the progress of all your organization's security campaigns, and track the status of individual campaigns. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.security-org-enable %}' product: '{% data reusables.gated-features.security-campaigns %}' -type: how_to audience: - driver contentType: how-tos @@ -16,6 +15,8 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/fixing-security-alerts-at-scale/tracking-security-campaigns --- {% data reusables.security.secrets-campaign-preview %} diff --git a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/adding-a-security-policy-to-your-repository.md similarity index 96% rename from content/code-security/getting-started/adding-a-security-policy-to-your-repository.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/adding-a-security-policy-to-your-repository.md index 554411483842..4ca994c9b7c4 100644 --- a/content/code-security/getting-started/adding-a-security-policy-to-your-repository.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/adding-a-security-policy-to-your-repository.md @@ -5,16 +5,18 @@ redirect_from: - /articles/adding-a-security-policy-to-your-repository - /github/managing-security-vulnerabilities/adding-a-security-policy-to-your-repository - /github/code-security/security-advisories/adding-a-security-policy-to-your-repository + - /code-security/getting-started/adding-a-security-policy-to-your-repository versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security policies - Vulnerabilities - Repositories - Health + - Security advisories shortTitle: Add a security policy --- diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/configuring-private-vulnerability-reporting-for-a-repository.md similarity index 96% rename from content/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/configuring-private-vulnerability-reporting-for-a-repository.md index 1dd579e59199..8f72abc1a0a2 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/configuring-private-vulnerability-reporting-for-a-repository.md @@ -5,13 +5,14 @@ permissions: '{% data reusables.permissions.security-repo-enable %}' versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities shortTitle: Configure for a repository redirect_from: - /code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository + - /code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository --- ## About privately reporting a security vulnerability diff --git a/content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/index.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/index.md new file mode 100644 index 000000000000..faa70865c3e0 --- /dev/null +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/configure-vulnerability-reporting/index.md @@ -0,0 +1,18 @@ +--- +title: How-tos for reporting and fixing vulnerabilities +shortTitle: Configure vulnerability reporting +intro: Learn how to establish security policies and enable private channels for reporting vulnerabilities in your repository. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Security policies + - Vulnerabilities + - Repositories + - Health +contentType: how-tos +children: + - adding-a-security-policy-to-your-repository + - configuring-private-vulnerability-reporting-for-a-repository +--- diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/adding-a-collaborator-to-a-repository-security-advisory.md similarity index 94% rename from content/code-security/security-advisories/working-with-repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/adding-a-collaborator-to-a-repository-security-advisory.md index f81d5bf69795..b6c55c1a6f22 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/adding-a-collaborator-to-a-repository-security-advisory.md @@ -9,10 +9,11 @@ redirect_from: - /code-security/security-advisories/adding-a-collaborator-to-a-security-advisory - /code-security/repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory - /code-security/security-advisories/repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory + - /code-security/security-advisories/working-with-repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/browsing-security-advisories-in-the-github-advisory-database.md similarity index 94% rename from content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/browsing-security-advisories-in-the-github-advisory-database.md index 9bce49eb360f..8d1f36d5b4ab 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/browsing-security-advisories-in-the-github-advisory-database.md @@ -1,6 +1,6 @@ --- title: Browsing security advisories in the GitHub Advisory Database -intro: 'You can browse the {% data variables.product.prodname_advisory_database %} to find CVEs and {% data variables.product.prodname_dotcom %}-originated advisories affecting the open source world.' +intro: You can browse the {% data variables.product.prodname_advisory_database %} to find CVEs and {% data variables.product.prodname_dotcom %}-originated advisories affecting the open source world. shortTitle: Browse Advisory Database permissions: '{% data reusables.permissions.global-security-advisories-browse %}' redirect_from: @@ -10,11 +10,14 @@ redirect_from: - /code-security/dependabot/dependabot-alerts/browsing-security-vulnerabilities-in-the-github-advisory-database - /code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database - /code-security/security-advisories/global-security-advisories/browsing-security-advisories-in-the-github-advisory-database + - /code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/browsing-security-advisories-in-the-github-advisory-database + - /code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database + - /code-security/security-advisories/global-security-advisories versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Alerts diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/creating-a-repository-security-advisory.md similarity index 97% rename from content/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/creating-a-repository-security-advisory.md index e89807bd8caa..f5ef5dc905e0 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/creating-a-repository-security-advisory.md @@ -9,14 +9,15 @@ redirect_from: - /code-security/security-advisories/creating-a-security-advisory - /code-security/repository-security-advisories/creating-a-repository-security-advisory - /code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory + - /code-security/security-advisories/working-with-repository-security-advisories/creating-a-repository-security-advisory versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities -shortTitle: Create repository advisories +shortTitle: Create repository advisory --- {% data reusables.security-advisory.security-researcher-cannot-create-advisory %} diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/deleting-a-repository-security-advisory.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/deleting-a-repository-security-advisory.md similarity index 76% rename from content/code-security/security-advisories/working-with-repository-security-advisories/deleting-a-repository-security-advisory.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/deleting-a-repository-security-advisory.md index 2c7ccc8c00b7..782c5b228f50 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/deleting-a-repository-security-advisory.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/deleting-a-repository-security-advisory.md @@ -1,17 +1,18 @@ --- title: Deleting a repository security advisory intro: You can delete a repository security advisory that you've published by contacting Support. -permissions: 'Repository owners, organization owners, security managers, and users with the **admin** role can contact {% data variables.contact.github_support %} to delete a published security advisory.' +permissions: Repository owners, organization owners, security managers, and users with the **admin** role can contact {% data variables.contact.github_support %} to delete a published security advisory. redirect_from: - /github/managing-security-vulnerabilities/withdrawing-a-security-advisory - /code-security/security-advisories/withdrawing-a-security-advisory - /code-security/repository-security-advisories/withdrawing-a-repository-security-advisory - /code-security/security-advisories/repository-security-advisories/withdrawing-a-repository-security-advisory - /code-security/security-advisories/working-with-repository-security-advisories/withdrawing-a-repository-security-advisory + - /code-security/security-advisories/working-with-repository-security-advisories/deleting-a-repository-security-advisory versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/editing-a-repository-security-advisory.md similarity index 95% rename from content/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/editing-a-repository-security-advisory.md index 48a3560ebff0..d00b8809193c 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/editing-a-repository-security-advisory.md @@ -7,10 +7,11 @@ redirect_from: - /code-security/security-advisories/editing-a-security-advisory - /code-security/repository-security-advisories/editing-a-repository-security-advisory - /code-security/security-advisories/repository-security-advisories/editing-a-repository-security-advisory + - /code-security/security-advisories/working-with-repository-security-advisories/editing-a-repository-security-advisory versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/editing-security-advisories-in-the-github-advisory-database.md similarity index 93% rename from content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/editing-security-advisories-in-the-github-advisory-database.md index 38fdb5532046..122e4575852f 100644 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/editing-security-advisories-in-the-github-advisory-database.md @@ -1,17 +1,18 @@ --- title: Editing security advisories in the GitHub Advisory Database -intro: 'You can submit improvements to any advisory published in the {% data variables.product.prodname_advisory_database %} by making a community contribution.' +intro: You can submit improvements to any advisory published in the {% data variables.product.prodname_advisory_database %} by making a community contribution. permissions: '{% data reusables.permissions.global-security-advisories-edit %}' redirect_from: - /code-security/security-advisories/editing-security-advisories-in-the-github-advisory-database - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database - /code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database - /code-security/security-advisories/global-security-advisories/editing-security-advisories-in-the-github-advisory-database + - /code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/editing-security-advisories-in-the-github-advisory-database versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Alerts diff --git a/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/index.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/index.md new file mode 100644 index 000000000000..e584273a209e --- /dev/null +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/index.md @@ -0,0 +1,27 @@ +--- +title: How-tos for fixing vulnerabilities +shortTitle: Fix vulnerabilities +intro: Learn how to manage, create, edit, and publish security advisories for your repositories, collaborate on private reports, and navigate or update advisories within the {% data variables.product.prodname_advisory_database %}. +versions: + fpt: '*' + ghec: '*' + ghes: '*' +topics: + - Vulnerabilities + - Repositories + - Health +contentType: how-tos +redirect_from: + - /code-security/security-advisories/working-with-repository-security-advisories + - /code-security/security-advisories +children: + - managing-privately-reported-security-vulnerabilities + - creating-a-repository-security-advisory + - publishing-a-repository-security-advisory + - adding-a-collaborator-to-a-repository-security-advisory + - removing-a-collaborator-from-a-repository-security-advisory + - editing-a-repository-security-advisory + - deleting-a-repository-security-advisory + - browsing-security-advisories-in-the-github-advisory-database + - editing-security-advisories-in-the-github-advisory-database +--- diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/managing-privately-reported-security-vulnerabilities.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/managing-privately-reported-security-vulnerabilities.md similarity index 95% rename from content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/managing-privately-reported-security-vulnerabilities.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/managing-privately-reported-security-vulnerabilities.md index 2c4e6be1f0c1..031338f2123c 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/managing-privately-reported-security-vulnerabilities.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/managing-privately-reported-security-vulnerabilities.md @@ -5,13 +5,14 @@ permissions: '{% data reusables.permissions.security-repo-enable %}' versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities shortTitle: Manage vulnerability reports redirect_from: - /code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities + - /code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/managing-privately-reported-security-vulnerabilities --- {% data reusables.security-advisory.private-vulnerability-reporting-enable %} diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/publishing-a-repository-security-advisory.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/publishing-a-repository-security-advisory.md similarity index 97% rename from content/code-security/security-advisories/working-with-repository-security-advisories/publishing-a-repository-security-advisory.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/publishing-a-repository-security-advisory.md index 6311f9f22c05..488bba242dd9 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/publishing-a-repository-security-advisory.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/publishing-a-repository-security-advisory.md @@ -9,16 +9,17 @@ redirect_from: - /code-security/security-advisories/publishing-a-security-advisory - /code-security/repository-security-advisories/publishing-a-repository-security-advisory - /code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory + - /code-security/security-advisories/working-with-repository-security-advisories/publishing-a-repository-security-advisory versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities - CVEs - Repositories -shortTitle: Publish repository advisories +shortTitle: Publish repository advisory --- diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/removing-a-collaborator-from-a-repository-security-advisory.md similarity index 92% rename from content/code-security/security-advisories/working-with-repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/removing-a-collaborator-from-a-repository-security-advisory.md index c381755e2db8..09af6d291729 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/fix-reported-vulnerabilities/removing-a-collaborator-from-a-repository-security-advisory.md @@ -7,10 +7,11 @@ redirect_from: - /code-security/security-advisories/removing-a-collaborator-from-a-security-advisory - /code-security/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory - /code-security/security-advisories/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory + - /code-security/security-advisories/working-with-repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities diff --git a/content/code-security/how-tos/report-and-fix-vulnerabilities/index.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/index.md new file mode 100644 index 000000000000..38a120bdc97d --- /dev/null +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/index.md @@ -0,0 +1,22 @@ +--- +title: How-tos for reporting and fixing vulnerabilities +shortTitle: Report and fix vulnerabilities +intro: Learn how to report and fix vulnerabilities on {% data variables.product.github %}. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: how-tos +children: + - configure-vulnerability-reporting + - report-a-vulnerability + - fix-reported-vulnerabilities +--- diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/evaluating-the-security-settings-of-a-repository.md similarity index 96% rename from content/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/evaluating-the-security-settings-of-a-repository.md index 3c4eb05329de..cbc6f5353e32 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/evaluating-the-security-settings-of-a-repository.md @@ -5,13 +5,14 @@ permissions: '{% data reusables.permissions.repository-security-advisory-evaluat versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities shortTitle: Evaluate repository security redirect_from: - /code-security/security-advisories/repository-security-advisories/evaluating-the-security-settings-of-a-repository + - /code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository --- ## About evaluating a repository's security settings diff --git a/content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/index.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/index.md new file mode 100644 index 000000000000..8e5bcde3a2d7 --- /dev/null +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/index.md @@ -0,0 +1,16 @@ +--- +title: How-tos for reporting vulnerabilities +shortTitle: Report and evaluate +intro: Learn how to report vulnerabilities and evaluate the security settings of a repository on {% data variables.product.github %}. +versions: + fpt: '*' + ghes: '*' +topics: + - Vulnerabilities + - Repositories + - Health +contentType: how-tos +children: + - privately-reporting-a-security-vulnerability + - evaluating-the-security-settings-of-a-repository +--- diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability.md b/content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/privately-reporting-a-security-vulnerability.md similarity index 94% rename from content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability.md rename to content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/privately-reporting-a-security-vulnerability.md index 021dcddb7382..a6c27e6e046d 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability.md +++ b/content/code-security/how-tos/report-and-fix-vulnerabilities/report-a-vulnerability/privately-reporting-a-security-vulnerability.md @@ -4,14 +4,15 @@ intro: Some public repositories configure security advisories so that anyone can versions: fpt: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Security advisories - Vulnerabilities permissions: '**Anyone** can privately report a security vulnerability to repository maintainers.' -shortTitle: Privately reporting +shortTitle: Report privately redirect_from: - /code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability + - /code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability --- {% data reusables.security-advisory.private-vulnerability-reporting-enable %} diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-advanced-setup-for-code-scanning.md similarity index 95% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-advanced-setup-for-code-scanning.md index 20c7e22d955c..705b99ab5eec 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-advanced-setup-for-code-scanning.md @@ -1,22 +1,24 @@ --- title: Configuring advanced setup for code scanning shortTitle: Configure advanced setup -intro: 'You can configure advanced setup for a repository to find security vulnerabilities in your code using a highly customizable {% data variables.product.prodname_code_scanning %} configuration.' +intro: You can configure advanced setup for a repository to find security vulnerabilities in your code using a highly customizable {% data variables.product.prodname_code_scanning %} configuration. permissions: '{% data reusables.permissions.security-repo-enable %}' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning + - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Code scanning - Actions - Repositories allowTitleToDifferFromFilename: true +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} diff --git a/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md similarity index 97% rename from content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md index 505f1bdd94ef..abda1f3f0dfd 100644 --- a/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning.md @@ -1,7 +1,7 @@ --- title: Configuring default setup for code scanning shortTitle: Configure code scanning -intro: 'Quickly set up {% data variables.product.prodname_code_scanning %} to find {% ifversion fpt or ghec %}and fix {% endif %}vulnerable code automatically.' +intro: Quickly set up {% data variables.product.prodname_code_scanning %} to find {% ifversion fpt or ghec %}and fix {% endif %}vulnerable code automatically. redirect_from: - /github/managing-security-vulnerabilities/configuring-automated-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning @@ -14,9 +14,9 @@ redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-default-setup-for-code-scanning + - /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning permissions: '{% data reusables.permissions.security-repo-enable %}' product: '{% data reusables.gated-features.code-scanning %}' -type: how_to topics: - Code Security - Code scanning @@ -24,6 +24,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' +contentType: how-tos --- ## About default setup diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/customizing-your-advanced-setup-for-code-scanning.md similarity index 99% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/customizing-your-advanced-setup-for-code-scanning.md index 75952a094a3c..162a018735c1 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/customizing-your-advanced-setup-for-code-scanning.md @@ -1,6 +1,6 @@ --- title: Customizing your advanced setup for code scanning -intro: 'You can customize how your advanced setup scans the code in your project for vulnerabilities and errors.' +intro: You can customize how your advanced setup scans the code in your project for vulnerabilities and errors. permissions: '{% data reusables.permissions.code-scanning-all-alerts %} if [advanced setup](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning) is already enabled' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning @@ -9,11 +9,11 @@ redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Code scanning @@ -24,6 +24,7 @@ topics: - Python shortTitle: Customize advanced setup allowTitleToDifferFromFilename: true +contentType: how-tos --- @@ -370,11 +371,8 @@ In the following example, the `+` symbol ensures that the specified additional p queries: +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main packs: +scope/pack1,scope/pack2@1.2.3,scope/pack3@4.5.6:path/to/queries ``` - - - - + ## Using a custom configuration file @@ -517,6 +515,8 @@ For analysis where code is built, if you want to limit {% data variables.product You can quickly analyze small portions of a monorepo when you modify code in specific directories. You'll need to both exclude directories in your build steps and use the `paths-ignore` and `paths` keywords for [`on.`](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore) in your workflow. + + ### Example configuration files {% data reusables.code-scanning.example-configuration-files %} diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/index.md new file mode 100644 index 000000000000..5c3a30ec5cec --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/index.md @@ -0,0 +1,20 @@ +--- +title: Configure code scanning +intro: Configure {% data variables.product.prodname_code_scanning %} for your repositories by choosing between default or advanced setup and customizing advanced settings as needed. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - Actions + - Repositories +children: + - /configuring-default-setup-for-code-scanning + - /configuring-advanced-setup-for-code-scanning + - /customizing-your-advanced-setup-for-code-scanning +redirect_from: + - /code-security/code-scanning/enabling-code-scanning +--- diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/index.md new file mode 100644 index 000000000000..0fe175e8beb9 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/index.md @@ -0,0 +1,18 @@ +--- +title: Scan code for vulnerabilities +intro: Scan your code for vulnerabilities by configuring code scanning, managing configurations, running scans locally or in your editor, integrating with existing tools, and troubleshooting issues. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +redirect_from: + - /code-security/code-scanning +children: + - /configure-code-scanning + - /manage-your-configuration + - /scan-from-the-command-line + - /scan-from-vs-code + - /integrate-with-existing-tools + - /troubleshooting +--- diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/index.md similarity index 52% rename from content/code-security/code-scanning/integrating-with-code-scanning/index.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/index.md index f23fd5a5066d..a91c69a33582 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/index.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/index.md @@ -1,23 +1,26 @@ --- -title: Integrating with code scanning -shortTitle: Integrate with code scanning -intro: 'You can integrate third-party code analysis tools with {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_code_scanning %} by uploading data as SARIF files.' -product: '{% data reusables.gated-features.code-scanning %}' -redirect_from: - - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-results-from-code-scanning - - /github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning - - /code-security/secure-coding/integrating-with-code-scanning +title: Integrate with existing tools +intro: Integrate {% data variables.product.prodname_code_scanning %} with your existing tools and workflows by running scans in your CI system or uploading results to {% data variables.product.github %} using Static Analysis Results Interchange Format (SARIF). versions: fpt: '*' ghes: '*' ghec: '*' +contentType: how-tos topics: - Code Security - Code scanning + - CodeQL + - Repositories + - Pull requests - Integration + - CI + - SARIF +redirect_from: + - /code-security/code-scanning/integrating-with-code-scanning + - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-results-from-code-scanning + - /github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning + - /code-security/secure-coding/integrating-with-code-scanning children: - - /about-integration-with-code-scanning - /using-code-scanning-with-your-existing-ci-system - /uploading-a-sarif-file-to-github - - /sarif-support-for-code-scanning --- diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/uploading-a-sarif-file-to-github.md similarity index 98% rename from content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/uploading-a-sarif-file-to-github.md index ade94508c8d9..9ea7803d9507 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/uploading-a-sarif-file-to-github.md @@ -10,11 +10,11 @@ redirect_from: - /code-security/secure-coding/uploading-a-sarif-file-to-github - /code-security/secure-coding/integrating-with-code-scanning/uploading-a-sarif-file-to-github - /github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning/uploading-a-sarif-file-to-github + - /code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Code scanning @@ -23,6 +23,7 @@ topics: - Repositories - CI - SARIF +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/using-code-scanning-with-your-existing-ci-system.md similarity index 92% rename from content/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/using-code-scanning-with-your-existing-ci-system.md index a15ee3936d02..14e1da0772e9 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/integrate-with-existing-tools/using-code-scanning-with-your-existing-ci-system.md @@ -1,17 +1,18 @@ --- title: Using code scanning with your existing CI system -intro: 'You can analyze your code with the {% data variables.product.prodname_codeql_cli %} or another tool in a third-party continuous integration system and upload the results to {% data variables.product.github %}. The resulting {% data variables.product.prodname_code_scanning %} alerts are shown alongside any alerts generated within {% data variables.product.github %}.' +shortTitle: Use with existing CI system +intro: You can analyze your code with the {% data variables.product.prodname_codeql_cli %} or another tool in a third-party continuous integration system and upload the results to {% data variables.product.github %}. The resulting {% data variables.product.prodname_code_scanning %} alerts are shown alongside any alerts generated within {% data variables.product.github %}. permissions: '{% data reusables.permissions.code-scanning-all-alerts %}' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system - /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system + - /code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Code Security - Code scanning @@ -21,6 +22,7 @@ topics: - Integration - CI - SARIF +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page.md similarity index 98% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page.md index d56aaba40e9c..3579b562a0f5 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/about-the-tool-status-page.md @@ -11,11 +11,12 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-the-tool-status-page -type: overview + - /code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page topics: - Code Security - Code scanning - CodeQL +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning %} diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages.md similarity index 99% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages.md index 531d9a8c4528..eb329969f224 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/codeql-code-scanning-for-compiled-languages.md @@ -1,7 +1,7 @@ --- title: CodeQL code scanning for compiled languages shortTitle: CodeQL for compiled languages -intro: 'Understand how {% data variables.product.prodname_codeql %} analyzes compiled languages, the build options available, and learn how you can customize the database generation process if you need to.' +intro: Understand how {% data variables.product.prodname_codeql %} analyzes compiled languages, the build options available, and learn how you can customize the database generation process if you need to. permissions: '{% data reusables.permissions.code-scanning-all-alerts %} if [advanced setup](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning) is already enabled' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: @@ -13,11 +13,11 @@ redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/codeql-code-scanning-for-compiled-languages + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Code scanning @@ -28,6 +28,7 @@ topics: - C# - Java - Kotlin +contentType: how-tos --- {% data reusables.code-scanning.enterprise-enable-code-scanning-actions %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/configuring-larger-runners-for-default-setup.md similarity index 94% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/configuring-larger-runners-for-default-setup.md index 1bec77e0582a..73b28ff5486e 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/configuring-larger-runners-for-default-setup.md @@ -1,7 +1,7 @@ --- title: Configuring larger runners for default setup shortTitle: Configure larger runners -intro: 'You can run {% data variables.product.prodname_code_scanning %} default setup more quickly on bigger codebases using {% data variables.actions.hosted_runners %}.' +intro: You can run {% data variables.product.prodname_code_scanning %} default setup more quickly on bigger codebases using {% data variables.actions.hosted_runners %}. product: '{% data reusables.actions.larger-runner-permissions %}' versions: feature: default-setup-larger-runners @@ -9,6 +9,9 @@ topics: - Code scanning - CodeQL - Actions +redirect_from: + - /code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup +contentType: how-tos --- {% data reusables.code-scanning.beta-larger-runners-support %} diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md similarity index 96% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md index c3f2e343b6bd..8392399ef89f 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/editing-your-configuration-of-default-setup.md @@ -1,16 +1,18 @@ --- title: Editing your configuration of default setup shortTitle: Edit default setup -intro: 'You can edit your existing configuration of default setup for {% data variables.product.prodname_code_scanning %} to better meet your needs.' +intro: You can edit your existing configuration of default setup for {% data variables.product.prodname_code_scanning %} to better meet your needs. permissions: '{% data reusables.permissions.security-org-enable %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code scanning - CodeQL +redirect_from: + - /code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup +contentType: how-tos --- ## About editing your configuration of default setup diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/index.md new file mode 100644 index 000000000000..2bc9319b162e --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/index.md @@ -0,0 +1,27 @@ +--- +title: Manage your configuration +intro: Manage and refine your {% data variables.product.prodname_code_scanning %} configuration by monitoring tool status, updating default setup settings, and enforcing protections as your needs evolve. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - CodeQL + - Actions + - Repositories + - C/C++ + - C# + - Java + - Kotlin +redirect_from: + - /code-security/code-scanning/managing-your-code-scanning-configuration +children: + - /about-the-tool-status-page + - /editing-your-configuration-of-default-setup + - /set-code-scanning-merge-protection + - /configuring-larger-runners-for-default-setup + - /codeql-code-scanning-for-compiled-languages +--- diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/set-code-scanning-merge-protection.md similarity index 93% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/set-code-scanning-merge-protection.md index 7dab7afdb78c..c938f77c5ec8 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/set-code-scanning-merge-protection.md @@ -1,17 +1,19 @@ --- title: Set code scanning merge protection shortTitle: Set merge protection -intro: 'You can use rulesets to set {% data variables.product.prodname_code_scanning %} merge protection for pull requests.' +intro: You can use rulesets to set {% data variables.product.prodname_code_scanning %} merge protection for pull requests. permissions: '{% data reusables.permissions.security-org-enable %}' product: '{% data reusables.gated-features.code-scanning %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Code scanning - CodeQL +redirect_from: + - /code-security/code-scanning/managing-your-code-scanning-configuration/set-code-scanning-merge-protection +contentType: how-tos --- ## About using rulesets for {% data variables.product.prodname_code_scanning %} merge protection diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/advanced-setup-of-the-codeql-cli.md similarity index 94% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/advanced-setup-of-the-codeql-cli.md index e669f8e79337..89197bdf9849 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/advanced-setup-of-the-codeql-cli.md @@ -1,6 +1,6 @@ --- title: Advanced setup of the CodeQL CLI -intro: 'You can modify your {% data variables.product.prodname_codeql_cli %} setup to use a local checkout of the {% data variables.product.prodname_codeql %} repository for analysis, set up multiple versions of the {% data variables.product.prodname_codeql_cli %}, and analyze databases you have downloaded from {% data variables.product.github %}.' +intro: You can modify your {% data variables.product.prodname_codeql_cli %} setup to use a local checkout of the {% data variables.product.prodname_codeql %} repository for analysis, set up multiple versions of the {% data variables.product.prodname_codeql_cli %}, and analyze databases you have downloaded from {% data variables.product.github %}. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -10,6 +10,9 @@ topics: - Code Security - Code scanning - CodeQL +redirect_from: + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli +contentType: how-tos --- ## About advanced setup of the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-database-bundle-for-troubleshooting.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/creating-database-bundle-for-troubleshooting.md similarity index 87% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-database-bundle-for-troubleshooting.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/creating-database-bundle-for-troubleshooting.md index c497493490cd..bf18a811578b 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-database-bundle-for-troubleshooting.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/creating-database-bundle-for-troubleshooting.md @@ -1,6 +1,7 @@ --- title: Creating CodeQL CLI database bundles -intro: 'You can create a database bundle with {% data variables.product.prodname_codeql %} troubleshooting information.' +shortTitle: Createting CodeQL CLI database bundles +intro: You can create a database bundle with {% data variables.product.prodname_codeql %} troubleshooting information. allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.codeql %}' versions: @@ -11,6 +12,9 @@ topics: - Code Security - Code scanning - CodeQL +redirect_from: + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-database-bundle-for-troubleshooting +contentType: how-tos --- {% data reusables.code-scanning.codeql-database-archive-contains-source-code %} diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md new file mode 100644 index 000000000000..917b13c5ed9e --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/index.md @@ -0,0 +1,24 @@ +--- +title: Scan from the command line +intro: Run code scanning from the command line using the {% data variables.product.prodname_codeql_cli %} to configure scans, customize queries, and troubleshoot results. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - CodeQL +children: + - /setting-up-the-codeql-cli + - /advanced-setup-of-the-codeql-cli + - /using-custom-queries-with-the-codeql-cli + - /testing-query-help-files + - /specifying-command-options-in-a-codeql-configuration-file + - /creating-database-bundle-for-troubleshooting +redirect_from: + - /code-security/codeql-cli/using-the-codeql-cli + - /code-security/codeql-cli/getting-started-with-the-codeql-cli + - /code-security/codeql-cli +--- diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/setting-up-the-codeql-cli.md similarity index 95% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/setting-up-the-codeql-cli.md index 8b49b7bbc73c..8b93cd1271e1 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/setting-up-the-codeql-cli.md @@ -1,6 +1,7 @@ --- title: Setting up the CodeQL CLI -intro: 'To get started with the {% data variables.product.prodname_codeql_cli %}, you need to download and set up the CLI so that it can access the tools and libraries required to create and analyze databases.' +shortTitle: Set up the CodeQL CLI +intro: To get started with the {% data variables.product.prodname_codeql_cli %}, you need to download and set up the CLI so that it can access the tools and libraries required to create and analyze databases. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -16,7 +17,8 @@ redirect_from: - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-cli-in-your-ci-system - /code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system - /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system - + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/setting-up-the-codeql-cli +contentType: how-tos --- ## Setting up the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/specifying-command-options-in-a-codeql-configuration-file.md similarity index 90% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/specifying-command-options-in-a-codeql-configuration-file.md index 195cfc4bae53..8d9cf03e396f 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/specifying-command-options-in-a-codeql-configuration-file.md @@ -1,6 +1,7 @@ --- title: Specifying command options in a CodeQL configuration file -intro: 'You can save default command options in a {% data variables.product.prodname_codeql %} configuration file.' +shortTitle: Specify command options in a CodeQL configuration file +intro: You can save default command options in a {% data variables.product.prodname_codeql %} configuration file. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/specifying-command-options-in-a-codeql-configuration-file - /code-security/codeql-cli/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file +contentType: how-tos --- ## About specifying command options in a {% data variables.product.prodname_codeql %} configuration file diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-query-help-files.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/testing-query-help-files.md similarity index 93% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-query-help-files.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/testing-query-help-files.md index 09134f44276f..272b09a716b7 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-query-help-files.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/testing-query-help-files.md @@ -1,6 +1,7 @@ --- title: Testing query help files -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to preview your query help files as Markdown and ensure they are valid.' +shortTitle: Test query help files +intro: You can use the {% data variables.product.prodname_codeql_cli %} to preview your query help files as Markdown and ensure they are valid. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/testing-query-help-files - /code-security/codeql-cli/using-the-codeql-cli/testing-query-help-files + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-query-help-files +contentType: how-tos --- ## About testing query help files diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/using-custom-queries-with-the-codeql-cli.md similarity index 95% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/using-custom-queries-with-the-codeql-cli.md index 88c241fbfc78..e6fa4adbcb6d 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/using-custom-queries-with-the-codeql-cli.md @@ -1,6 +1,7 @@ --- title: Using custom queries with the CodeQL CLI -intro: 'You can write your own {% data variables.product.prodname_codeql %} queries to find specific vulnerabilities and errors.' +shortTitle: Use custom queries with the CodeQL CLI +intro: You can write your own {% data variables.product.prodname_codeql %} queries to find specific vulnerabilities and errors. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/using-custom-queries-with-the-codeql-cli - /code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli +contentType: how-tos --- ## About custom queries and the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/configuring-access-to-the-codeql-cli.md similarity index 88% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/configuring-access-to-the-codeql-cli.md index e8e2f97c566a..1ce5abc3c947 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/configuring-access-to-the-codeql-cli.md @@ -9,9 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'The {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension uses the {% data variables.product.prodname_codeql_cli %} to compile and run queries.' +intro: The {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension uses the {% data variables.product.prodname_codeql_cli %} to compile and run queries. allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/configuring-access-to-the-codeql-cli +contentType: how-tos --- ## Configuring access to the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/creating-a-custom-query.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/creating-a-custom-query.md similarity index 90% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/creating-a-custom-query.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/creating-a-custom-query.md index 1aaae688a008..c27899995a68 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/creating-a-custom-query.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/creating-a-custom-query.md @@ -9,8 +9,10 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can work from a template to write your own code to create a custom query to analyze a specific language.' +intro: You can work from a template to write your own code to create a custom query to analyze a specific language. +redirect_from: + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/creating-a-custom-query +contentType: how-tos --- ## About custom queries diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/customizing-settings.md similarity index 96% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/customizing-settings.md index 9f5819b3872b..856e276e543b 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/customizing-settings.md @@ -9,10 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can edit the settings for the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension to suit your needs.' +intro: You can edit the settings for the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension to suit your needs. redirect_from: - /code-security/codeql-for-vs-code/customizing-settings + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/customizing-settings +contentType: how-tos --- ## About settings in the {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %} extension diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-data-flow-with-path-queries.md similarity index 88% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-data-flow-with-path-queries.md index 4e388ae43285..53bfe43e1737 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-data-flow-with-path-queries.md @@ -9,10 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can run {% data variables.product.prodname_codeql %} queries in {% data variables.product.prodname_vscode %} to help you track the flow of data through a program, highlighting areas that are potential security vulnerabilities.' +intro: You can run {% data variables.product.prodname_codeql %} queries in {% data variables.product.prodname_vscode %} to help you track the flow of data through a program, highlighting areas that are potential security vulnerabilities. redirect_from: - /code-security/codeql-for-vs-code/exploring-data-flow-with-path-queries + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries +contentType: how-tos --- ## About path queries diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-the-structure-of-your-source-code.md similarity index 89% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-the-structure-of-your-source-code.md index 178f46e84a33..bbcf99b28a2c 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/exploring-the-structure-of-your-source-code.md @@ -9,10 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can use the AST viewer to display the abstract syntax tree of a {% data variables.product.prodname_codeql %} database.' +intro: You can use the AST viewer to display the abstract syntax tree of a {% data variables.product.prodname_codeql %} database. redirect_from: - /code-security/codeql-for-vs-code/exploring-the-structure-of-your-source-code + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/exploring-the-structure-of-your-source-code +contentType: how-tos --- ## About the abstract syntax tree diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/index.md new file mode 100644 index 000000000000..61c31ff12443 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/index.md @@ -0,0 +1,30 @@ +--- +title: Scan from VS Code +intro: Scan and analyze code from {% data variables.product.prodname_vscode %} using {% data variables.product.prodname_codeql %} to write, test, and run queries, explore code structure, and manage databases and packs. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code Security + - Code scanning + - CodeQL +redirect_from: + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension + - /code-security/codeql-for-vs-code +children: + - /installing-codeql-for-vs-code + - /managing-codeql-databases + - /running-codeql-queries + - /exploring-data-flow-with-path-queries + - /running-codeql-queries-at-scale-with-multi-repository-variant-analysis + - /using-the-codeql-model-editor + - /creating-a-custom-query + - /managing-codeql-packs + - /exploring-the-structure-of-your-source-code + - /testing-codeql-queries-in-vs-code + - /customizing-settings + - /setting-up-a-codeql-workspace + - /configuring-access-to-the-codeql-cli +--- diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/installing-codeql-for-vs-code.md similarity index 88% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/installing-codeql-for-vs-code.md index abb8f7c21051..18fefb32c1cf 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/installing-codeql-for-vs-code.md @@ -10,9 +10,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'To get started with {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %}, you need to install and set up the extension.' +intro: To get started with {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %}, you need to install and set up the extension. allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/installing-codeql-for-vs-code + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code + - /code-security/codeql-for-vs-code/setting-up-codeql-in-visual-studio-code +contentType: how-tos --- ## Prerequisites diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/managing-codeql-databases.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-databases.md similarity index 93% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/managing-codeql-databases.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-databases.md index 851f94d5fcb9..ffd53cb10306 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/managing-codeql-databases.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-databases.md @@ -9,8 +9,10 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can work with {% data variables.product.prodname_codeql %} databases using the extension.' +intro: You can work with {% data variables.product.prodname_codeql %} databases using the extension. +redirect_from: + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/managing-codeql-databases +contentType: how-tos --- ## About {% data variables.product.prodname_codeql %} databases diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/managing-codeql-packs.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-packs.md similarity index 91% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/managing-codeql-packs.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-packs.md index 911defcbc970..c21c795626be 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/managing-codeql-packs.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/managing-codeql-packs.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can view, write, and edit {% data variables.product.prodname_codeql %} query and library packs in {% data variables.product.prodname_vscode %} using the {% data variables.product.prodname_codeql %} extension.' +intro: You can view, write, and edit {% data variables.product.prodname_codeql %} query and library packs in {% data variables.product.prodname_vscode %} using the {% data variables.product.prodname_codeql %} extension. allowTitleToDifferFromFilename: true redirect_from: - /code-security/codeql-for-vs-code/working-with-codeql-packs-in-visual-studio-code + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/managing-codeql-packs +contentType: how-tos --- ## Benefits of using the {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %} to work with packs diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md similarity index 95% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md index 6bc0bfcc030d..524f3f4ccf9d 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis.md @@ -1,16 +1,17 @@ --- title: Running CodeQL queries at scale with multi-repository variant analysis -shortTitle: Queries at scale +shortTitle: Run queries at scale versions: - feature: codeql-vs-code-mrva + feature: codeql-vs-code-mrva topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can run {% data variables.product.prodname_codeql %} queries on a large number of repositories on {% data variables.product.github %} from {% data variables.product.prodname_vscode %}.' +intro: You can run {% data variables.product.prodname_codeql %} queries on a large number of repositories on {% data variables.product.github %} from {% data variables.product.prodname_vscode %}. redirect_from: - /code-security/codeql-for-vs-code/running-codeql-queries-at-scale-with-mrva + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis +contentType: how-tos --- ## About running {% data variables.product.prodname_codeql %} queries at scale with multi-repository variant analysis @@ -19,7 +20,7 @@ With multi-repository variant analysis (MRVA), you can run {% data variables.pro When you run MRVA against a list of repositories, your query is run against each repository that has a {% data variables.product.prodname_codeql %} database available to analyze. {% data variables.product.github %} creates and stores the latest {% data variables.product.prodname_codeql %} database for the default branch of thousands of public repositories, including every repository that runs {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}. -You need to enable {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %} on {% data variables.product.github %}, using either default setup or advanced setup, before adding your repository to a list for analysis. For information about enabling {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, see [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository#configuring-code-scanning-automatically). +You need to enable {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %} on {% data variables.product.github %}, using either default setup or advanced setup, before adding your repository to a list for analysis. For information about enabling {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, see [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning). ### How MRVA runs queries against {% data variables.product.prodname_codeql %} databases on {% data variables.product.prodname_dotcom_the_website %} @@ -125,7 +126,7 @@ You can export your results for further analysis or to discuss them with collabo ## Creating a custom list of repositories > [!NOTE] -> {% data variables.product.prodname_codeql %} analysis always requires a {% data variables.product.prodname_codeql %} database to run queries against. When you run variant analysis against a list of repositories, your query will only be executed against the repositories that currently have a {% data variables.product.prodname_codeql %} database available to download. The best way to make a repository available for variant analysis is to enable {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}. For information about enabling {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, see [AUTOTITLE](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository#configuring-code-scanning-automatically). +> {% data variables.product.prodname_codeql %} analysis always requires a {% data variables.product.prodname_codeql %} database to run queries against. When you run variant analysis against a list of repositories, your query will only be executed against the repositories that currently have a {% data variables.product.prodname_codeql %} database available to download. The best way to make a repository available for variant analysis is to enable {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %}. For information about enabling {% data variables.product.prodname_code_scanning %} using {% data variables.product.prodname_codeql %}, see [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning). 1. In the "Variant Analysis Repositories" view, click the "Add list" icon. diff --git a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries.md similarity index 97% rename from content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries.md index 1f9b6dc73795..ad0532d2da46 100644 --- a/content/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/running-codeql-queries.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can run queries on {% data variables.product.prodname_codeql %} databases and view the results in {% data variables.product.prodname_vscode %}.' +intro: You can run queries on {% data variables.product.prodname_codeql %} databases and view the results in {% data variables.product.prodname_vscode %}. allowTitleToDifferFromFilename: true redirect_from: - /code-security/codeql-for-vs-code/analyzing-your-projects + - /code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries +contentType: how-tos --- ## About running {% data variables.product.prodname_codeql %} queries diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/setting-up-a-codeql-workspace.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/setting-up-a-codeql-workspace.md similarity index 93% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/setting-up-a-codeql-workspace.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/setting-up-a-codeql-workspace.md index 7577fb098fd9..5a6fd67753de 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/setting-up-a-codeql-workspace.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/setting-up-a-codeql-workspace.md @@ -9,9 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'When you''re working with {% data variables.product.prodname_codeql %}, you need access to the standard libraries and queries.' +intro: When you're working with {% data variables.product.prodname_codeql %}, you need access to the standard libraries and queries. allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/setting-up-a-codeql-workspace +contentType: how-tos --- ## Setting up a {% data variables.product.prodname_codeql %} workspace diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/testing-codeql-queries-in-vs-code.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/testing-codeql-queries-in-vs-code.md similarity index 93% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/testing-codeql-queries-in-vs-code.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/testing-codeql-queries-in-vs-code.md index aca4591a9afc..70b40239550f 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/testing-codeql-queries-in-vs-code.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/testing-codeql-queries-in-vs-code.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can run unit tests for {% data variables.product.prodname_codeql %} queries using the {% data variables.product.prodname_vscode %} extension.' +intro: You can run unit tests for {% data variables.product.prodname_codeql %} queries using the {% data variables.product.prodname_vscode %} extension. allowTitleToDifferFromFilename: true redirect_from: - /code-security/codeql-for-vs-code/testing-codeql-queries-in-visual-studio-code + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/testing-codeql-queries-in-vs-code +contentType: how-tos --- ## About testing queries in {% data variables.product.prodname_vscode_shortname %} diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md similarity index 97% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md index 09c52ad99712..cd6ef4c7615d 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/scan-from-vs-code/using-the-codeql-model-editor.md @@ -1,6 +1,6 @@ --- title: Using the CodeQL model editor -shortTitle: CodeQL model editor +shortTitle: Use the model editor versions: fpt: '*' ghec: '*' @@ -9,10 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'You can view, write, and edit {% data variables.product.prodname_codeql %} model packs in {% data variables.product.prodname_vscode %}.' +intro: You can view, write, and edit {% data variables.product.prodname_codeql %} model packs in {% data variables.product.prodname_vscode %}. redirect_from: - /code-security/codeql-for-vs-code/using-the-codeql-model-editor + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/using-the-codeql-model-editor +contentType: how-tos --- {% data reusables.code-scanning.beta-model-packs %} diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/index.md new file mode 100644 index 000000000000..93858efe0259 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/index.md @@ -0,0 +1,23 @@ +--- +title: Troubleshooting +shortTitle: Troubleshoot +intro: Diagnose and resolve issues with code scanning by troubleshooting analysis errors and problems uploading SARIF results. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code scanning + - Errors + - Troubleshooting + - SARIF +children: + - /troubleshooting-codeql-for-vs-code + - /troubleshooting-analysis-errors + - /troubleshooting-sarif-uploads +redirect_from: + - /code-security/code-scanning/troubleshooting-sarif + - /code-security/code-scanning/troubleshooting-sarif-uploads +--- + diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/advanced-security-must-be-enabled.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/advanced-security-must-be-enabled.md similarity index 94% rename from content/code-security/code-scanning/troubleshooting-code-scanning/advanced-security-must-be-enabled.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/advanced-security-must-be-enabled.md index b2c6d1a66cba..017812c5d5bb 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/advanced-security-must-be-enabled.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/advanced-security-must-be-enabled.md @@ -1,9 +1,8 @@ --- title: 'Error: "{% data variables.product.prodname_GHAS_or_code_security %} must be enabled for this repository to use code scanning"' shortTitle: '{% data variables.product.prodname_code_security %} must be enabled' -intro: 'If you see this error, make sure that {% data variables.product.prodname_GH_code_security %} is enabled.' +intro: If you see this error, make sure that {% data variables.product.prodname_GH_code_security %} is enabled. allowTitleToDifferFromFilename: true -type: reference topics: - Code scanning - Errors @@ -12,6 +11,9 @@ versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/advanced-security-must-be-enabled +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/alerts-in-generated-code.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/alerts-in-generated-code.md similarity index 60% rename from content/code-security/code-scanning/troubleshooting-code-scanning/alerts-in-generated-code.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/alerts-in-generated-code.md index 0367a9f0e7af..ff0b443bfa33 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/alerts-in-generated-code.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/alerts-in-generated-code.md @@ -1,7 +1,7 @@ --- 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.' +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: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/alerts-found-in-generated-code + - /code-security/code-scanning/troubleshooting-code-scanning/alerts-in-generated-code +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/analysis-takes-too-long.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/analysis-takes-too-long.md similarity index 96% rename from content/code-security/code-scanning/troubleshooting-code-scanning/analysis-takes-too-long.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/analysis-takes-too-long.md index 0ca7fad654b7..530e7a35399b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/analysis-takes-too-long.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/analysis-takes-too-long.md @@ -1,7 +1,7 @@ --- 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.' +intro: You can fine tune your {% data variables.product.prodname_code_scanning %} configuration to minimize analysis time. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/build-is-taking-too-long + - /code-security/code-scanning/troubleshooting-code-scanning/analysis-takes-too-long +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/automatic-build-failed.md similarity index 79% rename from content/code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/automatic-build-failed.md index 95ce2f09070c..47e78d658d2b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/automatic-build-failed.md @@ -2,13 +2,15 @@ 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.' +intro: If automatic build fails, you can configure {% data variables.product.prodname_code_scanning %} to use specific build steps for compiled languages. versions: fpt: '*' ghes: '*' ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed-for-a-compiled-language + - /code-security/code-scanning/troubleshooting-code-scanning/automatic-build-failed +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/c-sharp-compiler-unexpectedly-failing.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/c-sharp-compiler-unexpectedly-failing.md similarity index 84% rename from content/code-security/code-scanning/troubleshooting-code-scanning/c-sharp-compiler-unexpectedly-failing.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/c-sharp-compiler-unexpectedly-failing.md index a77b97db3768..d9d8fb6b06a5 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/c-sharp-compiler-unexpectedly-failing.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/c-sharp-compiler-unexpectedly-failing.md @@ -1,12 +1,15 @@ --- -title: 'C# compiler unexpectedly failing' -shortTitle: 'C# compiler failing' +title: C# compiler unexpectedly failing +shortTitle: C# compiler failing allowTitleToDifferFromFilename: true -intro: 'If your MSBuild C# compilation is unexpectedly failing, you may need to amend your application project file.' +intro: If your MSBuild C# compilation is unexpectedly failing, you may need to amend your application project file. versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/c-sharp-compiler-unexpectedly-failing +contentType: how-tos --- ## About these errors diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/cannot-enable-codeql-in-a-private-repository.md similarity index 94% rename from content/code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/cannot-enable-codeql-in-a-private-repository.md index 3341a87b57fb..3dd31a54d278 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/cannot-enable-codeql-in-a-private-repository.md @@ -1,8 +1,7 @@ --- -title: 'Cannot enable CodeQL in a private repository' +title: Cannot enable CodeQL in a private repository intro: '{% data variables.product.prodname_GH_code_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 @@ -11,6 +10,9 @@ versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository +contentType: how-tos --- {% ifversion fpt %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/enabling-default-setup-takes-too-long.md similarity index 82% rename from content/code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/enabling-default-setup-takes-too-long.md index 1eba1d0b2007..e97c40f7b551 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/enabling-default-setup-takes-too-long.md @@ -1,11 +1,14 @@ --- -title: 'Enabling default setup takes too long' -intro: 'If you think that enabling default setup has stalled, you can restart the process.' +title: Enabling default setup takes too long +intro: If you think that enabling default setup has stalled, you can restart the process. allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long +contentType: how-tos --- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/extraction-errors-in-the-database.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/extraction-errors-in-the-database.md similarity index 77% rename from content/code-security/code-scanning/troubleshooting-code-scanning/extraction-errors-in-the-database.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/extraction-errors-in-the-database.md index 94520fc66883..37584813d533 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/extraction-errors-in-the-database.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/extraction-errors-in-the-database.md @@ -1,11 +1,14 @@ --- -title: 'Extraction errors in the database' -intro: 'You can check whether or not extraction errors affect the health of the {% data variables.product.prodname_codeql %} database created.' +title: Extraction errors in the database +intro: You can check whether or not extraction errors affect the health of the {% data variables.product.prodname_codeql %} database created. allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/extraction-errors-in-the-database +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/fewer-lines-scanned-than-expected.md similarity index 93% rename from content/code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/fewer-lines-scanned-than-expected.md index b4f2a84051e6..9a5d70e052b0 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/fewer-lines-scanned-than-expected.md @@ -1,7 +1,7 @@ --- title: CodeQL scanned fewer lines than expected shortTitle: Fewer lines scanned than expected -intro: 'If {% data variables.product.prodname_codeql %} analyzed less code than you expected, you may need to use a custom build command.' +intro: If {% data variables.product.prodname_codeql %} analyzed less code than you expected, you may need to use a custom build command. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected + - /code-security/code-scanning/troubleshooting-code-scanning/fewer-lines-scanned-than-expected +contentType: how-tos --- ## About analysis of compiled languages diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/index.md similarity index 77% rename from content/code-security/code-scanning/troubleshooting-code-scanning/index.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/index.md index ae91122e9735..5da839a58d1b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/index.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/index.md @@ -1,39 +1,41 @@ --- -title: Troubleshooting code scanning -intro: 'When analyzing your code with {% data variables.product.prodname_code_scanning %}, you may need to troubleshoot unexpected issues.' -redirect_from: - - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-your-default-setup-for-codeql - - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow - - /code-security/code-scanning/troubleshooting-code-scanning/results-differ-between-platforms +title: Troubleshooting analysis errors +shortTitle: Troubleshoot analysis errors +intro: Identify and resolve errors that occur during code analysis, including build failures, incomplete scans, resource limits, and unexpected results. versions: fpt: '*' ghes: '*' ghec: '*' +contentType: how-tos topics: - - Code Security - Code scanning - - CodeQL - - Repositories + - Errors + - Troubleshooting children: - - /advanced-security-must-be-enabled - /alerts-in-generated-code - - /analysis-takes-too-long - /automatic-build-failed - /c-sharp-compiler-unexpectedly-failing - /cannot-enable-codeql-in-a-private-repository - - /enabling-default-setup-takes-too-long - - /extraction-errors-in-the-database + - /analysis-takes-too-long - /fewer-lines-scanned-than-expected - - /logs-not-detailed-enough - - /no-source-code-seen-during-build - - /not-recognized + - /enabling-default-setup-takes-too-long + - /advanced-security-must-be-enabled - /out-of-disk-or-memory - /resource-not-accessible - - /results-different-than-expected + - /not-recognized + - /no-source-code-seen-during-build - /server-error + - /extraction-errors-in-the-database + - /logs-not-detailed-enough + - /results-different-than-expected - /some-languages-not-analyzed - /two-codeql-workflows - /unclear-what-triggered-a-workflow - /unnecessary-step-found - /kotlin-detected-in-no-build +redirect_from: + - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-your-default-setup-for-codeql + - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow + - /code-security/code-scanning/troubleshooting-code-scanning/results-differ-between-platforms + - /code-security/code-scanning/troubleshooting-code-scanning --- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/kotlin-detected-in-no-build.md similarity index 97% rename from content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/kotlin-detected-in-no-build.md index 7487635f7f66..4efb1cfe7252 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/kotlin-detected-in-no-build.md @@ -7,6 +7,9 @@ versions: fpt: '*' ghec: '*' ghes: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/kotlin-detected-in-no-build +contentType: how-tos --- ## About this warning diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/logs-not-detailed-enough.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/logs-not-detailed-enough.md similarity index 94% rename from content/code-security/code-scanning/troubleshooting-code-scanning/logs-not-detailed-enough.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/logs-not-detailed-enough.md index 45d2c4d745f8..626786215c39 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/logs-not-detailed-enough.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/logs-not-detailed-enough.md @@ -1,7 +1,7 @@ --- 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.' +intro: If you'd like to increase the level of detail in your logs, try these steps. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/logs-are-not-detailed-enough + - /code-security/code-scanning/troubleshooting-code-scanning/logs-not-detailed-enough +contentType: how-tos --- If your logs are not detailed enough, there are several steps you can take to make them more useful. diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/no-source-code-seen-during-build.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/no-source-code-seen-during-build.md similarity index 93% rename from content/code-security/code-scanning/troubleshooting-code-scanning/no-source-code-seen-during-build.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/no-source-code-seen-during-build.md index 6602a72d7950..0a73b21bda3b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/no-source-code-seen-during-build.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/no-source-code-seen-during-build.md @@ -1,12 +1,15 @@ --- title: 'Error: "No source code was seen during the build"' -shortTitle: 'No source code seen during build' -intro: 'When {% data variables.product.prodname_codeql %} fails to find any source code, you need to resolve this problem to unblock {% data variables.product.prodname_code_scanning %} analysis.' +shortTitle: No source code seen during build +intro: When {% data variables.product.prodname_codeql %} fails to find any source code, you need to resolve this problem to unblock {% data variables.product.prodname_code_scanning %} analysis. allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/no-source-code-seen-during-build +contentType: how-tos --- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/not-recognized.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/not-recognized.md similarity index 89% rename from content/code-security/code-scanning/troubleshooting-code-scanning/not-recognized.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/not-recognized.md index 6506bd4cdba7..a88ae160b1e0 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/not-recognized.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/not-recognized.md @@ -7,6 +7,9 @@ versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/not-recognized +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/out-of-disk-or-memory.md similarity index 85% rename from content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/out-of-disk-or-memory.md index 25047ffa4632..9b802a862b34 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/out-of-disk-or-memory.md @@ -1,12 +1,15 @@ --- title: 'Error: "Out of disk" or Error: "Out of memory"' -shortTitle: 'Out of disk or memory' -intro: 'If you see one of these errors with {% data variables.product.prodname_actions %}, {% ifversion ghes %}try reviewing the specifications of your self-hosted runners.{% else %}you can try alternative runners.{% endif %}' +shortTitle: Out of disk or memory +intro: If you see one of these errors with {% data variables.product.prodname_actions %}, {% ifversion ghes %}try reviewing the specifications of your self-hosted runners.{% else %}you can try alternative runners.{% endif %} allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/out-of-disk-or-memory +contentType: how-tos --- diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/resource-not-accessible.md similarity index 93% rename from content/code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/resource-not-accessible.md index f01dfcb46087..3a14bb7db0d8 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/resource-not-accessible.md @@ -1,13 +1,15 @@ --- title: 'Error: 403 "Resource not accessible by integration"' 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.' +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 + - /code-security/code-scanning/troubleshooting-code-scanning/resource-not-accessible +contentType: how-tos --- >[!NOTE] diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/results-different-than-expected.md similarity index 88% rename from content/code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/results-different-than-expected.md index a0dc68b961fa..09ecc303275b 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/results-different-than-expected.md @@ -1,7 +1,7 @@ --- 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.' +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: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/results-are-different-than-expected + - /code-security/code-scanning/troubleshooting-code-scanning/results-different-than-expected +contentType: how-tos --- If your {% data variables.product.prodname_code_scanning %} results are different than you expected, you may have both default and advanced setup configured for your repository. When you enable default setup, this disables the existing {% data variables.product.prodname_codeql %} workflow file and blocks any {% data variables.product.prodname_codeql %} API analysis from uploading results. diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/server-error.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/server-error.md similarity index 66% rename from content/code-security/code-scanning/troubleshooting-code-scanning/server-error.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/server-error.md index 06f6870360b9..baf62d881ade 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/server-error.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/server-error.md @@ -1,11 +1,14 @@ --- title: 'Error: "Server error"' -shortTitle: 'Server error' -intro: 'If you see this error, it may be transient. Check the current {% data variables.product.prodname_actions %} service status, and try running your workflow again.' +shortTitle: Server error +intro: If you see this error, it may be transient. Check the current {% data variables.product.prodname_actions %} service status, and try running your workflow again. allowTitleToDifferFromFilename: true versions: fpt: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/server-error +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/some-languages-not-analyzed.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/some-languages-not-analyzed.md similarity index 86% rename from content/code-security/code-scanning/troubleshooting-code-scanning/some-languages-not-analyzed.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/some-languages-not-analyzed.md index 4a3fa689b9d8..847a292fecba 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/some-languages-not-analyzed.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/some-languages-not-analyzed.md @@ -2,13 +2,15 @@ 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.' +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: fpt: '*' ghes: '*' ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/some-languages-were-not-analyzed + - /code-security/code-scanning/troubleshooting-code-scanning/some-languages-not-analyzed +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/two-codeql-workflows.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/two-codeql-workflows.md similarity index 75% rename from content/code-security/code-scanning/troubleshooting-code-scanning/two-codeql-workflows.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/two-codeql-workflows.md index 7fd41f4e0b02..4f81958430fa 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/two-codeql-workflows.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/two-codeql-workflows.md @@ -1,11 +1,14 @@ --- -title: 'Two CodeQL workflows' +title: Two CodeQL workflows allowTitleToDifferFromFilename: true -intro: 'If you see two workflows named "{% data variables.product.prodname_codeql %}", one workflow may be a pre-existing {% data variables.product.prodname_codeql %} workflow file which has been disabled by default setup.' +intro: If you see two workflows named "{% data variables.product.prodname_codeql %}", one workflow may be a pre-existing {% data variables.product.prodname_codeql %} workflow file which has been disabled by default setup. versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/two-codeql-workflows +contentType: how-tos --- {% data reusables.code-scanning.codeql-action-version-ghes %} diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unclear-what-triggered-a-workflow.md similarity index 82% rename from content/code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unclear-what-triggered-a-workflow.md index 71ec314ac42c..c8552d188332 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unclear-what-triggered-a-workflow.md @@ -1,7 +1,7 @@ --- title: Unclear what triggered a workflow run shortTitle: Unclear what triggered a workflow -intro: 'If you don''t know what triggered an analysis, investigate the {% data variables.code-scanning.tool_status_page %} or look at the log for the last scan.' +intro: If you don't know what triggered an analysis, investigate the {% data variables.code-scanning.tool_status_page %} or look at the log for the last scan. allowTitleToDifferFromFilename: true versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow-run + - /code-security/code-scanning/troubleshooting-code-scanning/unclear-what-triggered-a-workflow +contentType: how-tos --- The {% data variables.code-scanning.tool_status_page %} shows you how well {% data variables.product.prodname_code_scanning %} tools are working for a repository, when files in the repository were first scanned and most recently scanned, and when scans are scheduled. For integrated tools like {% data variables.product.prodname_codeql %}, you can also see more detailed information, including a percentage of files scanned and specific error messages. For more information about the {% data variables.code-scanning.tool_status_page %}, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page). diff --git a/content/code-security/code-scanning/troubleshooting-code-scanning/unnecessary-step-found.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unnecessary-step-found.md similarity index 89% rename from content/code-security/code-scanning/troubleshooting-code-scanning/unnecessary-step-found.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unnecessary-step-found.md index 015173768f81..854ce9c6b6c6 100644 --- a/content/code-security/code-scanning/troubleshooting-code-scanning/unnecessary-step-found.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/unnecessary-step-found.md @@ -1,12 +1,15 @@ --- title: 'Warning: "1 issue was detected with this workflow: git checkout HEAD^2 is no longer necessary"' -shortTitle: 'Unnecessary step found' -intro: 'If you see this warning, you should update your workflow to follow current best practice.' +shortTitle: Unnecessary step found +intro: If you see this warning, you should update your workflow to follow current best practice. allowTitleToDifferFromFilename: true versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/code-scanning/troubleshooting-code-scanning/unnecessary-step-found +contentType: how-tos --- ## About this warning diff --git a/content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/accessing-logs.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/accessing-logs.md similarity index 79% rename from content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/accessing-logs.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/accessing-logs.md index 9e83027c96ae..fe4f9b503b51 100644 --- a/content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/accessing-logs.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/accessing-logs.md @@ -1,6 +1,6 @@ --- -title: 'Accessing logs' -shortTitle: 'Access logs' +title: Accessing logs +shortTitle: Access logs versions: fpt: '*' ghec: '*' @@ -9,9 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'If you need to troubleshoot problems with {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %}, there are several logs you can access.' +intro: If you need to troubleshoot problems with {% data variables.product.prodname_codeql %} for {% data variables.product.prodname_vscode %}, there are several logs you can access. allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/accessing-logs +contentType: how-tos --- ## About logs diff --git a/content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/index.md similarity index 60% rename from content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/index.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/index.md index 37db10207b14..58f3c4934ebb 100644 --- a/content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/index.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/index.md @@ -1,6 +1,6 @@ --- title: Troubleshooting CodeQL for VS Code -intro: 'Learn how to resolve problems with the {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %}.' +intro: Learn how to resolve problems with the {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode %}. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -15,4 +15,7 @@ children: - /warning-problem-with-controller-repository redirect_from: - /code-security/codeql-for-vs-code/troubleshooting-codeql-for-visual-studio-code + - /code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code +contentType: how-tos --- + diff --git a/content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/warning-problem-with-controller-repository.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/warning-problem-with-controller-repository.md similarity index 81% rename from content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/warning-problem-with-controller-repository.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/warning-problem-with-controller-repository.md index 523498eed35a..5a538095013d 100644 --- a/content/code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/warning-problem-with-controller-repository.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/warning-problem-with-controller-repository.md @@ -1,16 +1,17 @@ --- -title: 'Problem with controller repository' +title: Problem with controller repository versions: feature: codeql-vs-code-mrva topics: - Code Security - Code scanning - CodeQL -type: reference -intro: 'If you see this warning, update your controller repository to a private repository.' +intro: If you see this warning, update your controller repository to a private repository. allowTitleToDifferFromFilename: true redirect_from: - /code-security/codeql-for-vs-code/troubleshooting-variant-analysis + - /code-security/codeql-for-vs-code/troubleshooting-codeql-for-vs-code/warning-problem-with-controller-repository +contentType: how-tos --- ## About this warning diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/default-setup-enabled.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/default-setup-enabled.md similarity index 82% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/default-setup-enabled.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/default-setup-enabled.md index 4af686973052..30bd30e1c4c5 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/default-setup-enabled.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/default-setup-enabled.md @@ -1,9 +1,8 @@ --- -title: 'Upload was rejected because CodeQL default setup is enabled for {% data variables.product.prodname_code_scanning %}' +title: Upload was rejected because CodeQL default setup is enabled for {% data variables.product.prodname_code_scanning %} shortTitle: Default setup is enabled allowTitleToDifferFromFilename: true -intro: 'You cannot upload SARIF results generated by the {% data variables.product.prodname_codeql %} action or {% data variables.product.prodname_codeql %} CLI when default setup for {% data variables.product.prodname_code_scanning %} is enabled. Check your configuration and decide whether to keep default setup or unblock SARIF upload.' -type: reference +intro: You cannot upload SARIF results generated by the {% data variables.product.prodname_codeql %} action or {% data variables.product.prodname_codeql %} CLI when default setup for {% data variables.product.prodname_code_scanning %} is enabled. Check your configuration and decide whether to keep default setup or unblock SARIF upload. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/default-setup-enabled + - /code-security/code-scanning/troubleshooting-sarif-uploads/default-setup-enabled +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/file-too-large.md similarity index 96% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/file-too-large.md index a1854f8ebaf9..dc586bc5fdc2 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/file-too-large.md @@ -1,9 +1,8 @@ --- -title: 'SARIF results file is too large' +title: SARIF results file is too large shortTitle: Results file too large allowTitleToDifferFromFilename: true -intro: 'You cannot upload a SARIF results file larger than 10 MB to {% data variables.product.prodname_code_scanning %}. Explore ways to generate a smaller file containing the highest impact results.' -type: reference +intro: You cannot upload a SARIF results file larger than 10 MB to {% data variables.product.prodname_code_scanning %}. Explore ways to generate a smaller file containing the highest impact results. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/file-too-large + - /code-security/code-scanning/troubleshooting-sarif-uploads/file-too-large +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/ghas-required.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/ghas-required.md similarity index 77% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/ghas-required.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/ghas-required.md index 20170e188764..d916b181dad6 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/ghas-required.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/ghas-required.md @@ -1,9 +1,8 @@ --- -title: 'Upload fails because {% data variables.product.prodname_GH_code_security %} is disabled' +title: Upload fails because {% data variables.product.prodname_GH_code_security %} is disabled shortTitle: '{% data variables.product.prodname_GH_code_security %} disabled' allowTitleToDifferFromFilename: true -intro: 'You can only upload SARIF results to {% ifversion fpt or ghec %}private or internal {% endif %}repositories where {% data variables.product.prodname_GH_code_security %} is enabled.' -type: reference +intro: You can only upload SARIF results to {% ifversion fpt or ghec %}private or internal {% endif %}repositories where {% data variables.product.prodname_GH_code_security %} is enabled. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/ghas-required + - /code-security/code-scanning/troubleshooting-sarif-uploads/ghas-required +contentType: how-tos --- ## About this error diff --git a/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/index.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/index.md new file mode 100644 index 000000000000..8205a9eeada5 --- /dev/null +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/index.md @@ -0,0 +1,22 @@ +--- +title: Troubleshooting SARIF uploads +shortTitle: Troubleshoot SARIF uploads +intro: Identify and resolve issues when uploading SARIF files, including authentication problems, file validation errors, and upload limits. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +topics: + - Code scanning + - Errors + - SARIF + - Troubleshooting +children: + - /missing-token + - /sarif-invalid + - /results-exceed-limit + - /file-too-large + - /ghas-required + - /default-setup-enabled +--- diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/missing-token.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/missing-token.md similarity index 86% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/missing-token.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/missing-token.md index 80c7951c63ef..bcd4a7abbee2 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/missing-token.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/missing-token.md @@ -1,9 +1,8 @@ --- -title: 'GitHub token is required to upload SARIF results' +title: GitHub token is required to upload SARIF results shortTitle: GitHub token missing allowTitleToDifferFromFilename: true -intro: 'You need to provide an authentication method for the upload process to use to access the repository.' -type: reference +intro: You need to provide an authentication method for the upload process to use to access the repository. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/missing-token + - /code-security/code-scanning/troubleshooting-sarif-uploads/missing-token +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/results-exceed-limit.md similarity index 96% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/results-exceed-limit.md index a1b4c8505f1d..bea39feb7005 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/results-exceed-limit.md @@ -1,9 +1,8 @@ --- -title: 'SARIF results exceed one or more limits' +title: SARIF results exceed one or more limits shortTitle: Results exceed limits allowTitleToDifferFromFilename: true -intro: 'Learn how to resolve problems when a SARIF file is rejected by {% data variables.product.prodname_code_scanning %} because one or more limits is exceeded.' -type: reference +intro: Learn how to resolve problems when a SARIF file is rejected by {% data variables.product.prodname_code_scanning %} because one or more limits is exceeded. topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/results-exceed-limit + - /code-security/code-scanning/troubleshooting-sarif-uploads/results-exceed-limit +contentType: how-tos --- ## About {% data variables.product.prodname_code_scanning %} limits on SARIF results diff --git a/content/code-security/code-scanning/troubleshooting-sarif-uploads/sarif-invalid.md b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/sarif-invalid.md similarity index 92% rename from content/code-security/code-scanning/troubleshooting-sarif-uploads/sarif-invalid.md rename to content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/sarif-invalid.md index 24f668112f4b..155b212be343 100644 --- a/content/code-security/code-scanning/troubleshooting-sarif-uploads/sarif-invalid.md +++ b/content/code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-sarif-uploads/sarif-invalid.md @@ -1,9 +1,8 @@ --- -title: 'SARIF file is invalid' +title: SARIF file is invalid shortTitle: SARIF file invalid allowTitleToDifferFromFilename: true intro: '{% data variables.product.prodname_code_scanning_caps %} can only process syntactically valid SARIF files. Invalid files are rejected.' -type: reference topics: - Code scanning - Errors @@ -15,6 +14,8 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/troubleshooting-sarif/sarif-invalid + - /code-security/code-scanning/troubleshooting-sarif-uploads/sarif-invalid +contentType: how-tos --- ## About this error diff --git a/content/code-security/code-quality/how-tos/allow-in-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise.md similarity index 87% rename from content/code-security/code-quality/how-tos/allow-in-enterprise.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise.md index 5baeb2121cea..cc8cea2907d2 100644 --- a/content/code-security/code-quality/how-tos/allow-in-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/allow-github-code-quality-in-enterprise.md @@ -1,16 +1,19 @@ --- title: Allowing use of {% data variables.product.prodname_code_quality %} in your enterprise -shortTitle: Allow in enterprise -intro: 'Define policies for {% data variables.product.prodname_AS %} that allow repository owners to enable {% data variables.product.prodname_code_quality %}.' +shortTitle: Allow {% data variables.product.prodname_code_quality_short %} +intro: Define policies for {% data variables.product.prodname_AS %} that allow repository owners to enable {% data variables.product.prodname_code_quality %}. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' -permissions: 'Enterprise owners' +permissions: Enterprise owners audience: - driver topics: - Code Quality contentType: how-tos +allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/code-quality/how-tos/allow-in-enterprise --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-code-scanning-for-your-appliance.md similarity index 95% rename from content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-code-scanning-for-your-appliance.md index a1137757ff5e..8de323da91df 100644 --- a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-code-scanning-for-your-appliance.md @@ -1,7 +1,7 @@ --- title: '{% ifversion ghes %}Configuring code scanning for your appliance{% elsif default-setup-self-hosted-runners-GHEC %}Configuring self-hosted runners for code scanning in your enterprise{% endif %}' -shortTitle: Configuring code scanning -intro: 'You can enable, configure, and disable {% data variables.product.prodname_code_scanning %} for your enterprise{% ifversion default-setup-self-hosted-runners-GHEC %} without {% data variables.product.prodname_dotcom %}-hosted runners{% endif %}. {% data variables.product.prodname_code_scanning_caps %} allows users to scan code for vulnerabilities and errors.' +shortTitle: Configure code scanning +intro: You can enable, configure, and disable {% data variables.product.prodname_code_scanning %} for your enterprise{% ifversion default-setup-self-hosted-runners-GHEC %} without {% data variables.product.prodname_dotcom %}-hosted runners{% endif %}. {% data variables.product.prodname_code_scanning_caps %} allows users to scan code for vulnerabilities and errors. allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.code-scanning %}' redirect_from: @@ -9,15 +9,16 @@ redirect_from: - /admin/configuration/configuring-code-scanning-for-your-appliance - /admin/advanced-security/configuring-code-scanning-for-your-appliance - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance + - /admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance versions: ghes: '*' ghec: '*' -type: how_to topics: - Advanced Security - Code scanning - Enterprise - Security +contentType: how-tos --- diff --git a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-dependabot-to-work-with-limited-internet-access.md similarity index 94% rename from content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-dependabot-to-work-with-limited-internet-access.md index ef48005ce65e..99e44183646a 100644 --- a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-dependabot-to-work-with-limited-internet-access.md @@ -1,9 +1,8 @@ --- title: Configuring Dependabot to work with limited internet access -intro: 'You can configure {% data variables.product.prodname_dependabot %} to generate pull requests for version and security updates using private registries when {% data variables.product.prodname_ghe_server %} has limited, or no, internet access.' +intro: You can configure {% data variables.product.prodname_dependabot %} to generate pull requests for version and security updates using private registries when {% data variables.product.prodname_ghe_server %} has limited, or no, internet access. versions: feature: dependabot-ghes-no-public-internet -type: how_to topics: - Dependabot - Version updates @@ -13,6 +12,8 @@ topics: shortTitle: Limited internet access redirect_from: - /admin/code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access + - /admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/configuring-dependabot-to-work-with-limited-internet-access +contentType: how-tos --- ## About {% data variables.product.prodname_dependabot %} updates diff --git a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-dependency-review-for-your-appliance.md similarity index 89% rename from content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-dependency-review-for-your-appliance.md index 71fa68234bd9..dcba4160d9b8 100644 --- a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-dependency-review-for-your-appliance.md @@ -1,11 +1,10 @@ --- title: Configuring dependency review for your appliance -shortTitle: Configuring dependency review -intro: 'To help users understand dependency changes when reviewing pull requests, you can enable, configure, and disable dependency review for {% data variables.product.prodname_ghe_server %}.' +shortTitle: Configure dependency review +intro: To help users understand dependency changes when reviewing pull requests, you can enable, configure, and disable dependency review for {% data variables.product.prodname_ghe_server %}. product: '{% data reusables.gated-features.dependency-review %}' versions: ghes: '*' -type: how_to topics: - Advanced Security - Enterprise @@ -13,6 +12,8 @@ topics: - Security redirect_from: - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance + - /admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance +contentType: how-tos --- ## About dependency review diff --git a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-secret-scanning-for-your-appliance.md similarity index 90% rename from content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-secret-scanning-for-your-appliance.md index 86707a66323c..1786942ed315 100644 --- a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-secret-scanning-for-your-appliance.md @@ -1,20 +1,21 @@ --- title: Configuring secret scanning for your appliance -shortTitle: Configuring secret scanning -intro: 'You can enable, configure, and disable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.prodname_ghe_server %}. {% data variables.product.prodname_secret_scanning_caps %} allows users to scan code for accidentally committed secrets.' +shortTitle: Configure secret scanning +intro: You can enable, configure, and disable {% data variables.product.prodname_secret_scanning %} for {% data variables.product.prodname_ghe_server %}. {% data variables.product.prodname_secret_scanning_caps %} allows users to scan code for accidentally committed secrets. product: '{% data reusables.gated-features.secret-scanning %}' redirect_from: - /admin/configuration/configuring-secret-scanning-for-your-appliance - /admin/advanced-security/configuring-secret-scanning-for-your-appliance - /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance + - /admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance versions: ghes: '*' -type: how_to topics: - Advanced Security - Enterprise - Secret scanning - Security +contentType: how-tos --- ## About {% data variables.product.prodname_secret_scanning %} diff --git a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/enabling-the-dependency-graph-for-your-enterprise.md similarity index 94% rename from content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/enabling-the-dependency-graph-for-your-enterprise.md index 6139e4ec6f50..64900f631af9 100644 --- a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/enabling-the-dependency-graph-for-your-enterprise.md @@ -5,13 +5,14 @@ shortTitle: Enable dependency graph permissions: Site administrators can enable the dependency graph. versions: ghes: '*' -type: how_to topics: - Enterprise - Security - Dependency graph redirect_from: - /admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise + - /admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise +contentType: how-tos --- ## About the dependency graph diff --git a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/index.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/index.md new file mode 100644 index 000000000000..e19955e7173b --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/index.md @@ -0,0 +1,18 @@ +--- +title: Configure specific tools +intro: Learn how to configure specific {% data variables.product.github %} security and quality tools—such as the dependency graph, {% data variables.product.prodname_code_scanning %}, secret scanning, and {% data variables.product.prodname_dependabot %}—for your enterprise. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /enabling-the-dependency-graph-for-your-enterprise + - /allow-github-code-quality-in-enterprise + - /configuring-code-scanning-for-your-appliance + - /configuring-dependency-review-for-your-appliance + - /configuring-secret-scanning-for-your-appliance + - /viewing-the-vulnerability-data-for-your-enterprise + - /configuring-dependabot-to-work-with-limited-internet-access + - /setting-dependabot-to-run-on-github-hosted-runners-using-vnet +--- diff --git a/content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md similarity index 97% rename from content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md index 9c2dbb3a3f68..bab707f9f6a3 100644 --- a/content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/setting-dependabot-to-run-on-github-hosted-runners-using-vnet.md @@ -2,7 +2,7 @@ title: Setting up Dependabot to run on github-hosted action runners using the Azure Private Network intro: You can configure an Azure Virtual Network (VNET) to run {% data variables.product.prodname_dependabot %} on {% data variables.product.company_short %}-hosted runners. versions: - feature: dependabot-vnet-support + feature: dependabot-vnet-support permissions: '{% data reusables.permissions.dependabot-various-tasks %}' topics: - Repositories @@ -13,6 +13,9 @@ topics: - Pull requests allowTitleToDifferFromFilename: true shortTitle: Configure VNET +redirect_from: + - /code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-github-hosted-runners-using-vnet +contentType: how-tos --- ## Configuring VNET for {% data variables.product.prodname_dependabot_updates %} diff --git a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/viewing-the-vulnerability-data-for-your-enterprise.md similarity index 77% rename from content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/viewing-the-vulnerability-data-for-your-enterprise.md index 6f0c535e0a44..66d3c1ebc200 100644 --- a/content/admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/viewing-the-vulnerability-data-for-your-enterprise.md @@ -1,17 +1,18 @@ --- title: Viewing the vulnerability data for your enterprise -intro: 'You can view vulnerability data from the {% data variables.product.prodname_advisory_database %} on {% data variables.product.prodname_ghe_server %}.' +intro: You can view vulnerability data from the {% data variables.product.prodname_advisory_database %} on {% data variables.product.prodname_ghe_server %}. shortTitle: View vulnerability data -permissions: 'Site administrators' +permissions: Site administrators versions: ghes: '*' -type: how_to topics: - Enterprise - Security - Dependency graph redirect_from: - /admin/code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise + - /admin/managing-code-security/managing-supply-chain-security-for-your-enterprise/viewing-the-vulnerability-data-for-your-enterprise +contentType: how-tos --- If {% data variables.product.prodname_dependabot_alerts %} are enabled for your enterprise, you can view all vulnerabilities that were downloaded to {% data variables.product.prodname_ghe_server %} from the {% data variables.product.prodname_advisory_database %}. diff --git a/content/admin/managing-code-security/securing-your-enterprise/applying-a-custom-security-configuration-to-your-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/applying-a-custom-security-configuration-to-your-enterprise.md similarity index 82% rename from content/admin/managing-code-security/securing-your-enterprise/applying-a-custom-security-configuration-to-your-enterprise.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/applying-a-custom-security-configuration-to-your-enterprise.md index c6ca7793cd31..f1f0fe267d08 100644 --- a/content/admin/managing-code-security/securing-your-enterprise/applying-a-custom-security-configuration-to-your-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/applying-a-custom-security-configuration-to-your-enterprise.md @@ -1,7 +1,7 @@ --- title: Applying a custom security configuration to your enterprise shortTitle: Apply custom configuration -intro: 'You can apply your {% data variables.product.prodname_custom_security_configuration %} to organizations and repositories in your organization to meet the specific security needs of your enterprise.' +intro: You can apply your {% data variables.product.prodname_custom_security_configuration %} to organizations and repositories in your organization to meet the specific security needs of your enterprise. permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}' versions: feature: security-configuration-enterprise-level @@ -9,6 +9,9 @@ topics: - Advanced Security - Organizations - Security +redirect_from: + - /admin/managing-code-security/securing-your-enterprise/applying-a-custom-security-configuration-to-your-enterprise +contentType: how-tos --- ## About applying a {% data variables.product.prodname_custom_security_configuration %} diff --git a/content/admin/managing-code-security/securing-your-enterprise/applying-the-github-recommended-security-configuration-to-your-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/applying-the-github-recommended-security-configuration-to-your-enterprise.md similarity index 90% rename from content/admin/managing-code-security/securing-your-enterprise/applying-the-github-recommended-security-configuration-to-your-enterprise.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/applying-the-github-recommended-security-configuration-to-your-enterprise.md index 1c2399e4aab4..2ae482dcaf26 100644 --- a/content/admin/managing-code-security/securing-your-enterprise/applying-the-github-recommended-security-configuration-to-your-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/applying-the-github-recommended-security-configuration-to-your-enterprise.md @@ -1,7 +1,7 @@ --- title: Applying the GitHub-recommended security configuration to your enterprise shortTitle: Apply recommended configuration -intro: 'Secure your code with the security enablement settings created, managed, and recommended by {% data variables.product.github %}.' +intro: Secure your code with the security enablement settings created, managed, and recommended by {% data variables.product.github %}. permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}' versions: ghec: '*' @@ -9,6 +9,9 @@ topics: - Advanced Security - Enterprise - Security +redirect_from: + - /admin/managing-code-security/securing-your-enterprise/applying-the-github-recommended-security-configuration-to-your-enterprise +contentType: how-tos --- ## About the {% data variables.product.prodname_github_security_configuration %} diff --git a/content/admin/managing-code-security/securing-your-enterprise/configuring-additional-secret-scanning-settings-for-your-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/configuring-additional-secret-scanning-settings-for-your-enterprise.md similarity index 92% rename from content/admin/managing-code-security/securing-your-enterprise/configuring-additional-secret-scanning-settings-for-your-enterprise.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/configuring-additional-secret-scanning-settings-for-your-enterprise.md index 407c0b391153..f60611301231 100644 --- a/content/admin/managing-code-security/securing-your-enterprise/configuring-additional-secret-scanning-settings-for-your-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/configuring-additional-secret-scanning-settings-for-your-enterprise.md @@ -1,7 +1,7 @@ --- title: Configuring additional secret scanning settings for your enterprise shortTitle: Configure additional settings -intro: 'Learn how to configure additional {% data variables.product.prodname_secret_scanning %} settings for your enterprise.' +intro: Learn how to configure additional {% data variables.product.prodname_secret_scanning %} settings for your enterprise. permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}' versions: feature: security-configuration-enterprise-level @@ -9,6 +9,9 @@ topics: - Advanced Security - Enterprise - Security +redirect_from: + - /admin/managing-code-security/securing-your-enterprise/configuring-additional-secret-scanning-settings-for-your-enterprise +contentType: how-tos --- ## About additional settings for {% data variables.product.prodname_secret_scanning %} diff --git a/content/admin/managing-code-security/securing-your-enterprise/creating-a-custom-security-configuration-for-your-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/creating-a-custom-security-configuration-for-your-enterprise.md similarity index 98% rename from content/admin/managing-code-security/securing-your-enterprise/creating-a-custom-security-configuration-for-your-enterprise.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/creating-a-custom-security-configuration-for-your-enterprise.md index 340339e3dea0..8a681b3c1397 100644 --- a/content/admin/managing-code-security/securing-your-enterprise/creating-a-custom-security-configuration-for-your-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/creating-a-custom-security-configuration-for-your-enterprise.md @@ -1,7 +1,7 @@ --- title: Creating a custom security configuration for your enterprise shortTitle: Create custom configuration -intro: 'Build a {% data variables.product.prodname_custom_security_configuration %} to meet the specific security needs of your enterprise.' +intro: Build a {% data variables.product.prodname_custom_security_configuration %} to meet the specific security needs of your enterprise. permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}' versions: feature: security-configuration-enterprise-level @@ -9,6 +9,9 @@ topics: - Advanced Security - Enterprise - Security +redirect_from: + - /admin/managing-code-security/securing-your-enterprise/creating-a-custom-security-configuration-for-your-enterprise +contentType: how-tos --- ## About {% data variables.product.prodname_custom_security_configurations %} diff --git a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-github-advanced-security-for-your-enterprise.md similarity index 93% rename from content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-github-advanced-security-for-your-enterprise.md index db77274060f7..bac038aabcf1 100644 --- a/content/admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-github-advanced-security-for-your-enterprise.md @@ -1,21 +1,22 @@ --- title: Enabling {% data variables.product.prodname_GHAS %} {% ifversion ghas-products %}products {% endif %}for your enterprise -shortTitle: Enabling {% data variables.product.prodname_GHAS %} -intro: 'You can configure {% data variables.product.prodname_ghe_server %} to include {% data variables.product.prodname_GHAS %}{% ifversion ghas-products %} products{% endif %}. This provides extra features that help users find and fix security problems in their code.' +shortTitle: Enable {% data variables.product.prodname_GHAS %} +intro: You can configure {% data variables.product.prodname_ghe_server %} to include {% data variables.product.prodname_GHAS %}{% ifversion ghas-products %} products{% endif %}. This provides extra features that help users find and fix security problems in their code. product: '{% data reusables.gated-features.ghas-ghec %}' allowTitleToDifferFromFilename: true redirect_from: - /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise - /admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise + - /admin/managing-code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise versions: ghes: '*' -type: how_to topics: - Advanced Security - Code scanning - Enterprise - Secret scanning - Security +contentType: how-tos --- ## About enabling {% data variables.product.prodname_GHAS %}{% ifversion ghas-products %} products{% endif %} diff --git a/content/code-security/security-overview/enabling-security-features-for-multiple-repositories.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-security-features-for-multiple-repositories.md similarity index 97% rename from content/code-security/security-overview/enabling-security-features-for-multiple-repositories.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-security-features-for-multiple-repositories.md index 64fb270fcce4..e9b336e12664 100644 --- a/content/code-security/security-overview/enabling-security-features-for-multiple-repositories.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/enabling-security-features-for-multiple-repositories.md @@ -5,8 +5,7 @@ intro: You can use security overview to select a subset of repositories and enab permissions: '{% data reusables.permissions.security-org-enable %}' allowTitleToDifferFromFilename: true versions: - feature: security-configurations-beta-and-pre-beta # Display article for old GHES versions only -type: how_to + feature: security-configurations-beta-and-pre-beta topics: - Security overview - Code Security @@ -14,6 +13,9 @@ topics: - Alerts - Organizations - Teams +redirect_from: + - /code-security/security-overview/enabling-security-features-for-multiple-repositories +contentType: how-tos --- ## About enabling security features diff --git a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/index.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/index.md new file mode 100644 index 000000000000..59c6b066b576 --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/index.md @@ -0,0 +1,16 @@ +--- +title: Establish complete coverage +intro: Learn how to establish comprehensive, enterprise-wide security coverage by enabling {% data variables.product.prodname_GHAS %}, applying recommended or custom security configurations, and configuring additional secret scanning settings across your enterprise. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /enabling-security-features-for-multiple-repositories + - /enabling-github-advanced-security-for-your-enterprise + - /applying-the-github-recommended-security-configuration-to-your-enterprise + - /creating-a-custom-security-configuration-for-your-enterprise + - /applying-a-custom-security-configuration-to-your-enterprise + - /configuring-additional-secret-scanning-settings-for-your-enterprise +--- diff --git a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/index.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/index.md new file mode 100644 index 000000000000..6021cbf9e07e --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/index.md @@ -0,0 +1,13 @@ +--- +title: Configure enterprise security +intro: Configure and standardize security features across your enterprise, including establishing coverage, managing settings, and enabling approved tools at scale. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /establish-complete-coverage + - /manage-your-coverage + - /configure-specific-tools +--- diff --git a/content/admin/managing-code-security/securing-your-enterprise/deleting-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/deleting-a-custom-security-configuration.md similarity index 89% rename from content/admin/managing-code-security/securing-your-enterprise/deleting-a-custom-security-configuration.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/deleting-a-custom-security-configuration.md index 061e9ce6fd27..995c3f01501e 100644 --- a/content/admin/managing-code-security/securing-your-enterprise/deleting-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/deleting-a-custom-security-configuration.md @@ -1,7 +1,7 @@ --- title: Deleting a custom security configuration shortTitle: Delete custom configuration -intro: 'You can delete unnecessary {% data variables.product.prodname_custom_security_configurations %} in your enterprise.' +intro: You can delete unnecessary {% data variables.product.prodname_custom_security_configurations %} in your enterprise. permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}' versions: feature: security-configuration-enterprise-level @@ -9,6 +9,9 @@ topics: - Advanced Security - Enterprise - Security +redirect_from: + - /admin/managing-code-security/securing-your-enterprise/deleting-a-custom-security-configuration +contentType: how-tos --- ## About deleting a {% data variables.product.prodname_custom_security_configuration %} diff --git a/content/admin/managing-code-security/securing-your-enterprise/editing-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/editing-a-custom-security-configuration.md similarity index 88% rename from content/admin/managing-code-security/securing-your-enterprise/editing-a-custom-security-configuration.md rename to content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/editing-a-custom-security-configuration.md index 4b2f03dea2c8..38526997912c 100644 --- a/content/admin/managing-code-security/securing-your-enterprise/editing-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/editing-a-custom-security-configuration.md @@ -1,7 +1,7 @@ --- title: Editing a custom security configuration shortTitle: Edit custom configuration -intro: 'Change the enablement settings in your {% data variables.product.prodname_custom_security_configuration %} to better meet the security needs of your repositories.' +intro: Change the enablement settings in your {% data variables.product.prodname_custom_security_configuration %} to better meet the security needs of your repositories. permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}' versions: feature: security-configuration-enterprise-level @@ -9,6 +9,9 @@ topics: - Advanced Security - Organizations - Security +redirect_from: + - /admin/managing-code-security/securing-your-enterprise/editing-a-custom-security-configuration +contentType: how-tos --- ## About editing a {% data variables.product.prodname_custom_security_configuration %} diff --git a/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/index.md b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/index.md new file mode 100644 index 000000000000..cacb8f94f2f5 --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/index.md @@ -0,0 +1,12 @@ +--- +title: Manage your coverage +intro: Review and manage your enterprise’s repository security coverage by adjusting which repositories are included in your custom security configurations and removing unneeded configurations. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /editing-a-custom-security-configuration + - /deleting-a-custom-security-configuration +--- diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-secret-risk.md similarity index 75% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-secret-risk.md index d0ee40ead034..73fbe01060be 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-secret-risk.md @@ -1,10 +1,9 @@ --- -title: 'Running the secret risk assessment for your organization' -shortTitle: 'Assess your secret risk' -intro: 'Determine your organization''s exposure to leaked secrets by generating a {% data variables.product.prodname_secret_risk_assessment %} report.' +title: Running the secret risk assessment for your organization +shortTitle: Assess your secret risk +intro: Determine your organization's exposure to leaked secrets by generating a {% data variables.product.prodname_secret_risk_assessment %} report. product: '{% data reusables.gated-features.secret-risk-assessment-report %}' permissions: '{% data reusables.permissions.secret-risk-assessment-report-generation %}' -type: how_to versions: feature: secret-risk-assessment topics: @@ -13,6 +12,10 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets +contentType: how-tos --- ## Generating an initial {% data variables.product.prodname_secret_risk_assessment %} diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/calculating-the-cost-savings-of-push-protection.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/calculating-the-cost-savings-of-push-protection.md similarity index 97% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/calculating-the-cost-savings-of-push-protection.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/calculating-the-cost-savings-of-push-protection.md index 18309da30280..d60f21e6af83 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/calculating-the-cost-savings-of-push-protection.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/calculating-the-cost-savings-of-push-protection.md @@ -10,6 +10,8 @@ topics: - Secret scanning - Secret Protection contentType: how-tos +redirect_from: + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/calculating-the-cost-savings-of-push-protection --- ## What is the cost savings calculator? diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md similarity index 92% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md index 34ad2b335d73..b60b8af759d7 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale.md @@ -1,20 +1,21 @@ --- title: Configuring advanced setup for code scanning with CodeQL at scale shortTitle: CodeQL advanced setup at scale -intro: 'You can use a script to configure advanced setup for {% data variables.product.prodname_code_scanning %} for a specific group of repositories in your organization.' +intro: You can use a script to configure advanced setup for {% data variables.product.prodname_code_scanning %} for a specific group of repositories in your organization. permissions: '{% data reusables.permissions.security-org-enable %}' product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning-with-codeql-at-scale versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Code Security - Code scanning allowTitleToDifferFromFilename: true +contentType: how-tos --- ## About enabling advanced setup for {% data variables.product.prodname_code_scanning %} with {% data variables.product.prodname_codeql %} at scale diff --git a/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-default-setup-for-code-scanning-at-scale.md similarity index 98% rename from content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-default-setup-for-code-scanning-at-scale.md index 7c1920ac623a..3dd099397d5b 100644 --- a/content/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-default-setup-for-code-scanning-at-scale.md @@ -1,13 +1,13 @@ --- title: Configuring default setup for code scanning at scale shortTitle: Code scanning at scale -intro: 'You can quickly configure {% data variables.product.prodname_code_scanning %} for repositories across your organization using default setup.' +intro: You can quickly configure {% data variables.product.prodname_code_scanning %} for repositories across your organization using default setup. redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-at-scale - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-default-setup-for-code-scanning-at-scale + - /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning-at-scale permissions: '{% data reusables.permissions.security-org-enable %}' product: '{% data reusables.gated-features.code-scanning %}' -type: how_to topics: - Code Security - Code scanning @@ -15,6 +15,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' +contentType: how-tos --- ## About configuring default setup at scale diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-private-vulnerability-reporting-for-an-organization.md similarity index 94% rename from content/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-private-vulnerability-reporting-for-an-organization.md index 7d46e8fb726c..33a0778bc7bb 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-private-vulnerability-reporting-for-an-organization.md @@ -5,13 +5,14 @@ permissions: '{% data reusables.permissions.security-org-enable %}' versions: fpt: '*' ghec: '*' -type: how_to topics: - Security advisories - Vulnerabilities shortTitle: Configure for an organization redirect_from: - /code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization + - /code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization +contentType: how-tos --- ## About privately reporting a security vulnerability diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/enforcing-dependency-review-across-an-organization.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/enforcing-dependency-review-across-an-organization.md similarity index 89% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/enforcing-dependency-review-across-an-organization.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/enforcing-dependency-review-across-an-organization.md index 638c9b14a11c..5e2298a866ff 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/enforcing-dependency-review-across-an-organization.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/enforcing-dependency-review-across-an-organization.md @@ -1,19 +1,21 @@ --- title: Enforcing dependency review across an organization -intro: 'Dependency review lets you catch insecure dependencies before you introduce them to your environment. You can enforce the use of the {% data variables.dependency-review.action_name %} across your organization.' +intro: Dependency review lets you catch insecure dependencies before you introduce them to your environment. You can enforce the use of the {% data variables.dependency-review.action_name %} across your organization. shortTitle: Enforce dependency review permissions: '{% data reusables.permissions.security-org-enable %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Code Security - Dependency review - Vulnerabilities - Dependencies - Pull requests +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/enforcing-dependency-review-across-an-organization +contentType: how-tos --- ## About dependency review enforcement diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/estimating-the-price-of-secret-protection.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/estimating-the-price-of-secret-protection.md similarity index 95% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/estimating-the-price-of-secret-protection.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/estimating-the-price-of-secret-protection.md index 06a378ad3d62..3541e70c3b59 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/estimating-the-price-of-secret-protection.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/estimating-the-price-of-secret-protection.md @@ -10,6 +10,8 @@ topics: - Secret scanning - Secret Protection contentType: how-tos +redirect_from: + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/estimating-the-price-of-secret-protection --- ## What is the pricing calculator? diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/index.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/index.md new file mode 100644 index 000000000000..43c2335884c4 --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/index.md @@ -0,0 +1,19 @@ +--- +title: Configure specific tools +intro: Configure individual code security tools across your organization to assess risk, enable protections, and manage scanning and dependency features at scale. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /assess-your-secret-risk + - /viewing-the-secret-risk-assessment-report-for-your-organization + - /estimating-the-price-of-secret-protection + - /calculating-the-cost-savings-of-push-protection + - /protect-your-secrets + - /configuring-default-setup-for-code-scanning-at-scale + - /configuring-advanced-setup-for-code-scanning-with-codeql-at-scale + - /enforcing-dependency-review-across-an-organization + - /configuring-private-vulnerability-reporting-for-an-organization +--- diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/protect-your-secrets.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md similarity index 84% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/protect-your-secrets.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md index 8eb8f5f4f4b6..7f4c96c6acdc 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/protect-your-secrets.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets.md @@ -1,14 +1,15 @@ --- title: Pricing and enabling {% data variables.product.prodname_GH_secret_protection %} -shortTitle: 'Protect your secrets' -intro: 'Secure your organization''s secrets within your budget by enabling {% data variables.product.prodname_GH_secret_protection %}.' -product: 'Organizations on {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %}' +shortTitle: Protect your secrets +intro: Secure your organization's secrets within your budget by enabling {% data variables.product.prodname_GH_secret_protection %}. +product: Organizations on {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} allowTitleToDifferFromFilename: true contentType: how-tos versions: feature: secret-risk-assessment redirect_from: - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/choosing-github-secret-protection + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/protect-your-secrets topics: - Secret scanning - Secret Protection diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/viewing-the-secret-risk-assessment-report-for-your-organization.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/viewing-the-secret-risk-assessment-report-for-your-organization.md similarity index 54% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/viewing-the-secret-risk-assessment-report-for-your-organization.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/viewing-the-secret-risk-assessment-report-for-your-organization.md index 71ce15a8b456..11f1847d72ea 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/viewing-the-secret-risk-assessment-report-for-your-organization.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/viewing-the-secret-risk-assessment-report-for-your-organization.md @@ -1,11 +1,10 @@ --- -title: 'Viewing the secret risk assessment report for your organization' -shortTitle: 'View risk report' -intro: 'Understand your organization''s exposure to leaked secrets at a glance by viewing your most recent {% data variables.product.prodname_secret_risk_assessment %} report.' +title: Viewing the secret risk assessment report for your organization +shortTitle: View risk report +intro: Understand your organization's exposure to leaked secrets at a glance by viewing your most recent {% data variables.product.prodname_secret_risk_assessment %} report. product: '{% data reusables.gated-features.secret-risk-assessment-report %}' permissions: '{% data reusables.permissions.secret-risk-assessment-report-generation %}' allowTitleToDifferFromFilename: true -type: how_to versions: feature: secret-risk-assessment topics: @@ -14,6 +13,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/viewing-the-secret-risk-assessment-report-for-your-organization +contentType: how-tos --- {% data reusables.organizations.navigate-to-org %} diff --git a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md similarity index 89% rename from content/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-a-custom-security-configuration.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md index 7b0a501c9765..c20779d4fe1a 100644 --- a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-a-custom-security-configuration.md @@ -1,7 +1,7 @@ --- title: Applying a custom security configuration shortTitle: Apply custom configuration -intro: 'You can apply your {% data variables.product.prodname_custom_security_configuration %} to repositories in your organization to meet the specific security needs of those repositories.' +intro: You can apply your {% data variables.product.prodname_custom_security_configuration %} to repositories in your organization to meet the specific security needs of those repositories. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -12,6 +12,8 @@ topics: - Security redirect_from: - /code-security/securing-your-organization/meeting-your-specific-security-needs-with-custom-security-configurations/applying-a-custom-security-configuration + - /code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-a-custom-security-configuration +contentType: how-tos --- ## About applying a {% data variables.product.prodname_custom_security_configuration %} diff --git a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-the-github-recommended-security-configuration-in-your-organization.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-the-github-recommended-security-configuration-in-your-organization.md similarity index 92% rename from content/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-the-github-recommended-security-configuration-in-your-organization.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-the-github-recommended-security-configuration-in-your-organization.md index ddf0d502ed6b..aee87cb7ac52 100644 --- a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-the-github-recommended-security-configuration-in-your-organization.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-the-github-recommended-security-configuration-in-your-organization.md @@ -1,7 +1,7 @@ --- title: Applying the GitHub-recommended security configuration in your organization shortTitle: Apply recommended configuration -intro: 'Secure your code with the security enablement settings created, managed, and recommended by {% data variables.product.company_short %}.' +intro: Secure your code with the security enablement settings created, managed, and recommended by {% data variables.product.company_short %}. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations-cloud @@ -10,6 +10,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/enabling-security-features-in-your-organization/applying-the-github-recommended-security-configuration-in-your-organization +contentType: how-tos --- ## About the {% data variables.product.prodname_github_security_configuration %} diff --git a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization.md similarity index 92% rename from content/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization.md index 3cacb400ffb4..627f974cde4a 100644 --- a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization.md @@ -1,7 +1,7 @@ --- title: Configuring global security settings for your organization shortTitle: Configure global settings -intro: 'Customize {% data variables.product.prodname_AS %} features to strengthen the security of your organization.' +intro: Customize {% data variables.product.prodname_AS %} features to strengthen the security of your organization. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -10,6 +10,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/enabling-security-features-in-your-organization/configuring-global-security-settings-for-your-organization +contentType: how-tos --- ## About {% data variables.product.prodname_global_settings %} @@ -107,7 +110,8 @@ You can recommend that repositories in your organization use the "Extended" quer You can customize several {% data variables.product.prodname_global_settings %} for {% data variables.product.prodname_code_scanning %}: {% ifversion code-scanning-autofix %}* [Enabling {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_codeql %}](#enabling-copilot-autofix-for-codeql){% endif %} -* [Recommending the extended query suite for default setup](#recommending-the-extended-query-suite-for-default-setup){% ifversion ghes < 3.17 %} +* [Recommending the extended query suite for default setup](#recommending-the-extended-query-suite-for-default-setup) +* [Expanding {% data variables.product.prodname_codeql %} analysis](#expanding-codeql-analysis){% ifversion ghes < 3.17 %} * [Setting a failure threshold for {% data variables.product.prodname_code_scanning %} checks in pull requests](#setting-a-failure-threshold-for-code-scanning-checks-in-pull-requests).{% endif %} {% endif %} @@ -124,6 +128,10 @@ You can select **{% data variables.copilot.copilot_autofix_short %}** to enable {% endif %} +### Expanding {% data variables.product.prodname_codeql %} analysis + +You can expand {% data variables.product.prodname_codeql %} analysis coverage for all repositories in your organization that use default setup by configuring {% data variables.product.prodname_codeql %} model packs. Model packs extend the {% data variables.product.prodname_codeql %} analysis to recognize additional frameworks and libraries that are not included in the standard {% data variables.product.prodname_codeql %} libraries. This global configuration applies to repositories using default setup and allows you to specify model packs published via the container registry. For more information, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/editing-your-configuration-of-default-setup#extending-coverage-for-all-repositories-in-an-organization). + {% ifversion ghes < 3.17 %} ### Setting a failure threshold for {% data variables.product.prodname_code_scanning %} checks in pull requests diff --git a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/creating-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration.md similarity index 98% rename from content/code-security/securing-your-organization/enabling-security-features-in-your-organization/creating-a-custom-security-configuration.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration.md index b1d7ced98535..863851a1e187 100644 --- a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/creating-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration.md @@ -1,7 +1,7 @@ --- title: Creating a custom security configuration shortTitle: Create custom configuration -intro: 'Build a {% data variables.product.prodname_custom_security_configuration %} to meet the specific security needs of repositories in your organization.' +intro: Build a {% data variables.product.prodname_custom_security_configuration %} to meet the specific security needs of repositories in your organization. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -12,6 +12,8 @@ topics: - Security redirect_from: - /code-security/securing-your-organization/meeting-your-specific-security-needs-with-custom-security-configurations/creating-a-custom-security-configuration + - /code-security/securing-your-organization/enabling-security-features-in-your-organization/creating-a-custom-security-configuration +contentType: how-tos --- ## About {% data variables.product.prodname_custom_security_configurations %} diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/index.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/index.md new file mode 100644 index 000000000000..012a36ec3a09 --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/index.md @@ -0,0 +1,14 @@ +--- +title: Establish complete coverage +intro: Ensure all repositories in your organization are covered by security protections by applying recommended or custom configurations and managing global security settings. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /applying-the-github-recommended-security-configuration-in-your-organization + - /creating-a-custom-security-configuration + - /applying-a-custom-security-configuration + - /configuring-global-security-settings-for-your-organization +--- diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/index.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/index.md new file mode 100644 index 000000000000..03876fdc5f1e --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/index.md @@ -0,0 +1,18 @@ +--- +title: Configure organization security +intro: Configure security across your organization by establishing coverage, managing settings, and controlling access to code security tools at scale. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /establish-complete-coverage + - /manage-your-coverage + - /configure-specific-tools + - /manage-usage-and-access +redirect_from: + - /code-security/securing-your-organization/enabling-security-features-in-your-organization + - /code-security/securing-your-organization/meeting-your-specific-security-needs-with-custom-security-configurations + - /code-security/securing-your-organization +--- diff --git a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/giving-org-access-private-registries.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/giving-org-access-private-registries.md similarity index 94% rename from content/code-security/securing-your-organization/enabling-security-features-in-your-organization/giving-org-access-private-registries.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/giving-org-access-private-registries.md index e08582aa32f8..1057da0e07f6 100644 --- a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/giving-org-access-private-registries.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/giving-org-access-private-registries.md @@ -1,7 +1,7 @@ --- title: Giving security features access to private registries shortTitle: Give access to private registries -intro: 'If your organization uses private registries, you can improve the results of {% data variables.product.prodname_code_scanning %} analysis and enable {% data variables.product.prodname_dependabot %} to maintain more dependencies by setting up access to these registries.' +intro: If your organization uses private registries, you can improve the results of {% data variables.product.prodname_code_scanning %} analysis and enable {% data variables.product.prodname_dependabot %} to maintain more dependencies by setting up access to these registries. allowTitleToDifferFromFilename: true versions: feature: org-private-registry @@ -9,6 +9,9 @@ topics: - Code Security - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/enabling-security-features-in-your-organization/giving-org-access-private-registries +contentType: how-tos --- ## About the importance of providing access to private registries diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/index.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/index.md new file mode 100644 index 000000000000..cb5e969deae0 --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/index.md @@ -0,0 +1,12 @@ +--- +title: Manage usage and access +intro: Control access to code security features and monitor usage across your organization, including access to private registries and {% data variables.product.prodname_AS %} license consumption. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /giving-org-access-private-registries + - /managing-your-github-advanced-security-license-usage +--- diff --git a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/managing-your-github-advanced-security-license-usage.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md similarity index 94% rename from content/code-security/securing-your-organization/managing-the-security-of-your-organization/managing-your-github-advanced-security-license-usage.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md index 86df6296196c..9f798da31ed1 100644 --- a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/managing-your-github-advanced-security-license-usage.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-usage-and-access/managing-your-github-advanced-security-license-usage.md @@ -1,7 +1,7 @@ --- title: Managing your paid use of {% data variables.product.prodname_AS %} shortTitle: Manage paid GHAS use -intro: 'You can understand and control the costs of using {% data variables.product.prodname_GH_cs_and_sp %} in repositories in your organization.' +intro: You can understand and control the costs of using {% data variables.product.prodname_GH_cs_and_sp %} in repositories in your organization. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.security-org-enable %}' product: '{% data reusables.gated-features.ghas-billing %}' @@ -12,6 +12,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/managing-the-security-of-your-organization/managing-your-github-advanced-security-license-usage +contentType: how-tos --- ## Requirements for enabling {% data variables.product.prodname_AS %} products diff --git a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/deleting-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/deleting-a-custom-security-configuration.md similarity index 87% rename from content/code-security/securing-your-organization/managing-the-security-of-your-organization/deleting-a-custom-security-configuration.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/deleting-a-custom-security-configuration.md index bf8834e753c0..9cc5f36a12e1 100644 --- a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/deleting-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/deleting-a-custom-security-configuration.md @@ -1,7 +1,7 @@ --- title: Deleting a custom security configuration shortTitle: Delete custom configuration -intro: 'You can delete unnecessary {% data variables.product.prodname_custom_security_configurations %} in your organization.' +intro: You can delete unnecessary {% data variables.product.prodname_custom_security_configurations %} in your organization. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -10,6 +10,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/managing-the-security-of-your-organization/deleting-a-custom-security-configuration +contentType: how-tos --- ## About deleting a {% data variables.product.prodname_custom_security_configuration %} diff --git a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/detaching-repositories-from-their-security-configurations.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md similarity index 87% rename from content/code-security/securing-your-organization/managing-the-security-of-your-organization/detaching-repositories-from-their-security-configurations.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md index f536a27c732c..fc736b753276 100644 --- a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/detaching-repositories-from-their-security-configurations.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/detaching-repositories-from-their-security-configurations.md @@ -1,7 +1,7 @@ --- title: Detaching repositories from their security configurations shortTitle: Detach security configuration -intro: 'You can unlink repositories from their {% data variables.product.prodname_security_configurations %} and instead manage their security enablement settings at the repository level.' +intro: You can unlink repositories from their {% data variables.product.prodname_security_configurations %} and instead manage their security enablement settings at the repository level. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -10,6 +10,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/managing-the-security-of-your-organization/detaching-repositories-from-their-security-configurations +contentType: how-tos --- ## About detaching repositories from their {% data variables.product.prodname_security_configurations %} diff --git a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/editing-a-custom-security-configuration.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/editing-a-custom-security-configuration.md similarity index 89% rename from content/code-security/securing-your-organization/managing-the-security-of-your-organization/editing-a-custom-security-configuration.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/editing-a-custom-security-configuration.md index 2d5a1adaf201..05fb8fea12fc 100644 --- a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/editing-a-custom-security-configuration.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/editing-a-custom-security-configuration.md @@ -1,7 +1,7 @@ --- title: Editing a custom security configuration shortTitle: Edit custom configuration -intro: 'Change the enablement settings in your {% data variables.product.prodname_custom_security_configuration %} to better meet the security needs of your repositories.' +intro: Change the enablement settings in your {% data variables.product.prodname_custom_security_configuration %} to better meet the security needs of your repositories. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -10,6 +10,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/managing-the-security-of-your-organization/editing-a-custom-security-configuration +contentType: how-tos --- ## About editing a {% data variables.product.prodname_custom_security_configuration %} diff --git a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/filtering-repositories-in-your-organization-using-the-repository-table.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md similarity index 87% rename from content/code-security/securing-your-organization/managing-the-security-of-your-organization/filtering-repositories-in-your-organization-using-the-repository-table.md rename to content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md index 395411669540..1b8d2899c7f1 100644 --- a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/filtering-repositories-in-your-organization-using-the-repository-table.md +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/filtering-repositories-in-your-organization-using-the-repository-table.md @@ -1,7 +1,7 @@ --- title: Filtering repositories in your organization using the repository table shortTitle: Filter repositories -intro: 'You can filter the repository table for your organization to better manage the security settings of specific repositories.' +intro: You can filter the repository table for your organization to better manage the security settings of specific repositories. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -10,6 +10,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/managing-the-security-of-your-organization/filtering-repositories-in-your-organization-using-the-repository-table +contentType: how-tos --- ## About filtering repositories in your organization diff --git a/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/index.md b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/index.md new file mode 100644 index 000000000000..b2e2925ab35d --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/configure-organization-security/manage-your-coverage/index.md @@ -0,0 +1,14 @@ +--- +title: Manage your coverage +intro: Review and adjust your organization’s security coverage by managing which repositories are included in security configurations and updating or removing configurations as needed. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /editing-a-custom-security-configuration + - /filtering-repositories-in-your-organization-using-the-repository-table + - /detaching-repositories-from-their-security-configurations + - /deleting-a-custom-security-configuration +--- diff --git a/content/code-security/how-tos/secure-at-scale/index.md b/content/code-security/how-tos/secure-at-scale/index.md new file mode 100644 index 000000000000..fe26bd501157 --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/index.md @@ -0,0 +1,21 @@ +--- +title: Secure at scale +intro: Secure your codebase at scale by configuring security at the enterprise and organization levels and troubleshooting security configurations as needed. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: how-tos +children: + - /configure-enterprise-security + - /configure-organization-security + - /troubleshoot-security-configurations +--- diff --git a/content/code-security/securing-your-organization/troubleshooting-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md similarity index 90% rename from content/code-security/securing-your-organization/troubleshooting-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md rename to content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md index 1a8117262ac0..5435ac149fd4 100644 --- a/content/code-security/securing-your-organization/troubleshooting-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md +++ b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md @@ -1,16 +1,18 @@ --- title: A repository is using advanced setup for code scanning shortTitle: Active advanced setup -intro: 'You see an error when you try to attach a {% data variables.product.prodname_security_configuration %} with default code scanning enabled to repositories that use advanced setup for code scanning.' +intro: You see an error when you try to attach a {% data variables.product.prodname_security_configuration %} with default code scanning enabled to repositories that use advanced setup for code scanning. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations redirect_from: - /code-security/securing-your-organization/troubleshooting-security-configurations/a-repository-has-an-existing-advanced-setup-for-code-scanning + - /code-security/securing-your-organization/troubleshooting-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning topics: - Code Security - Organizations - Security +contentType: how-tos --- ## About the problem diff --git a/content/code-security/securing-your-organization/troubleshooting-security-configurations/feature-disappears.md b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/feature-disappears.md similarity index 88% rename from content/code-security/securing-your-organization/troubleshooting-security-configurations/feature-disappears.md rename to content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/feature-disappears.md index d4ef187f419b..e830534b9072 100644 --- a/content/code-security/securing-your-organization/troubleshooting-security-configurations/feature-disappears.md +++ b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/feature-disappears.md @@ -2,7 +2,7 @@ title: A feature has disappeared from a security configuration shortTitle: Feature disappears allowTitleToDifferFromFilename: true -intro: 'Changes to your {% data variables.product.prodname_ghe_server %} instance''s installation settings by a site administrator may affect which security features are available to your configuration.' +intro: Changes to your {% data variables.product.prodname_ghe_server %} instance's installation settings by a site administrator may affect which security features are available to your configuration. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations-ghes-only @@ -11,6 +11,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/troubleshooting-security-configurations/feature-disappears +contentType: how-tos --- ## About the problem diff --git a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/finding-repositories-with-attachment-failures.md b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md similarity index 87% rename from content/code-security/securing-your-organization/managing-the-security-of-your-organization/finding-repositories-with-attachment-failures.md rename to content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md index ec8347fdfc29..39d60f155f6d 100644 --- a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/finding-repositories-with-attachment-failures.md +++ b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures.md @@ -2,7 +2,7 @@ title: Finding and fixing configuration attachment failures shortTitle: Find attachment failures allowTitleToDifferFromFilename: true -intro: 'You can identify any repositories where the security configuration could not be attached, and follow guidance to remediate the problem.' +intro: You can identify any repositories where the security configuration could not be attached, and follow guidance to remediate the problem. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -11,6 +11,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/managing-the-security-of-your-organization/finding-repositories-with-attachment-failures +contentType: how-tos --- ## Finding and remediating attachment failures diff --git a/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/index.md b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/index.md new file mode 100644 index 000000000000..aaf2d7df46b5 --- /dev/null +++ b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/index.md @@ -0,0 +1,17 @@ +--- +title: Troubleshoot security configurations +intro: Identify and resolve issues with your security configurations by diagnosing common problems related to setup, coverage, and license availability. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /a-repository-is-using-advanced-setup-for-code-scanning + - /feature-disappears + - /unexpected-default-setup + - /finding-repositories-with-attachment-failures + - /not-enough-github-advanced-security-licenses +redirect_from: + - /code-security/securing-your-organization/troubleshooting-security-configurations +--- diff --git a/content/code-security/securing-your-organization/troubleshooting-security-configurations/not-enough-github-advanced-security-licenses.md b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md similarity index 84% rename from content/code-security/securing-your-organization/troubleshooting-security-configurations/not-enough-github-advanced-security-licenses.md rename to content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md index 4991d85c1b1f..cc7b141f360d 100644 --- a/content/code-security/securing-your-organization/troubleshooting-security-configurations/not-enough-github-advanced-security-licenses.md +++ b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md @@ -1,7 +1,7 @@ --- title: Not enough GitHub Advanced Security licenses shortTitle: Not enough GHAS licenses -intro: 'If you are on a subscription-based billing model for GHAS, you need available GHAS licenses to enable GHAS features on a private{% ifversion ghec or ghes %} or internal{% endif %} repository.' +intro: If you are on a subscription-based billing model for GHAS, you need available GHAS licenses to enable GHAS features on a private{% ifversion ghec or ghes %} or internal{% endif %} repository. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -10,6 +10,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/troubleshooting-security-configurations/not-enough-github-advanced-security-licenses +contentType: how-tos --- If you are on a volume / subscription-based billing model for {% data variables.product.prodname_GHAS %} (GHAS), you must have an available GHAS license for any additional unique active committers to enable GHAS features on a private{% ifversion ghec or ghes %} or internal{% endif %} repository. To learn about GHAS licensing, as well as unique and active committers, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security). diff --git a/content/code-security/securing-your-organization/troubleshooting-security-configurations/unexpected-default-setup.md b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/unexpected-default-setup.md similarity index 79% rename from content/code-security/securing-your-organization/troubleshooting-security-configurations/unexpected-default-setup.md rename to content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/unexpected-default-setup.md index 27a22e4c501d..99390fa96e36 100644 --- a/content/code-security/securing-your-organization/troubleshooting-security-configurations/unexpected-default-setup.md +++ b/content/code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/unexpected-default-setup.md @@ -1,7 +1,7 @@ --- title: Default setup for code scanning overrides advanced setup shortTitle: Unexpected default setup -intro: 'You apply a {% data variables.product.prodname_security_configuration %} with "Enabled with advanced setup allowed" and the existing advanced setup for {% data variables.product.prodname_code_scanning %} is ignored in some repositories.' +intro: You apply a {% data variables.product.prodname_security_configuration %} with "Enabled with advanced setup allowed" and the existing advanced setup for {% data variables.product.prodname_code_scanning %} is ignored in some repositories. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -9,6 +9,9 @@ topics: - Code Security - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/troubleshooting-security-configurations/unexpected-default-setup +contentType: how-tos --- ## About the problem diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/defining-custom-patterns-for-secret-scanning.md similarity index 96% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md rename to content/code-security/how-tos/secure-your-secrets/customize-leak-detection/defining-custom-patterns-for-secret-scanning.md index a611622acb49..256b26b46da5 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning.md +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/defining-custom-patterns-for-secret-scanning.md @@ -1,17 +1,19 @@ --- title: Defining custom patterns for secret scanning shortTitle: Define custom patterns -intro: 'You can define your own custom patterns to extend the capabilities of {% data variables.product.prodname_secret_scanning %} by generating one or more regular expressions.' +intro: You can define your own custom patterns to extend the capabilities of {% data variables.product.prodname_secret_scanning %} by generating one or more regular expressions. product: '{% data reusables.gated-features.secret-scanning-custom-patterns %}' permissions: '{% data reusables.permissions.security-enterprise-enable %}' redirect_from: - /code-security/secret-security/defining-custom-patterns-for-secret-scanning - /code-security/secret-scanning/defining-custom-patterns-for-secret-scanning + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret Protection - Secret scanning diff --git a/content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-extended-metadata-checks-for-your-repository.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/enabling-extended-metadata-checks-for-your-repository.md similarity index 85% rename from content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-extended-metadata-checks-for-your-repository.md rename to content/code-security/how-tos/secure-your-secrets/customize-leak-detection/enabling-extended-metadata-checks-for-your-repository.md index 13b83fb69db6..f7d9cb49d040 100644 --- a/content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-extended-metadata-checks-for-your-repository.md +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/enabling-extended-metadata-checks-for-your-repository.md @@ -1,17 +1,18 @@ --- title: Enabling extended metadata checks for your repository shortTitle: Enable metadata checks -intro: 'Learn how to enable extended metadata checks for detected secrets so alerts detected by {% data variables.product.prodname_secret_scanning %} include additional information that help you assess and remediate leaks faster.' +intro: Learn how to enable extended metadata checks for detected secrets so alerts detected by {% data variables.product.prodname_secret_scanning %} include additional information that help you assess and remediate leaks faster. product: '{% data reusables.gated-features.metadata-checks-ghas %}' permissions: '{% data reusables.permissions.push-protection %}' versions: feature: secret-scanning-extended-metadata-checks -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts -contentType: how-tos +redirect_from: + - /code-security/secret-scanning/enabling-secret-scanning-features/enabling-extended-metadata-checks-for-your-repository --- {% data reusables.secret-scanning.metadata-checks-public-preview %} diff --git a/content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-validity-checks-for-your-repository.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/enabling-validity-checks-for-your-repository.md similarity index 91% rename from content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-validity-checks-for-your-repository.md rename to content/code-security/how-tos/secure-your-secrets/customize-leak-detection/enabling-validity-checks-for-your-repository.md index f1efd8e0ef27..06662990997f 100644 --- a/content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-validity-checks-for-your-repository.md +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/enabling-validity-checks-for-your-repository.md @@ -1,15 +1,17 @@ --- title: Enabling validity checks for your repository shortTitle: Enable validity checks -intro: 'Enabling validity checks on your repository helps you prioritize the remediation of alerts as it tells you if a secret is active or inactive.' +intro: Enabling validity checks on your repository helps you prioritize the remediation of alerts as it tells you if a secret is active or inactive. product: '{% data reusables.gated-features.partner-pattern-validity-check-ghas %}' versions: feature: secret-scanning-validity-check-partner-patterns -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts +redirect_from: + - /code-security/secret-scanning/enabling-secret-scanning-features/enabling-validity-checks-for-your-repository --- ## About validity checks diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/excluding-folders-and-files-from-secret-scanning.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/excluding-folders-and-files-from-secret-scanning.md similarity index 91% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/excluding-folders-and-files-from-secret-scanning.md rename to content/code-security/how-tos/secure-your-secrets/customize-leak-detection/excluding-folders-and-files-from-secret-scanning.md index 93bba13213fb..f9873a3a51a9 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/excluding-folders-and-files-from-secret-scanning.md +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/excluding-folders-and-files-from-secret-scanning.md @@ -1,17 +1,19 @@ --- title: Excluding folders and files from secret scanning -intro: 'You can customize {% data variables.product.prodname_secret_scanning %} to automatically close alerts for secrets found in specific directories or files by configuring a `secret_scanning.yml` file in your repository.' +intro: You can customize {% data variables.product.prodname_secret_scanning %} to automatically close alerts for secrets found in specific directories or files by configuring a `secret_scanning.yml` file in your repository. permissions: '{% data reusables.permissions.secret-scanning-alerts %}' shortTitle: Exclude folders and files versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Repositories +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/excluding-folders-and-files-from-secret-scanning --- ## About {% data variables.product.prodname_secret_scanning %} diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning.md similarity index 85% rename from content/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning.md rename to content/code-security/how-tos/secure-your-secrets/customize-leak-detection/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning.md index 85851a8ad76d..da9eca753587 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning.md +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning.md @@ -1,12 +1,12 @@ --- title: Generating regular expressions for custom patterns with Copilot secret scanning shortTitle: Regular expression generator -intro: 'You can use {% data variables.secret-scanning.copilot-secret-scanning %}''s {% data variables.secret-scanning.custom-pattern-regular-expression-generator %} to write regular expressions for custom patterns. The generator uses an AI model to generate expressions that match your input, and optionally example strings.' +intro: You can use {% data variables.secret-scanning.copilot-secret-scanning %}'s {% data variables.secret-scanning.custom-pattern-regular-expression-generator %} to write regular expressions for custom patterns. The generator uses an AI model to generate expressions that match your input, and optionally example strings. permissions: '{% data reusables.permissions.security-repo-enable %}' allowTitleToDifferFromFilename: true versions: feature: secret-scanning-custom-pattern-ai-generated -type: how_to +contentType: how-tos topics: - Secret Protection - Secret scanning @@ -16,6 +16,7 @@ redirect_from: - /code-security/secret-scanning/generating-regular-expressions-for-custom-patterns-with-ai - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/generating-regular-expressions-for-custom-patterns-with-ai - /code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-ai + - /code-security/secret-scanning/copilot-secret-scanning/generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning --- ## Generating a regular expression for a repository with {% data variables.secret-scanning.copilot-secret-scanning %} diff --git a/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/index.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/index.md new file mode 100644 index 000000000000..5492bf35afc7 --- /dev/null +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/index.md @@ -0,0 +1,22 @@ +--- +title: How-tos for customizing secret leak detection +shortTitle: Detection customization +intro: Learn how to customize {% data variables.product.github %}'s secret leak detection tools. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning +contentType: how-tos +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features +children: + - /defining-custom-patterns-for-secret-scanning + - /generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning + - /managing-custom-patterns + - /excluding-folders-and-files-from-secret-scanning + - /enabling-validity-checks-for-your-repository + - /enabling-extended-metadata-checks-for-your-repository +--- diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/managing-custom-patterns.md similarity index 96% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md rename to content/code-security/how-tos/secure-your-secrets/customize-leak-detection/managing-custom-patterns.md index 7a290a304aa2..1e8b495421ac 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns.md +++ b/content/code-security/how-tos/secure-your-secrets/customize-leak-detection/managing-custom-patterns.md @@ -1,16 +1,18 @@ --- title: Managing custom patterns shortTitle: Manage custom patterns -intro: 'You can view, edit, and remove custom patterns, as well as enable push protection for custom patterns.' +intro: You can view, edit, and remove custom patterns, as well as enable push protection for custom patterns. permissions: '{% data reusables.permissions.security-enterprise-enable %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret Protection - Secret scanning +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/managing-custom-patterns --- Custom patterns are user-defined patterns that you can use to identify secrets that are not detected by the default patterns supported by {% data variables.product.prodname_secret_scanning %}. For more information, see [AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning). diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/enabling-ai-powered-generic-secret-detection.md b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-ai-powered-generic-secret-detection.md similarity index 88% rename from content/code-security/secret-scanning/copilot-secret-scanning/enabling-ai-powered-generic-secret-detection.md rename to content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-ai-powered-generic-secret-detection.md index dcd8c18cb2ba..c688b97739a7 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/enabling-ai-powered-generic-secret-detection.md +++ b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-ai-powered-generic-secret-detection.md @@ -1,12 +1,12 @@ --- title: Enabling Copilot secret scanning's generic secret detection shortTitle: Enable generic secret detection -intro: 'You can enable {% data variables.secret-scanning.generic-secret-detection %} for your repository or organization. Alerts for generic secrets, such as passwords, are displayed in a separate list on the {% data variables.product.prodname_secret_scanning %} alerts page.' +intro: You can enable {% data variables.secret-scanning.generic-secret-detection %} for your repository or organization. Alerts for generic secrets, such as passwords, are displayed in a separate list on the {% data variables.product.prodname_secret_scanning %} alerts page. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.security-repo-enable %}' versions: feature: secret-scanning-ai-generic-secret-detection -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection @@ -15,6 +15,7 @@ topics: redirect_from: - /code-security/secret-scanning/enabling-ai-powered-generic-secret-detection - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/enabling-ai-powered-generic-secret-detection + - /code-security/secret-scanning/copilot-secret-scanning/enabling-ai-powered-generic-secret-detection --- ## Enabling {% data variables.secret-scanning.generic-secret-detection %} diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/enabling-secret-scanning-for-non-provider-patterns.md b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-non-provider-patterns.md similarity index 80% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/enabling-secret-scanning-for-non-provider-patterns.md rename to content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-non-provider-patterns.md index 0fd1da8ea261..f766dd9a6fbf 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/enabling-secret-scanning-for-non-provider-patterns.md +++ b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-non-provider-patterns.md @@ -1,20 +1,23 @@ --- title: Enabling secret scanning for non-provider patterns allowTitleToDifferFromFilename: true -intro: 'You can enable {% data variables.product.prodname_secret_scanning %} to detect additional potential secrets at the {% ifversion security-configurations %}repository and organization levels{% else %}repository level{% endif %}.' +intro: You can enable {% data variables.product.prodname_secret_scanning %} to detect additional potential secrets at the {% ifversion security-configurations %}repository and organization levels{% else %}repository level{% endif %}. permissions: '{% data reusables.permissions.security-repo-enable %}' product: '{% data reusables.gated-features.secret-scanning-non-provider-patterns %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts - Repositories shortTitle: Enable for non-provider patterns +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/enabling-secret-scanning-for-non-provider-patterns + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns --- ## Enabling scanning for non-provider patterns diff --git a/content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository.md b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-your-repository.md similarity index 93% rename from content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository.md rename to content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-your-repository.md index 941742026291..df76460857f9 100644 --- a/content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository.md +++ b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/enabling-secret-scanning-for-your-repository.md @@ -1,17 +1,19 @@ --- title: Enabling secret scanning for your repository shortTitle: Enable secret scanning -intro: 'You can configure how {% data variables.product.prodname_dotcom %} scans your repositories for leaked secrets and generates alerts.' +intro: You can configure how {% data variables.product.prodname_dotcom %} scans your repositories for leaked secrets and generates alerts. product: '{% data reusables.gated-features.secret-scanning %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts +redirect_from: + - /code-security/secret-scanning/enabling-secret-scanning-features/enabling-secret-scanning-for-your-repository --- ## About enabling {% data variables.secret-scanning.user_alerts %} diff --git a/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/index.md b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/index.md new file mode 100644 index 000000000000..63ec3f163859 --- /dev/null +++ b/content/code-security/how-tos/secure-your-secrets/detect-secret-leaks/index.md @@ -0,0 +1,19 @@ +--- +title: How-tos for detecting secret leaks +shortTitle: Leak detection +intro: Learn how to use {% data variables.product.github %}'s tools to detect secret leaks. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning +contentType: how-tos +redirect_from: + - /code-security/secret-scanning/enabling-secret-scanning-features +children: + - /enabling-secret-scanning-for-your-repository + - /enabling-secret-scanning-for-non-provider-patterns + - /enabling-ai-powered-generic-secret-detection +--- diff --git a/content/code-security/how-tos/secure-your-secrets/index.md b/content/code-security/how-tos/secure-your-secrets/index.md new file mode 100644 index 000000000000..a5a41f1815b9 --- /dev/null +++ b/content/code-security/how-tos/secure-your-secrets/index.md @@ -0,0 +1,22 @@ +--- +title: How-tos for securing secrets +shortTitle: Secure your secrets +intro: Learn how to use {% data variables.product.github %}'s security and code quality features. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning +contentType: how-tos +redirect_from: + - /code-security/secret-scanning +children: + - /detect-secret-leaks + - /customize-leak-detection + - /troubleshooting-secret-scanning + - /prevent-future-leaks + - /work-with-leak-prevention + - /manage-bypass-requests +--- diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/enabling-delegated-bypass-for-push-protection.md b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/enabling-delegated-bypass-for-push-protection.md similarity index 94% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/enabling-delegated-bypass-for-push-protection.md rename to content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/enabling-delegated-bypass-for-push-protection.md index a95992c025dd..c58fb4900542 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/enabling-delegated-bypass-for-push-protection.md +++ b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/enabling-delegated-bypass-for-push-protection.md @@ -1,18 +1,20 @@ --- title: Enabling delegated bypass for push protection -intro: 'You can use delegated bypass for your organization or repository to control who can push commits that contain secrets identified by {% data variables.product.prodname_secret_scanning %}.' +intro: You can use delegated bypass for your organization or repository to control who can push commits that contain secrets identified by {% data variables.product.prodname_secret_scanning %}. permissions: '{% data reusables.permissions.delegated-bypass %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts - Repositories shortTitle: Enable delegated bypass +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/enabling-delegated-bypass-for-push-protection --- ## About enabling delegated bypass for push protection diff --git a/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/index.md b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/index.md new file mode 100644 index 000000000000..261f68f37691 --- /dev/null +++ b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/index.md @@ -0,0 +1,18 @@ +--- +title: How-tos for bypass requests +shortTitle: Bypass requests +intro: Learn how to use the delegated bypass feature. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning +contentType: how-tos +children: + - /enabling-delegated-bypass-for-push-protection + - /managing-requests-to-bypass-push-protection + - /reviewing-requests-to-bypass-push-protection +--- + diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/managing-requests-to-bypass-push-protection.md b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/managing-requests-to-bypass-push-protection.md similarity index 93% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/managing-requests-to-bypass-push-protection.md rename to content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/managing-requests-to-bypass-push-protection.md index 3a42dc9391b4..3b3cdb334df7 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/managing-requests-to-bypass-push-protection.md +++ b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/managing-requests-to-bypass-push-protection.md @@ -1,18 +1,20 @@ --- title: Managing requests to bypass push protection -intro: 'As a member of the bypass list for an organization or repository, you can review bypass requests from other members of the organization or repository.' +intro: As a member of the bypass list for an organization or repository, you can review bypass requests from other members of the organization or repository. permissions: '{% data reusables.permissions.delegated-bypass-list %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts - Repositories shortTitle: Manage bypass requests +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/managing-requests-to-bypass-push-protection --- ## Managing requests to bypass push protection diff --git a/content/code-security/security-overview/reviewing-requests-to-bypass-push-protection.md b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/reviewing-requests-to-bypass-push-protection.md similarity index 92% rename from content/code-security/security-overview/reviewing-requests-to-bypass-push-protection.md rename to content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/reviewing-requests-to-bypass-push-protection.md index ffb553904dcd..616e6bc857f8 100644 --- a/content/code-security/security-overview/reviewing-requests-to-bypass-push-protection.md +++ b/content/code-security/how-tos/secure-your-secrets/manage-bypass-requests/reviewing-requests-to-bypass-push-protection.md @@ -1,10 +1,10 @@ --- title: Reviewing requests to bypass push protection shortTitle: Review bypass requests -intro: 'You can use security overview to review requests to bypass push protection from contributors pushing to repositories across your organization.' +intro: You can use security overview to review requests to bypass push protection from contributors pushing to repositories across your organization. permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-sp-only %}' -type: how_to +contentType: how-tos topics: - Security overview - Secret Protection @@ -14,6 +14,8 @@ topics: - Alerts versions: feature: security-overview-delegated-bypass-requests +redirect_from: + - /code-security/security-overview/reviewing-requests-to-bypass-push-protection --- ## About bypass requests diff --git a/content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-push-protection-for-your-repository.md b/content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/enabling-push-protection-for-your-repository.md similarity index 91% rename from content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-push-protection-for-your-repository.md rename to content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/enabling-push-protection-for-your-repository.md index b74848ca9bec..dd14758c9f29 100644 --- a/content/code-security/secret-scanning/enabling-secret-scanning-features/enabling-push-protection-for-your-repository.md +++ b/content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/enabling-push-protection-for-your-repository.md @@ -1,17 +1,19 @@ --- title: Enabling push protection for your repository shortTitle: Enable push protection -intro: 'With push protection, {% data variables.product.prodname_secret_scanning %} blocks contributors from pushing secrets to a repository and generates an alert whenever a contributor bypasses the block.' +intro: With push protection, {% data variables.product.prodname_secret_scanning %} blocks contributors from pushing secrets to a repository and generates an alert whenever a contributor bypasses the block. permissions: '{% data reusables.permissions.push-protection %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts +redirect_from: + - /code-security/secret-scanning/enabling-secret-scanning-features/enabling-push-protection-for-your-repository --- ## About enabling push protection diff --git a/content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/index.md b/content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/index.md new file mode 100644 index 000000000000..d8e374f8d745 --- /dev/null +++ b/content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/index.md @@ -0,0 +1,17 @@ +--- +title: How-tos for leak prevention +shortTitle: Leak prevention +intro: Learn how to prevent future secret leaks with {% data variables.product.github %}'s tools. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning +contentType: how-tos +children: + - /enabling-push-protection-for-your-repository + - /push-protection-for-users +--- + diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users.md b/content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/push-protection-for-users.md similarity index 90% rename from content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users.md rename to content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/push-protection-for-users.md index 33a7a7bbc652..22319c1294cf 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users.md +++ b/content/code-security/how-tos/secure-your-secrets/prevent-future-leaks/push-protection-for-users.md @@ -1,10 +1,11 @@ --- title: Push protection for users -intro: 'With push protection for users, you are automatically protected on all pushes to public repositories across {% data variables.product.github %}.' +shortTitle: Push protection for users +intro: With push protection for users, you are automatically protected on all pushes to public repositories across {% data variables.product.github %}. versions: feature: secret-scanning-push-protection-for-users product: '{% data reusables.gated-features.push-protection-for-users %}' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection @@ -12,6 +13,7 @@ topics: - User account redirect_from: - /code-security/secret-scanning/push-protection-for-users + - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/push-protection-for-users --- ## About push protection for users diff --git a/content/code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/troubleshooting-secret-scanning.md b/content/code-security/how-tos/secure-your-secrets/troubleshooting-secret-scanning.md similarity index 88% rename from content/code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/troubleshooting-secret-scanning.md rename to content/code-security/how-tos/secure-your-secrets/troubleshooting-secret-scanning.md index 39590d586217..822ae6f36841 100644 --- a/content/code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/troubleshooting-secret-scanning.md +++ b/content/code-security/how-tos/secure-your-secrets/troubleshooting-secret-scanning.md @@ -1,19 +1,21 @@ --- title: Troubleshooting secret scanning shortTitle: Troubleshoot secret scanning -intro: 'When using {% data variables.product.prodname_secret_scanning %} to detect secrets in your repository, or secrets about to be committed into your repository, you may need to troubleshoot unexpected issues.' +intro: When using {% data variables.product.prodname_secret_scanning %} to detect secrets in your repository, or secrets about to be committed into your repository, you may need to troubleshoot unexpected issues. product: '{% data reusables.gated-features.secret-scanning %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Secret scanning - Secret Protection - Troubleshooting redirect_from: - /code-security/secret-scanning/troubleshooting-secret-scanning + - /code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/troubleshooting-secret-scanning + - /code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection +contentType: how-tos --- {% data reusables.secret-scanning.enterprise-enable-secret-scanning %} diff --git a/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/index.md b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/index.md new file mode 100644 index 000000000000..d69c827dacd5 --- /dev/null +++ b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/index.md @@ -0,0 +1,18 @@ +--- +title: How-tos for push protection +shortTitle: Push protection +intro: Learn how to use {% data variables.product.github %}'s push protection. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning +contentType: how-tos +redirect_from: + - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection +children: + - /working-with-push-protection-from-the-command-line + - /working-with-push-protection-in-the-github-ui +--- diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line.md b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-from-the-command-line.md similarity index 95% rename from content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line.md rename to content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-from-the-command-line.md index 324b4851c1a4..672174ddf74c 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line.md +++ b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-from-the-command-line.md @@ -1,18 +1,20 @@ --- title: Working with push protection from the command line shortTitle: Push protection on the command line -intro: 'Learn your options for unblocking your push from the command line to {% data variables.product.prodname_dotcom %} if {% data variables.product.prodname_secret_scanning %} detects a secret in your changes.' +intro: Learn your options for unblocking your push from the command line to {% data variables.product.prodname_dotcom %} if {% data variables.product.prodname_secret_scanning %} detects a secret in your changes. permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts - Repositories +redirect_from: + - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-command-line --- ## About push protection from the command line diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui.md b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-in-the-github-ui.md similarity index 94% rename from content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui.md rename to content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-in-the-github-ui.md index 57526b410c31..2ce7de42ee9d 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui.md +++ b/content/code-security/how-tos/secure-your-secrets/work-with-leak-prevention/working-with-push-protection-in-the-github-ui.md @@ -1,18 +1,20 @@ --- title: Working with push protection in the GitHub UI shortTitle: Push protection in the GitHub UI -intro: 'Learn your options for unblocking your commit when {% data variables.product.prodname_secret_scanning %} detects a secret in your changes.' +intro: Learn your options for unblocking your commit when {% data variables.product.prodname_secret_scanning %} detects a secret in your changes. permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to +contentType: how-tos topics: - Secret scanning - Secret Protection - Alerts - Repositories +redirect_from: + - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-in-the-github-ui --- ## About push protection in the {% data variables.product.prodname_dotcom %} UI diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/exporting-a-software-bill-of-materials-for-your-repository.md similarity index 94% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md rename to content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/exporting-a-software-bill-of-materials-for-your-repository.md index 2d0341491374..eb56096302e0 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository.md +++ b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/exporting-a-software-bill-of-materials-for-your-repository.md @@ -6,12 +6,14 @@ versions: ghes: '*' ghec: '*' permissions: '{% data reusables.permissions.dependency-graph-export-sbom %}' -type: how_to topics: - Dependency graph - Dependencies - Repositories shortTitle: Export dependencies as SBOM +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository +contentType: how-tos --- ## About the dependency graph and SBOM exports diff --git a/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/index.md b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/index.md new file mode 100644 index 000000000000..bcd45b5d263d --- /dev/null +++ b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/index.md @@ -0,0 +1,14 @@ +--- +title: Establishing provenance and integrity for your projects +shortTitle: Establish provenance and integrity +intro: Secure and audit your releases and artifacts. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /preventing-changes-to-your-releases + - /exporting-a-software-bill-of-materials-for-your-repository +--- + diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/preventing-changes-to-your-releases.md b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/preventing-changes-to-your-releases.md similarity index 82% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/preventing-changes-to-your-releases.md rename to content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/preventing-changes-to-your-releases.md index 8d056b886621..6ca1c12a966e 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/preventing-changes-to-your-releases.md +++ b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/preventing-changes-to-your-releases.md @@ -1,15 +1,17 @@ --- title: Preventing changes to your releases shortTitle: Prevent release changes -intro: 'You can enforce immutable releases for a repository or organization to prevent potential vulnerabilities.' +intro: You can enforce immutable releases for a repository or organization to prevent potential vulnerabilities. versions: fpt: '*' ghec: '*' -type: overview topics: - Code Security - Vulnerabilities - Dependencies +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/preventing-changes-to-your-releases +contentType: how-tos --- ## Enforcing immutable releases for your repository diff --git a/content/code-security/how-tos/secure-your-supply-chain/index.md b/content/code-security/how-tos/secure-your-supply-chain/index.md new file mode 100644 index 000000000000..1c7f24d76091 --- /dev/null +++ b/content/code-security/how-tos/secure-your-supply-chain/index.md @@ -0,0 +1,21 @@ +--- +title: Securing your supply chain +shortTitle: Secure your supply chain +intro: Enable and manage features for supply chain security. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +redirect_from: + - /categories/managing-security-vulnerabilities + - /github/managing-security-vulnerabilities + - /code-security/supply-chain-security + - /code-security/dependabot/working-with-dependabot + - /code-security/dependabot +children: + - secure-your-dependencies + - manage-your-dependency-security + - troubleshoot-dependency-security + - establish-provenance-and-integrity +--- diff --git a/content/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot.md similarity index 95% rename from content/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot.md index 338ea66a57a0..1f68dc72b8b9 100644 --- a/content/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-access-to-private-registries-for-dependabot.md @@ -1,17 +1,17 @@ --- title: Configuring access to private registries for Dependabot -intro: 'You can configure {% data variables.product.prodname_dependabot %} to access dependencies stored in private registries. You can store authentication information, like passwords and access tokens, as encrypted secrets and then reference these in the {% data variables.product.prodname_dependabot %} configuration file.{% ifversion dependabot-on-actions-self-hosted %} If you have registries on private networks, you can also configure {% data variables.product.prodname_dependabot %} access when running {% data variables.product.prodname_dependabot %} on self-hosted runners.{% endif %}' +intro: You can configure {% data variables.product.prodname_dependabot %} to access dependencies stored in private registries. You can store authentication information, like passwords and access tokens, as encrypted secrets and then reference these in the {% data variables.product.prodname_dependabot %} configuration file.{% ifversion dependabot-on-actions-self-hosted %} If you have registries on private networks, you can also configure {% data variables.product.prodname_dependabot %} access when running {% data variables.product.prodname_dependabot %} on self-hosted runners.{% endif %} permissions: '{% data reusables.permissions.dependabot-various-tasks %}' redirect_from: - /github/administering-a-repository/managing-encrypted-secrets-for-dependabot - /code-security/supply-chain-security/managing-encrypted-secrets-for-dependabot - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-encrypted-secrets-for-dependabot - /code-security/dependabot/working-with-dependabot/managing-encrypted-secrets-for-dependabot + - /code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Version updates @@ -19,6 +19,7 @@ topics: - Repositories - Dependencies shortTitle: Configure access to private registries +contentType: how-tos --- ## About private registries @@ -344,7 +345,7 @@ registries: ### `maven-repository` -The `maven-repository` type supports username and password. {% data reusables.dependabot.password-definition %} +The `maven-repository` type supports username, password and replaces-base. {% data reusables.dependabot.password-definition %} {% data reusables.dependabot.dependabot-updates-path-match %} @@ -357,6 +358,7 @@ registries: url: https://acme.jfrog.io/artifactory/my-maven-registry username: octocat password: ${{secrets.MY_ARTIFACTORY_PASSWORD}} + replaces-base: true ``` {% endraw %} diff --git a/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-notifications-for-dependabot-alerts.md similarity index 96% rename from content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-notifications-for-dependabot-alerts.md index 203db90b7791..7a5bf9112ef6 100644 --- a/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-notifications-for-dependabot-alerts.md @@ -1,16 +1,16 @@ --- title: Configuring notifications for Dependabot alerts -shortTitle: Configure notifications -intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.' +shortTitle: Configure Dependabot notifications +intro: Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}. redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies + - /code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Dependabot - Alerts @@ -18,6 +18,7 @@ topics: - Vulnerabilities - Dependencies - Repositories +contentType: how-tos --- ## About notifications for {% data variables.product.prodname_dependabot_alerts %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-review-action.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-the-dependency-review-action.md similarity index 98% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-review-action.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-the-dependency-review-action.md index d5487ffc0ded..4377c500ea70 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-review-action.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/configuring-the-dependency-review-action.md @@ -7,7 +7,6 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Dependency review @@ -16,6 +15,8 @@ topics: - Pull requests redirect_from: - /code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review + - /code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-review-action +contentType: how-tos --- ## About the {% data variables.dependency-review.action_name %} diff --git a/content/code-security/dependabot/dependabot-version-updates/controlling-dependencies-updated.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/controlling-dependencies-updated.md similarity index 97% rename from content/code-security/dependabot/dependabot-version-updates/controlling-dependencies-updated.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/controlling-dependencies-updated.md index b92b455d0578..c229ac51673b 100644 --- a/content/code-security/dependabot/dependabot-version-updates/controlling-dependencies-updated.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/controlling-dependencies-updated.md @@ -1,13 +1,12 @@ --- title: Controlling which dependencies are updated by Dependabot -intro: 'Learn how to configure your `dependabot.yml` file so that {% data variables.product.prodname_dependabot %} automatically updates the packages you specify, in the way you define.' +intro: Learn how to configure your `dependabot.yml` file so that {% data variables.product.prodname_dependabot %} automatically updates the packages you specify, in the way you define. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.dependabot-yml-configure %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Version updates @@ -15,6 +14,9 @@ topics: - Dependencies - Pull requests shortTitle: Control dependency update +redirect_from: + - /code-security/dependabot/dependabot-version-updates/controlling-dependencies-updated +contentType: how-tos --- You can customize your {% data variables.product.prodname_dependabot %} configuration to suit your needs, by adding options to your `dependabot.yml` file. For example, you can make sure that {% data variables.product.prodname_dependabot %} uses the correct package manifest files, and updates only the dependencies you want maintained. diff --git a/content/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md similarity index 95% rename from content/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md index 0028e13365db..afa7f8eeca29 100644 --- a/content/code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-auto-triage-rules-to-prioritize-dependabot-alerts.md @@ -1,22 +1,23 @@ --- title: Customizing auto-triage rules to prioritize Dependabot alerts -intro: 'You can create your own {% data variables.dependabot.auto_triage_rules_short %} to control which alerts are dismissed or snoozed, and which alerts you want {% data variables.product.prodname_dependabot %} to open pull requests for.' +intro: You can create your own {% data variables.dependabot.auto_triage_rules_short %} to control which alerts are dismissed or snoozed, and which alerts you want {% data variables.product.prodname_dependabot %} to open pull requests for. product: '{% data reusables.gated-features.dependabot-auto-triage-rules %}' permissions: '{% data reusables.permissions.dependabot-auto-triage-rules %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Alerts - Vulnerabilities - Repositories - Dependencies -shortTitle: Custom auto-triage rules +shortTitle: Auto-triage Dependabot alerts redirect_from: - /code-security/dependabot/dependabot-alert-rules/customizing-alert-rules-to-prioritize-dependabot-alerts + - /code-security/dependabot/dependabot-auto-triage-rules/customizing-auto-triage-rules-to-prioritize-dependabot-alerts +contentType: how-tos --- ## About {% data variables.dependabot.custom_rules %} diff --git a/content/code-security/dependabot/dependabot-security-updates/customizing-dependabot-security-prs.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-dependabot-security-prs.md similarity index 97% rename from content/code-security/dependabot/dependabot-security-updates/customizing-dependabot-security-prs.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-dependabot-security-prs.md index 96d046d4f66b..7a9fbbdab26c 100644 --- a/content/code-security/dependabot/dependabot-security-updates/customizing-dependabot-security-prs.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/customizing-dependabot-security-prs.md @@ -1,13 +1,12 @@ --- title: Customizing pull requests for Dependabot security updates -intro: 'Learn how to customize Dependabot pull requests for security updates to align with your project''s security priorities and workflows.' +intro: Learn how to customize Dependabot pull requests for security updates to align with your project's security priorities and workflows. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.dependabot-yml-configure %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Security updates @@ -15,6 +14,9 @@ topics: - Dependencies - Pull requests shortTitle: Customize Dependabot PRs +redirect_from: + - /code-security/dependabot/dependabot-security-updates/customizing-dependabot-security-prs +contentType: how-tos --- ## About customizing pull requests for security updates diff --git a/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/guidance-for-the-configuration-of-private-registries-for-dependabot.md similarity index 98% rename from content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/guidance-for-the-configuration-of-private-registries-for-dependabot.md index 38bf6aa7ac35..8e5747bc0997 100644 --- a/content/code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/guidance-for-the-configuration-of-private-registries-for-dependabot.md @@ -1,19 +1,21 @@ --- title: Guidance for the configuration of private registries for Dependabot -intro: 'This article contains detailed information about configuring private registries, as well as commands you can run from the command line to configure your package managers locally.' +intro: This article contains detailed information about configuring private registries, as well as commands you can run from the command line to configure your package managers locally. permissions: '{% data reusables.permissions.dependabot-various-tasks %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Version updates - Secret store - Repositories - Dependencies -shortTitle: Guidance for configuring private registries +shortTitle: Configure private registries +redirect_from: + - /code-security/dependabot/working-with-dependabot/guidance-for-the-configuration-of-private-registries-for-dependabot +contentType: how-tos --- ## About configuring private registries for {% data variables.product.prodname_dependabot %} @@ -211,7 +213,7 @@ When configuring {% data variables.product.prodname_dependabot %} for Helm chart Gradle supports the `maven-repository` registry type. For more information, see `maven-repository` in [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#maven-repository). -The `maven-repository` type supports username and password. {% data reusables.dependabot.password-definition %} +The `maven-repository` type supports username, password and replaces-base. {% data reusables.dependabot.password-definition %} {% raw %} @@ -222,6 +224,7 @@ registries: url: https://acme.jfrog.io/artifactory/my-gradle-registry username: octocat password: ${{secrets.MY_ARTIFACTORY_PASSWORD}} + replaces-base: true updates: - package-ecosystem: "gradle" directory: "/" @@ -280,7 +283,7 @@ This feature enables unified dependency management for both public and private G ### Maven -Maven supports username and password authentication. For more information, see `maven-repository` in [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#maven-repository). +Maven supports username, password and replaces-base. For more information, see `maven-repository` in [AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#maven-repository). {% raw %} @@ -291,6 +294,7 @@ registries: url: https://acme.jfrog.io/artifactory/my-maven-registry username: octocat password: ${{secrets.MY_ARTIFACTORY_PASSWORD}} + replaces-base: true ``` {% endraw %} @@ -307,6 +311,7 @@ registries: url: https://maven.pkg.github.com/octocat username: octocat password: ${{secrets.OCTOCAT_GITHUB_PAT}} + replaces-base: true updates: - package-ecosystem: "maven" directory: "/" diff --git a/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/index.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/index.md new file mode 100644 index 000000000000..baf1e01b9726 --- /dev/null +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/index.md @@ -0,0 +1,28 @@ +--- +title: Managing your dependency security +shortTitle: Manage your dependency security +intro: Customize and configure features for dependency management. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /customizing-auto-triage-rules-to-prioritize-dependabot-alerts + - /using-github-preset-rules-to-prioritize-dependabot-alerts + - /customizing-dependabot-security-prs + - /controlling-dependencies-updated + - /configuring-the-dependency-review-action + - /optimizing-java-packages-dependabot + - /configuring-notifications-for-dependabot-alerts + - /configuring-access-to-private-registries-for-dependabot + - /removing-dependabot-access-to-public-registries + - /managing-pull-requests-for-dependency-updates + - /managing-dependabot-on-self-hosted-runners + - /listing-dependencies-configured-for-version-updates + - /guidance-for-the-configuration-of-private-registries-for-dependabot +redirect_from: + - /code-security/dependabot/maintain-dependencies + - /code-security/dependabot/dependabot-security-updates +--- + diff --git a/content/code-security/dependabot/troubleshooting-dependabot/listing-dependencies-configured-for-version-updates.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/listing-dependencies-configured-for-version-updates.md similarity index 89% rename from content/code-security/dependabot/troubleshooting-dependabot/listing-dependencies-configured-for-version-updates.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/listing-dependencies-configured-for-version-updates.md index 59632c4d17ce..9ba4aabc5c03 100644 --- a/content/code-security/dependabot/troubleshooting-dependabot/listing-dependencies-configured-for-version-updates.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/listing-dependencies-configured-for-version-updates.md @@ -1,23 +1,24 @@ --- title: Listing dependencies configured for version updates -intro: 'You can view the dependencies that {% data variables.product.prodname_dependabot %} monitors for updates.' +intro: You can view the dependencies that {% data variables.product.prodname_dependabot %} monitors for updates. permissions: '{% data reusables.permissions.dependabot-yml-configure %}' redirect_from: - /github/administering-a-repository/listing-dependencies-configured-for-version-updates - /code-security/supply-chain-security/listing-dependencies-configured-for-version-updates - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/listing-dependencies-configured-for-version-updates - /code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates + - /code-security/dependabot/troubleshooting-dependabot/listing-dependencies-configured-for-version-updates versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Repositories - Dependabot - Version updates - Dependencies shortTitle: List configured dependencies +contentType: how-tos --- {% data reusables.dependabot.enterprise-enable-dependabot %} diff --git a/content/code-security/dependabot/maintain-dependencies/managing-dependabot-on-self-hosted-runners.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-dependabot-on-self-hosted-runners.md similarity index 97% rename from content/code-security/dependabot/maintain-dependencies/managing-dependabot-on-self-hosted-runners.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-dependabot-on-self-hosted-runners.md index 795d81441a81..2a79d8697e82 100644 --- a/content/code-security/dependabot/maintain-dependencies/managing-dependabot-on-self-hosted-runners.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-dependabot-on-self-hosted-runners.md @@ -1,11 +1,10 @@ --- title: Managing Dependabot on self-hosted runners -intro: 'You can configure self-hosted runners that {% data variables.product.prodname_dependabot %} uses to access your private registries and internal network resources.' +intro: You can configure self-hosted runners that {% data variables.product.prodname_dependabot %} uses to access your private registries and internal network resources. shortTitle: Manage Dependabot on self-hosted runners permissions: '{% data reusables.permissions.dependabot-actions %}' versions: feature: dependabot-on-actions-self-hosted -type: how_to topics: - Dependabot - Security updates @@ -15,6 +14,8 @@ topics: - Repositories redirect_from: - /code-security/dependabot/working-with-dependabot/managing-dependabot-on-self-hosted-runners + - /code-security/dependabot/maintain-dependencies/managing-dependabot-on-self-hosted-runners +contentType: how-tos --- ## About {% data variables.product.prodname_dependabot %} on {% data variables.product.prodname_actions %} self-hosted runners diff --git a/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-pull-requests-for-dependency-updates.md similarity index 97% rename from content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-pull-requests-for-dependency-updates.md index 800a9948285e..4895fad310f0 100644 --- a/content/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/managing-pull-requests-for-dependency-updates.md @@ -1,16 +1,16 @@ --- title: Managing pull requests for dependency updates -intro: 'You manage pull requests raised by {% data variables.product.prodname_dependabot %} in much the same way as other pull requests, but there are some extra options.' +intro: You manage pull requests raised by {% data variables.product.prodname_dependabot %} in much the same way as other pull requests, but there are some extra options. permissions: '{% data reusables.permissions.dependabot-various-tasks %}' redirect_from: - /github/administering-a-repository/managing-pull-requests-for-dependency-updates - /code-security/supply-chain-security/managing-pull-requests-for-dependency-updates - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates + - /code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Repositories - Version updates @@ -19,6 +19,7 @@ topics: - Dependencies - Vulnerabilities shortTitle: Manage Dependabot PRs +contentType: how-tos --- {% data reusables.dependabot.enterprise-enable-dependabot %} diff --git a/content/code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/optimizing-java-packages-dependabot.md similarity index 88% rename from content/code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/optimizing-java-packages-dependabot.md index be4d943040e6..4553e25f94fd 100644 --- a/content/code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/optimizing-java-packages-dependabot.md @@ -1,17 +1,19 @@ --- title: Optimizing Java packages for Dependabot updates -intro: 'By including metadata in your `pom.xml` file, you can enhance the information available to users in {% data variables.product.prodname_dependabot%} pull requests to update your Java packages.' -shortTitle: Optimize Java packages # Max 31 characters +intro: By including metadata in your `pom.xml` file, you can enhance the information available to users in {% data variables.product.prodname_dependabot%} pull requests to update your Java packages. +shortTitle: Optimize Java packages allowTitleToDifferFromFilename: true versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Dependencies - Repositories +redirect_from: + - /code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot +contentType: how-tos --- {% data variables.product.prodname_dependabot %} uses the information defined in `pom.xml` files to create pull requests to update Java dependencies for the Gradle and Maven ecosystems. When you include the project metadata that {% data variables.product.prodname_dependabot %} expects, pull requests contain links to the release notes for the suggested package update and a link where users can report any issues. This information means that users can update their packages with confidence after reviewing all the release information. diff --git a/content/code-security/dependabot/maintain-dependencies/removing-dependabot-access-to-public-registries.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/removing-dependabot-access-to-public-registries.md similarity index 98% rename from content/code-security/dependabot/maintain-dependencies/removing-dependabot-access-to-public-registries.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/removing-dependabot-access-to-public-registries.md index 85a3869a8c8e..d08a52cfd1f8 100644 --- a/content/code-security/dependabot/maintain-dependencies/removing-dependabot-access-to-public-registries.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/removing-dependabot-access-to-public-registries.md @@ -1,12 +1,11 @@ --- title: Removing Dependabot access to public registries -intro: 'Examples of how you can configure {% data variables.product.prodname_dependabot %} to only access private registries by removing calls to public registries.' +intro: Examples of how you can configure {% data variables.product.prodname_dependabot %} to only access private registries by removing calls to public registries. permissions: '{% data reusables.permissions.dependabot-various-tasks %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Dependabot - Version updates @@ -14,6 +13,8 @@ shortTitle: Remove access to public registries redirect_from: - /code-security/dependabot/working-with-dependabot/configuring-dependabot-to-only-access-private-registries - /code-security/dependabot/working-with-dependabot/removing-dependabot-access-to-public-registries + - /code-security/dependabot/maintain-dependencies/removing-dependabot-access-to-public-registries +contentType: how-tos --- ## About configuring {% data variables.product.prodname_dependabot %} to only access private registries diff --git a/content/code-security/dependabot/dependabot-auto-triage-rules/using-github-preset-rules-to-prioritize-dependabot-alerts.md b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/using-github-preset-rules-to-prioritize-dependabot-alerts.md similarity index 93% rename from content/code-security/dependabot/dependabot-auto-triage-rules/using-github-preset-rules-to-prioritize-dependabot-alerts.md rename to content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/using-github-preset-rules-to-prioritize-dependabot-alerts.md index 1c7295aace7f..6c6f8da4be01 100644 --- a/content/code-security/dependabot/dependabot-auto-triage-rules/using-github-preset-rules-to-prioritize-dependabot-alerts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/using-github-preset-rules-to-prioritize-dependabot-alerts.md @@ -1,22 +1,23 @@ --- title: Using GitHub preset rules to prioritize Dependabot alerts -intro: 'You can use {% data variables.dependabot.github_presets %}, which are rules curated by {% data variables.product.company_short %}, to auto-dismiss low impact development alerts for npm dependencies.' +intro: You can use {% data variables.dependabot.github_presets %}, which are rules curated by {% data variables.product.company_short %}, to auto-dismiss low impact development alerts for npm dependencies. permissions: '{% data reusables.permissions.dependabot-github-presets %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Alerts - Vulnerabilities - Repositories - Dependencies -shortTitle: GitHub preset rules +shortTitle: Prioritize with preset rules redirect_from: - /code-security/dependabot/dependabot-alert-rules/using-github-curated-alert-rules-to-prioritize-dependabot-alerts - /code-security/dependabot/dependabot-auto-triage-rules/using-github-curated-default-rules-to-prioritize-dependabot-alerts + - /code-security/dependabot/dependabot-auto-triage-rules/using-github-preset-rules-to-prioritize-dependabot-alerts +contentType: how-tos --- ## About {% data variables.dependabot.github_presets %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-automatic-dependency-submission-for-your-repository.md similarity index 97% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-automatic-dependency-submission-for-your-repository.md index 32ea2f9797f8..9d0fe4b6b9dd 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-automatic-dependency-submission-for-your-repository.md @@ -1,17 +1,18 @@ --- title: Configuring automatic dependency submission for your repository -shortTitle: Automatic dependency submission -intro: 'You can use automatic dependency submission to submit transitive dependency data in your repository. This enables you to analyze these transitive dependencies using the dependency graph.' +shortTitle: Submit dependencies automatically +intro: You can use automatic dependency submission to submit transitive dependency data in your repository. This enables you to analyze these transitive dependencies using the dependency graph. permissions: '{% data reusables.permissions.security-repo-enable %}' redirect_from: - /early-access/ghas/automatic-dependency-submission-for-maven + - /code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-automatic-dependency-submission-for-your-repository versions: feature: maven-transitive-dependencies -type: how_to topics: - Dependency graph - Dependencies - Repositories +contentType: how-tos --- ## About automatic dependency submission diff --git a/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-alerts.md similarity index 93% rename from content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-alerts.md index 9e30476fcd54..574abc09b2ca 100644 --- a/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-alerts.md @@ -1,13 +1,12 @@ --- title: Configuring Dependabot alerts -intro: 'Enable {% data variables.product.prodname_dependabot_alerts %} to be generated when a new vulnerable dependency is found in one of your repositories.' +intro: Enable {% data variables.product.prodname_dependabot_alerts %} to be generated when a new vulnerable dependency is found in one of your repositories. shortTitle: Configure Dependabot alerts permissions: '{% data reusables.permissions.dependabot-alerts %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Dependabot - Security updates @@ -15,6 +14,10 @@ topics: - Dependencies - Pull requests - Repositories +redirect_from: + - /code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts + - /code-security/dependabot/dependabot-alerts +contentType: how-tos --- ## About {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies @@ -43,10 +46,10 @@ You can enable or disable {% data variables.product.prodname_dependabot_alerts % You can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories owned by your personal account. +Go to your security settings {% octicon "link-external" height:16 aria-label="link-external" %} + ### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for existing repositories -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.security-analysis %} 1. Under "{% data variables.product.UI_advanced_security %}", to the right of {% data variables.product.prodname_dependabot_alerts %}, click **Disable all** or **Enable all**. 1. Optionally, to enable {% data variables.product.prodname_dependabot_alerts %} by default for new repositories that you create, in the dialog box, select "Enable by default for new repositories". 1. Click **Disable {% data variables.product.prodname_dependabot_alerts %}** or **Enable {% data variables.product.prodname_dependabot_alerts %}** to disable or enable {% data variables.product.prodname_dependabot_alerts %} for all the repositories you own. @@ -55,8 +58,6 @@ When you enable {% data variables.product.prodname_dependabot_alerts %} for exis ### Enabling or disabling {% data variables.product.prodname_dependabot_alerts %} for new repositories -{% data reusables.user-settings.access_settings %} -{% data reusables.user-settings.security-analysis %} 1. Under "{% data variables.product.UI_advanced_security %}", to the right of {% data variables.product.prodname_dependabot_alerts %}, select **Automatically enable for new repositories**. {% else %} diff --git a/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates.md similarity index 97% rename from content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates.md index c317f302f54b..c9b91e0a837a 100644 --- a/content/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates.md @@ -1,6 +1,6 @@ --- title: Configuring Dependabot security updates -intro: 'You can use {% data variables.product.prodname_dependabot_security_updates %} or manual pull requests to easily update vulnerable dependencies.' +intro: You can use {% data variables.product.prodname_dependabot_security_updates %} or manual pull requests to easily update vulnerable dependencies. shortTitle: Configure security updates permissions: '{% data reusables.permissions.dependabot-yml-configure %}' redirect_from: @@ -11,11 +11,11 @@ redirect_from: - /github/managing-security-vulnerabilities/configuring-dependabot-security-updates - /code-security/supply-chain-security/configuring-dependabot-security-updates - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates + - /code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Security updates @@ -23,6 +23,7 @@ topics: - Dependencies - Pull requests - Repositories +contentType: how-tos --- diff --git a/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-version-updates.md similarity index 97% rename from content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-version-updates.md index c8fb79e039a5..9568cefc8ea8 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-version-updates.md @@ -1,17 +1,17 @@ --- title: Configuring Dependabot version updates -intro: 'You can configure your repository so that {% data variables.product.prodname_dependabot %} automatically updates the packages you use.' +intro: You can configure your repository so that {% data variables.product.prodname_dependabot %} automatically updates the packages you use. permissions: '{% data reusables.permissions.dependabot-yml-configure %}' redirect_from: - /github/administering-a-repository/enabling-and-disabling-version-updates - /code-security/supply-chain-security/enabling-and-disabling-version-updates - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-version-updates - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/enabling-and-disabling-dependabot-version-updates + - /code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Version updates @@ -19,6 +19,7 @@ topics: - Dependencies - Pull requests shortTitle: Configure version updates +contentType: how-tos --- {% data reusables.dependabot.enterprise-enable-dependabot %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-the-dependency-graph.md similarity index 95% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-the-dependency-graph.md index 66cb634258d3..c64e817914ef 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-the-dependency-graph.md @@ -4,16 +4,17 @@ intro: You can allow users to identify their projects' dependencies by enabling permissions: '{% data reusables.permissions.dependency-graph %}' redirect_from: - /code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph#enabling-the-dependency-graph + - /code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Dependency graph - Dependencies - Repositories shortTitle: Configure dependency graph +contentType: how-tos --- ## About the dependency graph diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/exploring-the-dependencies-of-a-repository.md similarity index 95% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/exploring-the-dependencies-of-a-repository.md index b2c2142a91e4..dbebfff94d28 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/exploring-the-dependencies-of-a-repository.md @@ -1,6 +1,6 @@ --- title: Exploring the dependencies of a repository -intro: 'You can use the dependency graph to see the packages your project depends on{% ifversion fpt or ghec %} and the repositories that depend on it{% endif %}. In addition, you can see any vulnerabilities detected in its dependencies.' +intro: You can use the dependency graph to see the packages your project depends on{% ifversion fpt or ghec %} and the repositories that depend on it{% endif %}. In addition, you can see any vulnerabilities detected in its dependencies. permissions: '{% data reusables.permissions.dependency-graph-view-dependencies %}' redirect_from: - /articles/listing-the-packages-that-a-repository-depends-on @@ -10,16 +10,17 @@ redirect_from: - /github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository - /github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository - /code-security/supply-chain-security/exploring-the-dependencies-of-a-repository + - /code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Dependency graph - Dependencies - Repositories shortTitle: Explore dependencies +contentType: how-tos --- ## Viewing the dependency graph diff --git a/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/index.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/index.md new file mode 100644 index 000000000000..0750629c9434 --- /dev/null +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/index.md @@ -0,0 +1,21 @@ +--- +title: Securing your dependencies +shortTitle: Secure your dependencies +intro: Keep your supply chain secure by understanding and updating dependencies. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +children: + - /configuring-dependabot-alerts + - /configuring-dependabot-security-updates + - /configuring-dependabot-version-updates + - /keeping-your-actions-up-to-date-with-dependabot + - /configuring-the-dependency-graph + - /exploring-the-dependencies-of-a-repository + - /configuring-automatic-dependency-submission-for-your-repository + - /using-the-dependency-submission-api + - /verifying-the-integrity-of-a-release +--- + diff --git a/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/keeping-your-actions-up-to-date-with-dependabot.md similarity index 95% rename from content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/keeping-your-actions-up-to-date-with-dependabot.md index ee3124491815..077e437603ff 100644 --- a/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/keeping-your-actions-up-to-date-with-dependabot.md @@ -1,23 +1,24 @@ --- title: Keeping your actions up to date with Dependabot -intro: 'You can use {% data variables.product.prodname_dependabot %} to keep the actions you use updated to the latest versions.' +intro: You can use {% data variables.product.prodname_dependabot %} to keep the actions you use updated to the latest versions. permissions: '{% data reusables.permissions.dependabot-yml-configure %}' redirect_from: - /github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot - /github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot - /code-security/supply-chain-security/keeping-your-actions-up-to-date-with-dependabot - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot + - /code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Repositories - Dependabot - Version updates - Actions shortTitle: Auto-update actions +contentType: how-tos --- {% data reusables.dependabot.enterprise-enable-dependabot %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/using-the-dependency-submission-api.md similarity index 92% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/using-the-dependency-submission-api.md index 26f89c77c7a0..e56724961988 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/using-the-dependency-submission-api.md @@ -1,7 +1,7 @@ --- title: Using the dependency submission API -intro: 'You can use the {% data variables.dependency-submission-api.name %} to submit dependencies for projects, such as the dependencies resolved when a project is built or compiled.' -shortTitle: Dependency submission API +intro: You can use the {% data variables.dependency-submission-api.name %} to submit dependencies for projects, such as the dependencies resolved when a project is built or compiled. +shortTitle: Use dependency submission API topics: - API - Dependency graph @@ -11,6 +11,9 @@ versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api +contentType: how-tos --- ## About the {% data variables.dependency-submission-api.name %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/verifying-the-integrity-of-a-release.md b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/verifying-the-integrity-of-a-release.md similarity index 82% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/verifying-the-integrity-of-a-release.md rename to content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/verifying-the-integrity-of-a-release.md index 5887986a03c8..b7d262063d6e 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/verifying-the-integrity-of-a-release.md +++ b/content/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/verifying-the-integrity-of-a-release.md @@ -1,16 +1,18 @@ --- title: Verifying the integrity of a release shortTitle: Verify release integrity -intro: 'You can avoid tampering and accidental changes by ensuring the releases you use have not been modified after publication.' +intro: You can avoid tampering and accidental changes by ensuring the releases you use have not been modified after publication. versions: fpt: '*' ghec: '*' -type: overview topics: - Code Security - Vulnerabilities - Dependencies defaultTool: cli +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/verifying-the-integrity-of-a-release +contentType: how-tos --- {% cli %} diff --git a/content/code-security/dependabot/troubleshooting-dependabot/dependabot-updates-stopped.md b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/dependabot-updates-stopped.md similarity index 97% rename from content/code-security/dependabot/troubleshooting-dependabot/dependabot-updates-stopped.md rename to content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/dependabot-updates-stopped.md index 3216e814f667..5cdcf952785d 100644 --- a/content/code-security/dependabot/troubleshooting-dependabot/dependabot-updates-stopped.md +++ b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/dependabot-updates-stopped.md @@ -7,7 +7,6 @@ versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Version updates @@ -15,6 +14,9 @@ topics: - Dependencies - Pull requests shortTitle: Dependabot stopped working +redirect_from: + - /code-security/dependabot/troubleshooting-dependabot/dependabot-updates-stopped +contentType: how-tos --- * When maintainers of a repository stop interacting with {% data variables.product.prodname_dependabot %} pull requests, {% data variables.product.prodname_dependabot %} temporarily pauses its updates and lets you know. diff --git a/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/index.md b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/index.md new file mode 100644 index 000000000000..33fa574ccee1 --- /dev/null +++ b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/index.md @@ -0,0 +1,18 @@ +--- +title: Troubleshooting dependency security +shortTitle: Troubleshoot dependency security +intro: Get help with Dependabot and dependency detection. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos +redirect_from: + - /code-security/dependabot/troubleshooting-dependabot +children: + - /troubleshooting-dependabot-errors + - /troubleshooting-the-detection-of-vulnerable-dependencies + - /dependabot-updates-stopped + - /troubleshooting-the-dependency-graph + - /troubleshooting-dependabot-on-github-actions +--- diff --git a/content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-errors.md b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-dependabot-errors.md similarity index 98% rename from content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-errors.md rename to content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-dependabot-errors.md index d550a5f5a164..5d328a71e207 100644 --- a/content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-errors.md +++ b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-dependabot-errors.md @@ -1,18 +1,18 @@ --- title: Troubleshooting Dependabot errors -intro: 'Sometimes {% data variables.product.prodname_dependabot %} is unable to raise a pull request to update your dependencies. You can review the error and unblock {% data variables.product.prodname_dependabot %}.' -shortTitle: Troubleshoot errors +intro: Sometimes {% data variables.product.prodname_dependabot %} is unable to raise a pull request to update your dependencies. You can review the error and unblock {% data variables.product.prodname_dependabot %}. +shortTitle: Troubleshoot Dependabot errors redirect_from: - /github/managing-security-vulnerabilities/troubleshooting-github-dependabot-errors - /github/managing-security-vulnerabilities/troubleshooting-dependabot-errors - /code-security/supply-chain-security/troubleshooting-dependabot-errors - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-dependabot-errors - /code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors + - /code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-errors versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Dependabot - Security updates @@ -22,6 +22,7 @@ topics: - Troubleshooting - Errors - Dependencies +contentType: how-tos --- {% data reusables.dependabot.enterprise-enable-dependabot %} diff --git a/content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-on-github-actions.md b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-dependabot-on-github-actions.md similarity index 94% rename from content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-on-github-actions.md rename to content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-dependabot-on-github-actions.md index f67bc94e67cd..6aba778bc07a 100644 --- a/content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-on-github-actions.md +++ b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-dependabot-on-github-actions.md @@ -1,11 +1,10 @@ --- title: Troubleshooting Dependabot on GitHub Actions -intro: 'This article provides troubleshooting information for issues you may encounter when using {% data variables.product.prodname_dependabot %} with {% data variables.product.prodname_actions %}.' +intro: This article provides troubleshooting information for issues you may encounter when using {% data variables.product.prodname_dependabot %} with {% data variables.product.prodname_actions %}. versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Actions - Dependabot @@ -17,6 +16,8 @@ topics: shortTitle: Troubleshoot Dependabot on Actions redirect_from: - /code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-on-github-actions + - /code-security/dependabot/troubleshooting-dependabot/troubleshooting-dependabot-on-github-actions +contentType: how-tos --- ## Restrictions when {% data variables.product.prodname_dependabot %} triggers events diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-dependency-graph.md similarity index 95% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md rename to content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-dependency-graph.md index a5fdd408a8d5..5c72f7f6f521 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph.md +++ b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-dependency-graph.md @@ -1,13 +1,12 @@ --- title: Troubleshooting the dependency graph -intro: 'If the dependency information reported by the dependency graph is not what you expected, there are a number of points to consider, and various things you can check.' +intro: If the dependency information reported by the dependency graph is not what you expected, there are a number of points to consider, and various things you can check. product: '{% data reusables.gated-features.dependency-graph %}' shortTitle: Troubleshoot dependency graph versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Troubleshooting - Errors @@ -16,6 +15,9 @@ topics: - Dependency graph - CVEs - Repositories +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph +contentType: how-tos --- {% data reusables.dependabot.result-discrepancy %} diff --git a/content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-detection-of-vulnerable-dependencies.md similarity index 97% rename from content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md rename to content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-detection-of-vulnerable-dependencies.md index 50434476a6d6..07c70763710d 100644 --- a/content/code-security/dependabot/troubleshooting-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies.md +++ b/content/code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-detection-of-vulnerable-dependencies.md @@ -1,17 +1,17 @@ --- title: Troubleshooting the detection of vulnerable dependencies -intro: 'If the dependency information reported by {% data variables.product.github %} is not what you expected, there are a number of points to consider, and various things you can check.' +intro: If the dependency information reported by {% data variables.product.github %} is not what you expected, there are a number of points to consider, and various things you can check. shortTitle: Troubleshoot vulnerability detection redirect_from: - /github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies - /code-security/supply-chain-security/troubleshooting-the-detection-of-vulnerable-dependencies - /code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies - /code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies + - /code-security/dependabot/troubleshooting-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Dependabot - Alerts @@ -22,6 +22,7 @@ topics: - Vulnerabilities - CVEs - Repositories +contentType: how-tos --- {% data reusables.dependabot.result-discrepancy %} diff --git a/content/code-security/security-overview/assessing-adoption-code-security.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-adoption-code-security.md similarity index 97% rename from content/code-security/security-overview/assessing-adoption-code-security.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-adoption-code-security.md index 867163efde4f..fc4863cbf81f 100644 --- a/content/code-security/security-overview/assessing-adoption-code-security.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-adoption-code-security.md @@ -2,21 +2,23 @@ title: Assessing adoption of security features shortTitle: Assess adoption of features allowTitleToDifferFromFilename: true -intro: 'You can use security overview to see which teams and repositories have already enabled features for secure coding, and identify any that are not yet protected.' +intro: You can use security overview to see which teams and repositories have already enabled features for secure coding, and identify any that are not yet protected. permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-both %}' -type: how_to +contentType: how-tos topics: - Security overview - Code Security - Secret Protection - - 'Set up' + - Set up - Organizations - Teams versions: fpt: '*' ghes: '*' ghec: '*' +redirect_from: + - /code-security/security-overview/assessing-adoption-code-security --- ## About adoption of features for secure coding diff --git a/content/code-security/security-overview/assessing-code-security-risk.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-code-security-risk.md similarity index 95% rename from content/code-security/security-overview/assessing-code-security-risk.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-code-security-risk.md index e2805636faed..afb9227b0f1c 100644 --- a/content/code-security/security-overview/assessing-code-security-risk.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/assessing-code-security-risk.md @@ -2,10 +2,10 @@ title: Assessing the security risk of your code shortTitle: Assess security risk of code allowTitleToDifferFromFilename: true -intro: 'You can use security overview to see which teams and repositories are affected by security alerts, and identify repositories for urgent remedial action.' +intro: You can use security overview to see which teams and repositories are affected by security alerts, and identify repositories for urgent remedial action. permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-both %}' -type: how_to +contentType: how-tos topics: - Security overview - Code Security @@ -19,6 +19,7 @@ versions: ghec: '*' redirect_from: - /code-security/security-overview/viewing-the-security-overview + - /code-security/security-overview/assessing-code-security-risk --- ## Exploring the security risks in your code diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/export-risk-report-csv.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/export-risk-report-csv.md similarity index 69% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/export-risk-report-csv.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/export-risk-report-csv.md index 6fdf4356f217..cf18b50e2513 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/export-risk-report-csv.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/export-risk-report-csv.md @@ -1,10 +1,10 @@ --- -title: 'Exporting the secret risk assessment report to CSV' -shortTitle: 'Export risk report CSV' -intro: 'Export the {% data variables.product.prodname_secret_risk_assessment %} report to a CSV file for detailed investigation and stakeholder sharing.' +title: Exporting the secret risk assessment report to CSV +shortTitle: Export risk report CSV +intro: Export the {% data variables.product.prodname_secret_risk_assessment %} report to a CSV file for detailed investigation and stakeholder sharing. product: '{% data reusables.gated-features.secret-risk-assessment-report %}' permissions: '{% data reusables.permissions.secret-risk-assessment-report-generation %}' -type: how_to +contentType: how-tos versions: feature: secret-risk-assessment topics: @@ -13,6 +13,8 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/export-risk-report-csv --- {% data reusables.organizations.navigate-to-org %} diff --git a/content/code-security/security-overview/exporting-data-from-security-overview.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/exporting-data-from-security-overview.md similarity index 97% rename from content/code-security/security-overview/exporting-data-from-security-overview.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/exporting-data-from-security-overview.md index 3f38f6ab060d..637a3ea53481 100644 --- a/content/code-security/security-overview/exporting-data-from-security-overview.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/exporting-data-from-security-overview.md @@ -6,7 +6,7 @@ permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-both %}' versions: feature: security-overview-export-data -type: how_to +contentType: how-tos topics: - Security overview - Code Security @@ -16,6 +16,7 @@ topics: - Teams redirect_from: - /code-security/security-overview/exporting-data-from-the-risk-and-coverage-pages + - /code-security/security-overview/exporting-data-from-security-overview --- ## About exporting your security overview data diff --git a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/index.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/index.md new file mode 100644 index 000000000000..ec244d0d4b17 --- /dev/null +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/index.md @@ -0,0 +1,28 @@ +--- +title: How-tos for analyzing security data for an organization +shortTitle: Analyze organization data +intro: Learn how to assess security risks, track feature adoption, view key metrics, and export data to analyze your organization’s security posture. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: how-tos +children: + - /assessing-code-security-risk + - /assessing-adoption-code-security + - /exporting-data-from-security-overview + - /viewing-security-insights + - /interpreting-security-findings + - /viewing-metrics-for-pull-request-alerts + - /viewing-metrics-for-secret-scanning-push-protection + - /viewing-metrics-for-dependabot-alerts + - /export-risk-report-csv +--- diff --git a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/interpreting-security-findings.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/interpreting-security-findings.md similarity index 95% rename from content/code-security/securing-your-organization/managing-the-security-of-your-organization/interpreting-security-findings.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/interpreting-security-findings.md index 7560ffd3b5a6..a40840b536b2 100644 --- a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/interpreting-security-findings.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/interpreting-security-findings.md @@ -1,7 +1,7 @@ --- title: Interpreting security findings shortTitle: Interpret security data -intro: 'You can analyze security data on repositories in your organization to determine if you need to make changes to your security setup.' +intro: You can analyze security data on repositories in your organization to determine if you need to make changes to your security setup. permissions: '{% data reusables.permissions.security-org-enable %}' versions: feature: security-configurations @@ -10,8 +10,11 @@ topics: - Secret Protection - Organizations - Security +contentType: how-tos redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/interpreting-security-findings-on-a-repository + - /code-security/securing-your-organization/managing-the-security-of-your-organization/interpreting-security-findings + - /code-security/securing-your-organization/managing-the-security-of-your-organization --- ## About security findings diff --git a/content/code-security/security-overview/viewing-metrics-for-dependabot-alerts.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-dependabot-alerts.md similarity index 93% rename from content/code-security/security-overview/viewing-metrics-for-dependabot-alerts.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-dependabot-alerts.md index f191c65b111d..0ea54626ec84 100644 --- a/content/code-security/security-overview/viewing-metrics-for-dependabot-alerts.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-dependabot-alerts.md @@ -2,12 +2,12 @@ title: Viewing metrics for Dependabot alerts shortTitle: View Dependabot metrics allowTitleToDifferFromFilename: true -intro: 'You can use security overview to see how many {% data variables.product.prodname_dependabot_alerts %} are in repositories across your organization, to prioritize the most critical alerts to fix, and to identify repositories where you may need to take action.' +intro: You can use security overview to see how many {% data variables.product.prodname_dependabot_alerts %} are in repositories across your organization, to prioritize the most critical alerts to fix, and to identify repositories where you may need to take action. versions: feature: dependabot-metrics permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-cs-only %}' -type: how_to +contentType: how-tos topics: - Security overview - Code Security @@ -15,6 +15,8 @@ topics: - Organizations - Alerts - Vulnerabilities +redirect_from: + - /code-security/security-overview/viewing-metrics-for-dependabot-alerts --- ## About metrics for {% data variables.product.prodname_dependabot %} diff --git a/content/code-security/security-overview/viewing-metrics-for-pull-request-alerts.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-pull-request-alerts.md similarity index 94% rename from content/code-security/security-overview/viewing-metrics-for-pull-request-alerts.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-pull-request-alerts.md index 916a7df066f3..87b223d04f30 100644 --- a/content/code-security/security-overview/viewing-metrics-for-pull-request-alerts.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-pull-request-alerts.md @@ -2,10 +2,10 @@ title: Viewing metrics for pull request alerts shortTitle: View PR alert metrics allowTitleToDifferFromFilename: true -intro: 'You can use security overview to see how {% data variables.product.prodname_codeql %} is performing in pull requests for repositories across your organizations, and to identify repositories where you may need to take action.' +intro: You can use security overview to see how {% data variables.product.prodname_codeql %} is performing in pull requests for repositories across your organizations, and to identify repositories where you may need to take action. permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-cs-only %}' -type: how_to +contentType: how-tos topics: - Security overview - Code Security @@ -15,6 +15,8 @@ topics: - Teams versions: feature: security-overview-org-codeql-pr-alerts +redirect_from: + - /code-security/security-overview/viewing-metrics-for-pull-request-alerts --- ## About {% data variables.product.prodname_codeql %} pull request alerts metrics diff --git a/content/code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-secret-scanning-push-protection.md similarity index 88% rename from content/code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-secret-scanning-push-protection.md index 1cc74d226429..f5f913549f23 100644 --- a/content/code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-metrics-for-secret-scanning-push-protection.md @@ -2,12 +2,13 @@ title: Viewing metrics for secret scanning push protection shortTitle: View secret scanning metrics allowTitleToDifferFromFilename: true -intro: 'You can use security overview to see how {% data variables.product.prodname_secret_scanning %} push protection is performing in repositories across your organization{% ifversion security-overview-enterprise-secret-scanning-metrics %} or enterprise{% endif %}, and to identify repositories where you may need to take action.' +intro: You can use security overview to see how {% data variables.product.prodname_secret_scanning %} push protection is performing in repositories across your organization{% ifversion security-overview-enterprise-secret-scanning-metrics %} or enterprise{% endif %}, and to identify repositories where you may need to take action. permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-sp-only %}' -type: how_to +contentType: how-tos redirect_from: -- /code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection-in-your-organization + - /code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection-in-your-organization + - /code-security/security-overview/viewing-metrics-for-secret-scanning-push-protection topics: - Security overview - Secret Protection diff --git a/content/code-security/security-overview/viewing-security-insights.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-security-insights.md similarity index 98% rename from content/code-security/security-overview/viewing-security-insights.md rename to content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-security-insights.md index ab7259b56066..b782e1812e5f 100644 --- a/content/code-security/security-overview/viewing-security-insights.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/viewing-security-insights.md @@ -1,14 +1,14 @@ --- title: Viewing security insights shortTitle: View security insights -intro: 'You can use the overview dashboard in security overview to monitor the security landscape of the repositories in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %}.' +intro: You can use the overview dashboard in security overview to monitor the security landscape of the repositories in your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %}. permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-both %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Security overview - Code Security @@ -17,11 +17,10 @@ topics: - Organizations redirect_from: - /code-security/security-overview/viewing-security-insights-for-your-organization + - /code-security/security-overview/viewing-security-insights allowTitleToDifferFromFilename: true --- - - ## {% ifversion security-overview-dashboard-enterprise %}About security insights{% else %} About organization-level security insights{% endif %} The overview page in security overview is a consolidated dashboard of insights about your organization{% ifversion security-overview-dashboard-enterprise %} or enterprise{% endif %}'s security landscape and progress. You can use the dashboard to monitor the health of your application security program, collaborate with engineering teams, and gather data for benchmarking purposes. diff --git a/content/code-security/how-tos/view-and-interpret-data/index.md b/content/code-security/how-tos/view-and-interpret-data/index.md new file mode 100644 index 000000000000..c4b314c4dae1 --- /dev/null +++ b/content/code-security/how-tos/view-and-interpret-data/index.md @@ -0,0 +1,23 @@ +--- +title: How-tos for viewing and interpreting security results +shortTitle: View and interpret data +intro: Discover how to analyze organization-level security data, interpret key insights and metrics, and export reports to assess your security posture. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: how-tos +children: + - /analyze-organization-data + - /viewing-code-scanning-logs + - /viewing-dependabot-job-logs + - /metrics-for-custom-patterns +--- diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns.md b/content/code-security/how-tos/view-and-interpret-data/metrics-for-custom-patterns.md similarity index 75% rename from content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns.md rename to content/code-security/how-tos/view-and-interpret-data/metrics-for-custom-patterns.md index b7d9b3db32b5..1a210b8ee2dc 100644 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns.md +++ b/content/code-security/how-tos/view-and-interpret-data/metrics-for-custom-patterns.md @@ -1,16 +1,18 @@ --- title: Metrics for custom patterns shortTitle: Custom pattern metrics -intro: 'You can view alert metrics for custom patterns at the repository, organization, and enterprise levels.' +intro: You can view alert metrics for custom patterns at the repository, organization, and enterprise levels. permissions: '{% data reusables.permissions.security-enterprise-enable %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Secret Protection - Secret scanning +redirect_from: + - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/metrics-for-custom-patterns --- ## Metrics for custom patterns diff --git a/content/code-security/code-scanning/managing-your-code-scanning-configuration/viewing-code-scanning-logs.md b/content/code-security/how-tos/view-and-interpret-data/viewing-code-scanning-logs.md similarity index 96% rename from content/code-security/code-scanning/managing-your-code-scanning-configuration/viewing-code-scanning-logs.md rename to content/code-security/how-tos/view-and-interpret-data/viewing-code-scanning-logs.md index 8b480bb91ae8..0a2b866a9813 100644 --- a/content/code-security/code-scanning/managing-your-code-scanning-configuration/viewing-code-scanning-logs.md +++ b/content/code-security/how-tos/view-and-interpret-data/viewing-code-scanning-logs.md @@ -1,14 +1,16 @@ --- title: Viewing code scanning logs -intro: 'You can view the output generated during {% data variables.product.prodname_code_scanning %} analysis in {% data variables.product.github %}.' +intro: You can view the output generated during {% data variables.product.prodname_code_scanning %} analysis in {% data variables.product.github %}. permissions: '{% data reusables.permissions.code-scanning-pr-alerts %}' redirect_from: - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/viewing-code-scanning-logs + - /code-security/code-scanning/managing-your-code-scanning-configuration/viewing-code-scanning-logs versions: fpt: '*' ghes: '*' ghec: '*' +contentType: how-tos topics: - Security shortTitle: View code scanning logs diff --git a/content/code-security/dependabot/troubleshooting-dependabot/viewing-dependabot-job-logs.md b/content/code-security/how-tos/view-and-interpret-data/viewing-dependabot-job-logs.md similarity index 88% rename from content/code-security/dependabot/troubleshooting-dependabot/viewing-dependabot-job-logs.md rename to content/code-security/how-tos/view-and-interpret-data/viewing-dependabot-job-logs.md index 746f75288cd6..f3a236012e4a 100644 --- a/content/code-security/dependabot/troubleshooting-dependabot/viewing-dependabot-job-logs.md +++ b/content/code-security/how-tos/view-and-interpret-data/viewing-dependabot-job-logs.md @@ -1,13 +1,13 @@ --- title: Viewing Dependabot job logs -intro: 'To support debugging of {% data variables.product.prodname_dependabot %} pull requests, {% data variables.product.github %} provides logs of all {% data variables.product.prodname_dependabot %} jobs.' -shortTitle: Viewing Dependabot logs +intro: To support debugging of {% data variables.product.prodname_dependabot %} pull requests, {% data variables.product.github %} provides logs of all {% data variables.product.prodname_dependabot %} jobs. +shortTitle: View Dependabot logs permissions: '{% data reusables.permissions.dependabot-various-tasks %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: how-tos topics: - Dependabot - Troubleshooting @@ -16,6 +16,7 @@ topics: - Dependencies redirect_from: - /code-security/dependabot/working-with-dependabot/viewing-dependabot-job-logs + - /code-security/dependabot/troubleshooting-dependabot/viewing-dependabot-job-logs --- ## About {% data variables.product.prodname_dependabot %} job logs diff --git a/content/code-security/index.md b/content/code-security/index.md index d0f9a312a93a..7c210cca6ec0 100644 --- a/content/code-security/index.md +++ b/content/code-security/index.md @@ -1,32 +1,32 @@ --- title: Security and code quality documentation shortTitle: Security and code quality -intro: 'Build security and code quality into your {% data variables.product.github %} workflow to secure your software supply chain, prevent data leaks, and automatically find and fix vulnerabilities and code health issues in your codebase.' +intro: Build security and code quality into your {% data variables.product.github %} workflow to secure your software supply chain, prevent data leaks, and automatically find and fix vulnerabilities and code health issues in your codebase. redirect_from: - /code-security/guides introLinks: overview: '{% ifversion ghes %}/code-security/getting-started/github-security-features{% endif %}' - generate_secret_risk_assessment_report_for_free: '{% ifversion secret-risk-assessment %}/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/assess-your-secret-risk{% endif %}' + generate_secret_risk_assessment_report_for_free: '{% ifversion secret-risk-assessment %}/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-secret-risk{% endif %}' featuredLinks: - startHere: # Links aimed at the builder audience + startHere: - '{% ifversion fpt or ghec %}/code-security/getting-started/github-security-features{% endif %}' - /code-security/getting-started/quickstart-for-securing-your-repository - '{% ifversion ghes %}/code-security/secret-scanning/working-with-secret-scanning-and-push-protection{% endif %}' - - /code-security/getting-started/dependabot-quickstart-guide - - /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning + - /code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide + - /code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning guideCards: - /code-security/trialing-github-advanced-security/planning-a-trial-of-ghas - /code-security/secret-scanning/enabling-secret-scanning-features - - /code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning - - /code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates - - /code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates - popular: # Links aimed at the driver audience + - /code-security/how-tos/scan-code-for-vulnerabilities/configure-code-scanning/configuring-default-setup-for-code-scanning + - /code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates + - /code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-version-updates + popular: - '{% ifversion secret-risk-assessment %}/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/about-secret-risk-assessment{% endif %}' - '{% ifversion ghes %}/admin/release-notes{% endif %}' - - /code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/about-coordinated-disclosure-of-security-vulnerabilities - - /code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization - - /code-security/securing-your-organization/fixing-security-alerts-at-scale/best-practice-fix-alerts-at-scale - - /code-security/dependabot/maintain-dependencies/best-practices-for-maintaining-dependencies + - /code-security/concepts/vulnerability-reporting-and-management/about-coordinated-disclosure-of-security-vulnerabilities + - /code-security/tutorials/secure-your-organization/best-practices-for-preventing-data-leaks-in-your-organization + - /code-security/tutorials/secure-your-organization/best-practice-fix-alerts-at-scale + - /code-security/concepts/supply-chain-security/best-practices-for-maintaining-dependencies changelog: label: security-and-compliance versions: @@ -43,16 +43,9 @@ topics: - Vulnerabilities children: - /getting-started - - /trialing-github-advanced-security - - /code-quality - - /adopting-github-advanced-security-at-scale - - /securing-your-organization - - /secret-scanning - - /code-scanning - - /codeql-cli - - /codeql-for-vs-code - - /security-advisories - - /supply-chain-security - - /dependabot - - /security-overview + - /concepts + - /how-tos + - /reference + - /tutorials + - /responsible-use --- diff --git a/content/code-security/code-quality/reference/codeql-detection.md b/content/code-security/reference/code-quality/codeql-detection.md similarity index 93% rename from content/code-security/code-quality/reference/codeql-detection.md rename to content/code-security/reference/code-quality/codeql-detection.md index 96158faa6090..c9ad3305c015 100644 --- a/content/code-security/code-quality/reference/codeql-detection.md +++ b/content/code-security/reference/code-quality/codeql-detection.md @@ -2,12 +2,14 @@ title: CodeQL-powered analysis for Code Quality shortTitle: CodeQL analysis allowTitleToDifferFromFilename: true -intro: 'Information on how CodeQL-powered analysis for {% data variables.product.prodname_code_quality_short %} works, the workflow used, and the status checks reported on pull requests.' +intro: Information on how CodeQL-powered analysis for {% data variables.product.prodname_code_quality_short %} works, the workflow used, and the status checks reported on pull requests. versions: feature: code-quality topics: - Code Quality contentType: reference +redirect_from: + - /code-security/code-quality/reference/codeql-detection --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/code-quality/reference/codeql-queries/csharp-queries.md b/content/code-security/reference/code-quality/codeql-queries/csharp-queries.md similarity index 72% rename from content/code-security/code-quality/reference/codeql-queries/csharp-queries.md rename to content/code-security/reference/code-quality/codeql-queries/csharp-queries.md index 386f44e61bf7..aabf3f1d2a68 100644 --- a/content/code-security/code-quality/reference/codeql-queries/csharp-queries.md +++ b/content/code-security/reference/code-quality/codeql-queries/csharp-queries.md @@ -2,12 +2,14 @@ title: C# CodeQL queries for Code Quality shortTitle: C# queries allowTitleToDifferFromFilename: true -intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in C#.' +intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in C#. versions: feature: code-quality topics: - Code Quality contentType: reference +redirect_from: + - /code-security/code-quality/reference/codeql-queries/csharp-queries --- {% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze C# code and detect code quality issues on: @@ -17,4 +19,4 @@ contentType: reference {% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible. -{% data reusables.code-quality.codeql-query-tables.csharp %} \ No newline at end of file +{% data reusables.code-quality.codeql-query-tables.csharp %} diff --git a/content/code-security/code-quality/reference/codeql-queries/go-queries.md b/content/code-security/reference/code-quality/codeql-queries/go-queries.md similarity index 71% rename from content/code-security/code-quality/reference/codeql-queries/go-queries.md rename to content/code-security/reference/code-quality/codeql-queries/go-queries.md index fd142d09ab4f..2a55e49ec8db 100644 --- a/content/code-security/code-quality/reference/codeql-queries/go-queries.md +++ b/content/code-security/reference/code-quality/codeql-queries/go-queries.md @@ -1,12 +1,14 @@ --- title: Go CodeQL queries for Code Quality shortTitle: Go queries -intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Go.' +intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Go. versions: feature: code-quality topics: - Code Quality contentType: reference +redirect_from: + - /code-security/code-quality/reference/codeql-queries/go-queries --- {% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze Go code and detect code quality issues on: @@ -16,4 +18,4 @@ contentType: reference {% data variables.copilot.copilot_autofix_short %} suggestions are provided for findings where possible. -{% data reusables.code-quality.codeql-query-tables.go %} \ No newline at end of file +{% data reusables.code-quality.codeql-query-tables.go %} diff --git a/content/code-security/reference/code-quality/codeql-queries/index.md b/content/code-security/reference/code-quality/codeql-queries/index.md new file mode 100644 index 000000000000..1e7d580b04f6 --- /dev/null +++ b/content/code-security/reference/code-quality/codeql-queries/index.md @@ -0,0 +1,23 @@ +--- +title: Reference for CodeQL queries +shortTitle: CodeQL queries +intro: Find lists of CodeQL queries used by {% data variables.product.prodname_code_quality_short %} for each supported programming language. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Code scanning + - Vulnerabilities +contentType: reference +children: + - /csharp-queries + - /go-queries + - /java-queries + - /javascript-queries + - /python-queries + - /ruby-queries +redirect_from: + - /code-security/code-quality/reference/codeql-queries +--- diff --git a/content/code-security/code-quality/reference/codeql-queries/java-queries.md b/content/code-security/reference/code-quality/codeql-queries/java-queries.md similarity index 78% rename from content/code-security/code-quality/reference/codeql-queries/java-queries.md rename to content/code-security/reference/code-quality/codeql-queries/java-queries.md index d0fe33c5d229..fbc834d87df7 100644 --- a/content/code-security/code-quality/reference/codeql-queries/java-queries.md +++ b/content/code-security/reference/code-quality/codeql-queries/java-queries.md @@ -2,12 +2,14 @@ title: Java CodeQL queries for Code Quality shortTitle: Java queries allowTitleToDifferFromFilename: true -intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Java.' +intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Java. versions: feature: code-quality topics: - Code Quality contentType: reference +redirect_from: + - /code-security/code-quality/reference/codeql-queries/java-queries --- {% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze Java code and detect code quality issues on: diff --git a/content/code-security/code-quality/reference/codeql-queries/javascript-queries.md b/content/code-security/reference/code-quality/codeql-queries/javascript-queries.md similarity index 77% rename from content/code-security/code-quality/reference/codeql-queries/javascript-queries.md rename to content/code-security/reference/code-quality/codeql-queries/javascript-queries.md index 1ca4e49cddb8..6c291bf53959 100644 --- a/content/code-security/code-quality/reference/codeql-queries/javascript-queries.md +++ b/content/code-security/reference/code-quality/codeql-queries/javascript-queries.md @@ -2,12 +2,14 @@ title: JavaScript CodeQL queries for Code Quality shortTitle: JavaScript queries allowTitleToDifferFromFilename: true -intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in JavaScript.' +intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in JavaScript. versions: feature: code-quality topics: - Code Quality contentType: reference +redirect_from: + - /code-security/code-quality/reference/codeql-queries/javascript-queries --- {% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze JavaScript code and detect code quality issues on: diff --git a/content/code-security/code-quality/reference/codeql-queries/python-queries.md b/content/code-security/reference/code-quality/codeql-queries/python-queries.md similarity index 78% rename from content/code-security/code-quality/reference/codeql-queries/python-queries.md rename to content/code-security/reference/code-quality/codeql-queries/python-queries.md index 24784bf558d0..d5f3c48a7d79 100644 --- a/content/code-security/code-quality/reference/codeql-queries/python-queries.md +++ b/content/code-security/reference/code-quality/codeql-queries/python-queries.md @@ -2,12 +2,14 @@ title: Python CodeQL queries for Code Quality shortTitle: Python queries allowTitleToDifferFromFilename: true -intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Python.' +intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Python. versions: feature: code-quality topics: - Code Quality contentType: reference +redirect_from: + - /code-security/code-quality/reference/codeql-queries/python-queries --- {% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze Python code and detect code quality issues on: diff --git a/content/code-security/code-quality/reference/codeql-queries/ruby-queries.md b/content/code-security/reference/code-quality/codeql-queries/ruby-queries.md similarity index 78% rename from content/code-security/code-quality/reference/codeql-queries/ruby-queries.md rename to content/code-security/reference/code-quality/codeql-queries/ruby-queries.md index 79417da34057..776145737d5d 100644 --- a/content/code-security/code-quality/reference/codeql-queries/ruby-queries.md +++ b/content/code-security/reference/code-quality/codeql-queries/ruby-queries.md @@ -2,12 +2,14 @@ title: Ruby CodeQL queries for Code Quality shortTitle: Ruby queries allowTitleToDifferFromFilename: true -intro: 'Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Ruby.' +intro: Explore the queries that {% data variables.product.prodname_codeql %} uses to analyze code quality for code written in Ruby. versions: feature: code-quality topics: - Code Quality contentType: reference +redirect_from: + - /code-security/code-quality/reference/codeql-queries/ruby-queries --- {% data variables.product.prodname_code_quality_short %} uses the following {% data variables.product.prodname_codeql %} queries to analyze Ruby code and detect code quality issues on: diff --git a/content/code-security/reference/code-quality/index.md b/content/code-security/reference/code-quality/index.md new file mode 100644 index 000000000000..260392750b33 --- /dev/null +++ b/content/code-security/reference/code-quality/index.md @@ -0,0 +1,18 @@ +--- +title: Reference for code quality +shortTitle: Code quality +intro: Find reference documentation for {% data variables.product.prodname_code_quality_short %}. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Quality +contentType: reference +children: + - /metrics-and-ratings + - /codeql-detection + - /codeql-queries +redirect_from: + - /code-security/code-quality/reference +--- diff --git a/content/code-security/code-quality/reference/metrics-and-ratings.md b/content/code-security/reference/code-quality/metrics-and-ratings.md similarity index 94% rename from content/code-security/code-quality/reference/metrics-and-ratings.md rename to content/code-security/reference/code-quality/metrics-and-ratings.md index 51d99a9b330e..b23559073ea5 100644 --- a/content/code-security/code-quality/reference/metrics-and-ratings.md +++ b/content/code-security/reference/code-quality/metrics-and-ratings.md @@ -1,12 +1,14 @@ --- title: Metrics and ratings reference shortTitle: Metrics and ratings -intro: 'Understand the terminology used by {% data variables.product.github %} to assess the quality of your repository''s code.' +intro: Understand the terminology used by {% data variables.product.github %} to assess the quality of your repository's code. versions: feature: code-quality topics: - Code Quality contentType: reference +redirect_from: + - /code-security/code-quality/reference/metrics-and-ratings --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode.md index 091913b27998..d4ccd0be4a9c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Convert result data from BQRS into other forms. redirect_from: - /code-security/codeql-cli/manual/bqrs-decode + - /code-security/codeql-cli/codeql-cli-manual/bqrs-decode +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-diff.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-diff.md index 25361e2b952d..19c0ca06c991 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-diff.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-diff.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Compute the difference between two result sets. redirect_from: - /code-security/codeql-cli/manual/bqrs-diff + - /code-security/codeql-cli/codeql-cli-manual/bqrs-diff +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-hash.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-hash.md index 7624f3eb664e..39afe899b05d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-hash.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-hash.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Compute a stable hash of a BQRS file.' redirect_from: - /code-security/codeql-cli/manual/bqrs-hash + - /code-security/codeql-cli/codeql-cli-manual/bqrs-hash +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info.md index 5e3a997d37d7..1092d174b55a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Display metadata for a BQRS file. redirect_from: - /code-security/codeql-cli/manual/bqrs-info + - /code-security/codeql-cli/codeql-cli-manual/bqrs-info +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret.md index 45f7c46ad674..80b6203b6273 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Interpret data in a single BQRS.' redirect_from: - /code-security/codeql-cli/manual/bqrs-interpret + - /code-security/codeql-cli/codeql-cli-manual/bqrs-interpret +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-add-diagnostic.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-add-diagnostic.md index 3bc1a01adef4..416fcccc422c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-add-diagnostic.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual/database-add-diagnostic + - /code-security/codeql-cli/codeql-cli-manual/database-add-diagnostic +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze.md index 44562d5035ca..1e8328c19e76 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- source code. redirect_from: - /code-security/codeql-cli/manual/database-analyze + - /code-security/codeql-cli/codeql-cli-manual/database-analyze +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-bundle.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-bundle.md index 2d520bd3130d..2fc3129c414d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-bundle.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Create a relocatable archive of a CodeQL database. redirect_from: - /code-security/codeql-cli/manual/database-bundle + - /code-security/codeql-cli/codeql-cli-manual/database-bundle +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup.md index 7eb9659cc56c..cee246fed100 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Compact a CodeQL database on disk. redirect_from: - /code-security/codeql-cli/manual/database-cleanup + - /code-security/codeql-cli/codeql-cli-manual/database-cleanup +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-create.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-create.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-create.md index 7c9119991eb2..94b60ed3040e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-create.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- one of the CodeQL products. redirect_from: - /code-security/codeql-cli/manual/database-create + - /code-security/codeql-cli/codeql-cli-manual/database-create +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-export-diagnostics.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-export-diagnostics.md index aab924d80e9c..c71934957b18 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-export-diagnostics.md @@ -11,11 +11,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual/database-export-diagnostics + - /code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-finalize.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-finalize.md index ae07940d4fdd..459d06dd122a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-finalize.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Final steps in database creation.' redirect_from: - /code-security/codeql-cli/manual/database-finalize + - /code-security/codeql-cli/codeql-cli-manual/database-finalize +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-import.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-import.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/database-import.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-import.md index 1720418a1280..c18db27c9ee5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-import.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-import.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- unfinalized database. redirect_from: - /code-security/codeql-cli/manual/database-import + - /code-security/codeql-cli/codeql-cli-manual/database-import +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-index-files.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-index-files.md index 7d66da5c6d38..46294c8d480e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-index-files.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Index standalone files with a given CodeQL extractor.' redirect_from: - /code-security/codeql-cli/manual/database-index-files + - /code-security/codeql-cli/codeql-cli-manual/database-index-files +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-init.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init.md index a7ac69276878..8d34ad5475e6 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Create an empty CodeQL database.' redirect_from: - /code-security/codeql-cli/manual/database-init + - /code-security/codeql-cli/codeql-cli-manual/database-init +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results.md index 7abb3c8fa5f3..8ecbcd47ec3c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- such as SARIF or CSV. redirect_from: - /code-security/codeql-cli/manual/database-interpret-results + - /code-security/codeql-cli/codeql-cli-manual/database-interpret-results +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-print-baseline.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-print-baseline.md index ee6a2decd9a4..b94f785ba27c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-print-baseline.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Print a summary of the baseline lines of code seen.' redirect_from: - /code-security/codeql-cli/manual/database-print-baseline + - /code-security/codeql-cli/codeql-cli-manual/database-print-baseline +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries.md index d9fc27257274..d072eafc4345 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Run a set of queries together.' redirect_from: - /code-security/codeql-cli/manual/database-run-queries + - /code-security/codeql-cli/codeql-cli-manual/database-run-queries +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-trace-command.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-trace-command.md index 8f90ceb9d32c..61fabf5eb568 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-trace-command.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Run a single command as part of a traced build.' redirect_from: - /code-security/codeql-cli/manual/database-trace-command + - /code-security/codeql-cli/codeql-cli-manual/database-trace-command +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-unbundle.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-unbundle.md index c6101def470d..9e3eae4ace5d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-unbundle.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-unbundle.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Extracts a CodeQL database archive. redirect_from: - /code-security/codeql-cli/manual/database-unbundle + - /code-security/codeql-cli/codeql-cli-manual/database-unbundle +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade.md index c6b78c6bcfec..e42c4e6b37e1 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Upgrade a database so it is usable by the current tools. redirect_from: - /code-security/codeql-cli/manual/database-upgrade + - /code-security/codeql-cli/codeql-cli-manual/database-upgrade +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-check.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-check.md index 490e358f0097..ba1a266b66db 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-check.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Check a particular dataset for internal consistency.' redirect_from: - /code-security/codeql-cli/manual/dataset-check + - /code-security/codeql-cli/codeql-cli-manual/dataset-check +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup.md index 092f4299cb2f..818355160cf5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Clean up temporary files from a dataset.' redirect_from: - /code-security/codeql-cli/manual/dataset-cleanup + - /code-security/codeql-cli/codeql-cli-manual/dataset-cleanup +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-import.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-import.md index 2dd26deba3d2..24ae39f743dc 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-import.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Import a set of TRAP files to a raw dataset.' redirect_from: - /code-security/codeql-cli/manual/dataset-import + - /code-security/codeql-cli/codeql-cli-manual/dataset-import +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-measure.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-measure.md index dec978bb94b2..a020c9f0c7a7 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-measure.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-measure.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- dataset. redirect_from: - /code-security/codeql-cli/manual/dataset-measure + - /code-security/codeql-cli/codeql-cli-manual/dataset-measure +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md index 5778a35bcc5c..c65b3e470e7c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-upgrade.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-upgrade.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Upgrade a dataset so it is usable by the current tools.' redirect_from: - /code-security/codeql-cli/manual/dataset-upgrade + - /code-security/codeql-cli/codeql-cli-manual/dataset-upgrade +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-add.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-add.md index 72b4a6c9d3af..c604ef1440b6 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-add.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-add.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual/diagnostic-add + - /code-security/codeql-cli/codeql-cli-manual/diagnostic-add +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-export.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-export.md index 31806c493aaa..e2ee28f9e5fd 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/diagnostic-export.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual/diagnostic-export + - /code-security/codeql-cli/codeql-cli-manual/diagnostic-export +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-cli-server.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-cli-server.md similarity index 95% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-cli-server.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-cli-server.md index f6db3ed738d1..1d9bbb8aa4fb 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-cli-server.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-cli-server.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- repeated JVM initialization. redirect_from: - /code-security/codeql-cli/manual/execute-cli-server + - /code-security/codeql-cli/codeql-cli-manual/execute-cli-server +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-language-server.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-language-server.md index e7dfde0fb66f..b08383402a0a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-language-server.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-language-server.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] On-line support for the QL language in IDEs.' redirect_from: - /code-security/codeql-cli/manual/execute-language-server + - /code-security/codeql-cli/codeql-cli-manual/execute-language-server +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-queries.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-queries.md index fbd9d6a7ccd8..de2d5dfc1f46 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-queries.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Run one or more queries against a dataset.' redirect_from: - /code-security/codeql-cli/manual/execute-queries + - /code-security/codeql-cli/codeql-cli-manual/execute-queries +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server.md index b99b63f7179a..a50eed2ec6cf 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Support for running queries from IDEs.' redirect_from: - /code-security/codeql-cli/manual/execute-query-server + - /code-security/codeql-cli/codeql-cli-manual/execute-query-server +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server2.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server2.md index 0278dbad6fcd..7c1e7e74de7f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-query-server2.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Support for running queries from IDEs.' redirect_from: - /code-security/codeql-cli/manual/execute-query-server2 + - /code-security/codeql-cli/codeql-cli-manual/execute-query-server2 +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-upgrades.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-upgrades.md index aa803ac7ea31..ca818bd1ad94 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/execute-upgrades.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Run upgrade scripts on an existing raw QL dataset.' redirect_from: - /code-security/codeql-cli/manual/execute-upgrades + - /code-security/codeql-cli/codeql-cli-manual/execute-upgrades +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-extensible-predicate-metadata.md similarity index 94% rename from content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-extensible-predicate-metadata.md index 6c45cdb55029..e08627364056 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-extensible-predicate-metadata.md @@ -11,9 +11,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/generate-extensible-predicate-metadata +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-log-summary.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-log-summary.md index 109c040d38d9..4fb75db972a0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-log-summary.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Advanced] Create a summary of a structured log file.' redirect_from: - /code-security/codeql-cli/manual/generate-log-summary + - /code-security/codeql-cli/codeql-cli-manual/generate-log-summary +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-overlay-changes.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-overlay-changes.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/generate-overlay-changes.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-overlay-changes.md index 6fa8e707e468..5872b1ce823e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-overlay-changes.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-overlay-changes.md @@ -10,9 +10,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/generate-overlay-changes +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help.md index 55d51115a46f..8a928476ca28 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Generate end-user query help from .qhelp files. redirect_from: - /code-security/codeql-cli/manual/generate-query-help + - /code-security/codeql-cli/codeql-cli-manual/generate-query-help +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/github-merge-results.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-merge-results.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/github-merge-results.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-merge-results.md index d9d5addb1d0e..54887b63c976 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/github-merge-results.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-merge-results.md @@ -9,9 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/github-merge-results +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-upload-results.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-upload-results.md index 7d55974de78d..932290c2a6b8 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/github-upload-results.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Uploads a SARIF file to GitHub code scanning. redirect_from: - /code-security/codeql-cli/manual/github-upload-results + - /code-security/codeql-cli/codeql-cli-manual/github-upload-results +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/index.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/index.md similarity index 90% rename from content/code-security/codeql-cli/codeql-cli-manual/index.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/index.md index 4eabc073f39f..a0f77d90ef11 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/index.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/index.md @@ -2,9 +2,7 @@ title: CodeQL CLI commands manual shortTitle: CodeQL CLI manual allowTitleToDifferFromFilename: true -intro: >- - Reference information for the commands available in the most recent release of - {% data variables.product.prodname_codeql_cli %}. +intro: Reference information for the commands available in the most recent release of {% data variables.product.prodname_codeql_cli %}. versions: fpt: '*' ghec: '*' @@ -13,11 +11,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli redirect_from: - /code-security/codeql-cli/manual + - /code-security/codeql-cli/codeql-cli-manual children: - /bqrs-decode - /bqrs-diff @@ -95,6 +93,7 @@ children: - /test-extract - /test-run - /version +contentType: reference --- {% data reusables.codeql-cli.man-pages-version-note %} diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-add.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-add.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-add.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-add.md index d0bcb2f16dc9..f71b7c1f1dfb 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-add.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-add.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- ranges as dependencies of the current package, and then installs them. redirect_from: - /code-security/codeql-cli/manual/pack-add + - /code-security/codeql-cli/codeql-cli-manual/pack-add +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-bundle.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-bundle.md index 79b671ceea84..1fb859f3c5b2 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-bundle.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Bundle a QL library pack.' redirect_from: - /code-security/codeql-cli/manual/pack-bundle + - /code-security/codeql-cli/codeql-cli-manual/pack-bundle +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ci.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ci.md index 1551deb37084..e7ea11fb8df7 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ci.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- existing lock file is up to date. redirect_from: - /code-security/codeql-cli/manual/pack-ci + - /code-security/codeql-cli/codeql-cli-manual/pack-ci +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-create.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-create.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-create.md index b051c5269878..928b501d466b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-create.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- source code. redirect_from: - /code-security/codeql-cli/manual/pack-create + - /code-security/codeql-cli/codeql-cli-manual/pack-create +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-download.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-download.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-download.md index 4927d89ed034..1be6cac5e481 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-download.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -17,6 +16,8 @@ intro: |- name or implicitly inside of a query suite (.qls) file. redirect_from: - /code-security/codeql-cli/manual/pack-download + - /code-security/codeql-cli/codeql-cli-manual/pack-download +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-init.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-init.md similarity index 94% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-init.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-init.md index bd72043b5f75..06046711a7d3 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-init.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-init.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli -intro: 'Initializes a qlpack in the specified directory.' +intro: Initializes a qlpack in the specified directory. redirect_from: - /code-security/codeql-cli/manual/pack-init + - /code-security/codeql-cli/codeql-cli-manual/pack-init +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-install.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-install.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-install.md index 8d35d6159aa9..58d57de2da19 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-install.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli -intro: 'Install dependencies for this pack.' +intro: Install dependencies for this pack. redirect_from: - /code-security/codeql-cli/manual/pack-install + - /code-security/codeql-cli/codeql-cli-manual/pack-install +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ls.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ls.md index 6a6f3268b7e9..1e414efafac0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-ls.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -17,6 +16,8 @@ intro: |- .codeqlmanifest.json file. redirect_from: - /code-security/codeql-cli/manual/pack-ls + - /code-security/codeql-cli/codeql-cli-manual/pack-ls +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-packlist.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-packlist.md index f52bb8d1a305..bc93630cf0ea 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-packlist.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- a QL query pack or library pack. redirect_from: - /code-security/codeql-cli/manual/pack-packlist + - /code-security/codeql-cli/codeql-cli-manual/pack-packlist +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-publish.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-publish.md index 468a593da7de..52c9d363df3b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-publish.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Publishes a QL library pack to a package registry. redirect_from: - /code-security/codeql-cli/manual/pack-publish + - /code-security/codeql-cli/codeql-cli-manual/pack-publish +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-resolve-dependencies.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-resolve-dependencies.md index d2fad44c55c9..f59aa4c0ecf0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-resolve-dependencies.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- for this QL pack. redirect_from: - /code-security/codeql-cli/manual/pack-resolve-dependencies + - /code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-upgrade.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-upgrade.md index f44c0f978245..7f69ac9e59ce 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-upgrade.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- available versions. redirect_from: - /code-security/codeql-cli/manual/pack-upgrade + - /code-security/codeql-cli/codeql-cli-manual/pack-upgrade +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-compile.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/query-compile.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-compile.md index 32801fb06743..e42f6d1a9911 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-compile.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Compile or check QL code. redirect_from: - /code-security/codeql-cli/manual/query-compile + - /code-security/codeql-cli/codeql-cli-manual/query-compile +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-decompile.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-decompile.md index 52acd29d6d02..ae710a38cb0c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-decompile.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-decompile.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- from a .qlo file. redirect_from: - /code-security/codeql-cli/manual/query-decompile + - /code-security/codeql-cli/codeql-cli-manual/query-decompile +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-format.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-format.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/query-format.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-format.md index 1562c9a538c3..435b7229d51b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-format.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-format.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Autoformat QL source code. redirect_from: - /code-security/codeql-cli/manual/query-format + - /code-security/codeql-cli/codeql-cli-manual/query-format +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-run.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/query-run.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run.md index 226836c851b6..905d44d982ba 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-run.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Run a single query. redirect_from: - /code-security/codeql-cli/manual/query-run + - /code-security/codeql-cli/codeql-cli-manual/query-run +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-database.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-database.md index c0eb9d36a988..8f6374c64ff5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-database.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-database.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Deep plumbing] Report metadata about the database.' redirect_from: - /code-security/codeql-cli/manual/resolve-database + - /code-security/codeql-cli/codeql-cli-manual/resolve-database +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions-by-pack.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions-by-pack.md index 30ebdf5cd676..37dae66297bf 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions-by-pack.md @@ -12,9 +12,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/resolve-extensions-by-pack +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions.md index a5be28aff79a..2f82aced5495 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extensions.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- includes machine learning models and data extensions. redirect_from: - /code-security/codeql-cli/manual/resolve-extensions + - /code-security/codeql-cli/codeql-cli-manual/resolve-extensions +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extractor.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extractor.md index b819567aa583..125baedcdd02 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extractor.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- language. redirect_from: - /code-security/codeql-cli/manual/resolve-extractor + - /code-security/codeql-cli/codeql-cli-manual/resolve-extractor +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-files.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-files.md index a3af3c80aa99..38578dc23aad 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-files.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Deep plumbing] Expand a set of file inclusion/exclusion globs.' redirect_from: - /code-security/codeql-cli/manual/resolve-files + - /code-security/codeql-cli/codeql-cli-manual/resolve-files +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-languages.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-languages.md index 08731765781c..b355ed78b700 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-languages.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: List installed CodeQL extractor packs. redirect_from: - /code-security/codeql-cli/manual/resolve-languages + - /code-security/codeql-cli/codeql-cli-manual/resolve-languages +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-library-path.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-library-path.md index 73e0eabb815f..4990b617a43c 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-library-path.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Deep plumbing] Determine QL library path and dbscheme for a query.' redirect_from: - /code-security/codeql-cli/manual/resolve-library-path + - /code-security/codeql-cli/codeql-cli-manual/resolve-library-path +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-metadata.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-metadata.md index 9f016be45607..b1a9a2b59da3 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-metadata.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-metadata.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- query source file. redirect_from: - /code-security/codeql-cli/manual/resolve-metadata + - /code-security/codeql-cli/codeql-cli-manual/resolve-metadata +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ml-models.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ml-models.md index 454315596d25..ea79db411b92 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ml-models.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ml-models.md @@ -8,7 +8,6 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: |- @@ -16,6 +15,8 @@ intro: |- machine learning models. redirect_from: - /code-security/codeql-cli/manual/resolve-ml-models + - /code-security/codeql-cli/codeql-cli-manual/resolve-ml-models +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-packs.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-packs.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-packs.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-packs.md index 5a3814a9858d..a7254ee667ea 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-packs.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-packs.md @@ -9,9 +9,11 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli +redirect_from: + - /code-security/codeql-cli/codeql-cli-manual/resolve-packs +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlpacks.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlpacks.md index 5cd22ccd341d..e046ac97be47 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlpacks.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Create a list of installed QL packs and their locations. redirect_from: - /code-security/codeql-cli/manual/resolve-qlpacks + - /code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlref.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlref.md index 39e6509064ee..65145597089a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlref.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlref.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Deep plumbing] Dereferences a .qlref file to return a .ql one.' redirect_from: - /code-security/codeql-cli/manual/resolve-qlref + - /code-security/codeql-cli/codeql-cli-manual/resolve-qlref +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-queries.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-queries.md index 787428659e61..23a7905bfd18 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-queries.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Deep plumbing] Expand query directories and suite specifications.' redirect_from: - /code-security/codeql-cli/manual/resolve-queries + - /code-security/codeql-cli/codeql-cli-manual/resolve-queries +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ram.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ram.md index eb6511dc9deb..6b8400c2bf69 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ram.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Deep plumbing] Prepare RAM options.' redirect_from: - /code-security/codeql-cli/manual/resolve-ram + - /code-security/codeql-cli/codeql-cli-manual/resolve-ram +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-tests.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-tests.md index 7fe823a3c719..f9c20a82b603 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-tests.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Deep plumbing] Find QL unit tests in given directories.' redirect_from: - /code-security/codeql-cli/manual/resolve-tests + - /code-security/codeql-cli/codeql-cli-manual/resolve-tests +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-upgrades.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-upgrades.md index f1e8a0b87513..5b5b9219ce10 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-upgrades.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Deep plumbing] Determine upgrades to run for a raw dataset.' redirect_from: - /code-security/codeql-cli/manual/resolve-upgrades + - /code-security/codeql-cli/codeql-cli-manual/resolve-upgrades +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-accept.md similarity index 97% rename from content/code-security/codeql-cli/codeql-cli-manual/test-accept.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-accept.md index 78909caa0746..a80242d5fd57 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-accept.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Accept results of failing unit tests. redirect_from: - /code-security/codeql-cli/manual/test-accept + - /code-security/codeql-cli/codeql-cli-manual/test-accept +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-extract.md similarity index 98% rename from content/code-security/codeql-cli/codeql-cli-manual/test-extract.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-extract.md index de9a598d5037..f79c9dc82f11 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-extract.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: '[Plumbing] Build a dataset for a test directory.' redirect_from: - /code-security/codeql-cli/manual/test-extract + - /code-security/codeql-cli/codeql-cli-manual/test-extract +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run.md similarity index 99% rename from content/code-security/codeql-cli/codeql-cli-manual/test-run.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run.md index 191a1a246d15..c0bf71d66cde 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Run unit tests for QL queries. redirect_from: - /code-security/codeql-cli/manual/test-run + - /code-security/codeql-cli/codeql-cli-manual/test-run +contentType: reference --- diff --git a/content/code-security/codeql-cli/codeql-cli-manual/version.md b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/version.md similarity index 96% rename from content/code-security/codeql-cli/codeql-cli-manual/version.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli-manual/version.md index 908fca35be1d..6e72590b8353 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/version.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli-manual/version.md @@ -8,12 +8,13 @@ topics: - Code Security - Code scanning - CodeQL -type: reference product: '{% data reusables.gated-features.codeql %}' autogenerated: codeql-cli intro: Show the version of the CodeQL toolchain. redirect_from: - /code-security/codeql-cli/manual/version + - /code-security/codeql-cli/codeql-cli-manual/version +contentType: reference --- diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/csv-output.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/csv-output.md similarity index 89% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/csv-output.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli/csv-output.md index fcc2aef5dbdd..0fad973c1b93 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/csv-output.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/csv-output.md @@ -1,6 +1,6 @@ --- title: CodeQL CLI CSV output -intro: 'You can output results from the {% data variables.product.prodname_codeql_cli %} in CSV format to share with other systems.' +intro: You can output results from the {% data variables.product.prodname_codeql_cli %} in CSV format to share with other systems. product: '{% data reusables.gated-features.codeql %}' allowTitleToDifferFromFilename: true versions: @@ -11,6 +11,9 @@ topics: - Code Security - Code scanning - CodeQL +redirect_from: + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/csv-output +contentType: reference --- ## About CSV output diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/exit-codes.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/exit-codes.md similarity index 93% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/exit-codes.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli/exit-codes.md index 904477c81b23..a688eabc50d4 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/exit-codes.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/exit-codes.md @@ -1,6 +1,6 @@ --- title: Exit codes -intro: 'Exit codes signify the status of a command after the {% data variables.product.prodname_codeql_cli %} runs it.' +intro: Exit codes signify the status of a command after the {% data variables.product.prodname_codeql_cli %} runs it. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/exit-codes - /code-security/codeql-cli/codeql-cli-reference/exit-codes + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/exit-codes +contentType: reference --- ## About exit codes diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/extractor-options.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/extractor-options.md similarity index 95% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/extractor-options.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli/extractor-options.md index 0b6560e8b8bc..7789e30c2617 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/extractor-options.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/extractor-options.md @@ -1,6 +1,6 @@ --- title: Extractor options -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} processes locally on software projects.' +intro: You can use the {% data variables.product.prodname_codeql_cli %} to run {% data variables.product.prodname_codeql %} processes locally on software projects. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -11,8 +11,10 @@ topics: - Code scanning - CodeQL redirect_from: - - /code-security/codeql-cli/extractor-options - - /code-security/codeql-cli/using-the-codeql-cli/extractor-options + - /code-security/codeql-cli/extractor-options + - /code-security/codeql-cli/using-the-codeql-cli/extractor-options + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/extractor-options +contentType: reference --- diff --git a/content/code-security/reference/code-scanning/codeql/codeql-cli/index.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/index.md new file mode 100644 index 000000000000..a16ddd036fe1 --- /dev/null +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/index.md @@ -0,0 +1,23 @@ +--- +title: Using the advanced functionality of the CodeQL CLI +intro: You can use the {% data variables.product.prodname_codeql_cli %} to locally develop, test and run {% data variables.product.prodname_codeql %} queries on software projects. +product: '{% data reusables.gated-features.codeql %}' +shortTitle: CodeQL CLI +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Code scanning + - CodeQL +children: + - /sarif-output + - /csv-output + - /extractor-options + - /exit-codes +redirect_from: + - /code-security/codeql-cli/codeql-cli-reference + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli +contentType: reference +--- diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/sarif-output.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/sarif-output.md similarity index 98% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/sarif-output.md rename to content/code-security/reference/code-scanning/codeql/codeql-cli/sarif-output.md index 00cb793bd0b6..13257f27b3eb 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/sarif-output.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/sarif-output.md @@ -1,6 +1,6 @@ --- title: CodeQL CLI SARIF output -intro: 'You can output SARIF from the {% data variables.product.prodname_codeql_cli %} and share static analysis results with other systems.' +intro: You can output SARIF from the {% data variables.product.prodname_codeql_cli %} and share static analysis results with other systems. product: '{% data reusables.gated-features.codeql %}' allowTitleToDifferFromFilename: true versions: @@ -14,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/sarif-output - /code-security/codeql-cli/codeql-cli-reference/sarif-output + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/sarif-output +contentType: reference --- ## About SARIF output diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/about-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/about-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/about-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/about-built-in-queries.md index 11f8ee68a038..7e6f45ab83a1 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/about-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/about-built-in-queries.md @@ -8,12 +8,13 @@ versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Code Security - Code scanning - CodeQL -contentType: other +contentType: reference +redirect_from: + - /code-security/code-scanning/reference/code-ql-built-in-queries/about-built-in-queries --- ## About built-in queries for CodeQL analysis diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/actions-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/actions-built-in-queries.md similarity index 90% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/actions-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/actions-built-in-queries.md index f466801c52a2..e525b1e4258c 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/actions-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/actions-built-in-queries.md @@ -8,14 +8,14 @@ versions: fpt: '*' ghes: '>3.17' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/actions-built-in-queries - /code-security/code-scanning/managing-your-code-scanning-configuration/github-actions-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/actions-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing {% data variables.product.prodname_actions %} workflows. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/c-cpp-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/c-cpp-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/c-cpp-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/c-cpp-built-in-queries.md index f2c07a891e27..fc6afa01f443 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/c-cpp-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/c-cpp-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/c-cpp-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing C and C++ code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/csharp-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/csharp-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/csharp-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/csharp-built-in-queries.md index 06e31531885e..e4d4503d7a94 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/csharp-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/csharp-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/csharp-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing C# code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/go-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/go-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/go-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/go-built-in-queries.md index 0d29eb554979..118754e7c7eb 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/go-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/go-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/go-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing Go code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/index.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/index.md similarity index 85% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/index.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/index.md index ba7bd8b080f0..097e3814c552 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/index.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/index.md @@ -23,5 +23,8 @@ children: - /ruby-built-in-queries - /rust-built-in-queries - /swift-built-in-queries +redirect_from: + - /code-security/code-scanning/reference/code-ql-built-in-queries +contentType: reference --- diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/java-kotlin-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/java-kotlin-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/java-kotlin-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/java-kotlin-built-in-queries.md index e3022f73869d..ca4848e02011 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/java-kotlin-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/java-kotlin-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/java-kotlin-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing Java and Kotlin code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/javascript-typescript-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/javascript-typescript-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/javascript-typescript-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/javascript-typescript-built-in-queries.md index 8be92efa0ef7..0204ed788ce5 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/javascript-typescript-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/javascript-typescript-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/javascript-typescript-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing JavaScript and TypeScript code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/python-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/python-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/python-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/python-built-in-queries.md index 92e444a66b38..9f29fdb83297 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/python-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/python-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/python-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing Python code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/ruby-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/ruby-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/ruby-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/ruby-built-in-queries.md index 4dc131c6344b..6f2561721cfd 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/ruby-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/ruby-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/ruby-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing Ruby code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/rust-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/rust-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/rust-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/rust-built-in-queries.md index e3d492f8186a..fd3b4df26c6d 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/rust-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/rust-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/rust-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/rust-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing Rust code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/code-scanning/reference/code-ql-built-in-queries/swift-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/swift-built-in-queries.md similarity index 88% rename from content/code-security/code-scanning/reference/code-ql-built-in-queries/swift-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/swift-built-in-queries.md index 75fcee8e0f26..e46c00c592d1 100644 --- a/content/code-security/code-scanning/reference/code-ql-built-in-queries/swift-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/swift-built-in-queries.md @@ -8,13 +8,13 @@ versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code scanning - CodeQL redirect_from: - /code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries -contentType: other + - /code-security/code-scanning/reference/code-ql-built-in-queries/swift-built-in-queries +contentType: reference --- {% data variables.product.prodname_codeql %} includes many queries for analyzing Swift code. {% data reusables.code-scanning.codeql-query-tables.query-suite-behavior %} diff --git a/content/code-security/reference/code-scanning/codeql/index.md b/content/code-security/reference/code-scanning/codeql/index.md new file mode 100644 index 000000000000..40ebebe78077 --- /dev/null +++ b/content/code-security/reference/code-scanning/codeql/index.md @@ -0,0 +1,20 @@ +--- +title: Reference for code scanning with CodeQL +shortTitle: CodeQL +intro: Find information to apply to your work with {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Code scanning + - Vulnerabilities +contentType: reference +children: + - /recommended-hardware-resources-for-running-codeql + - /telemetry-in-codeql-for-visual-studio-code + - /codeql-queries + - /codeql-cli + - /codeql-cli-manual +--- diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/recommended-hardware-resources-for-running-codeql.md b/content/code-security/reference/code-scanning/codeql/recommended-hardware-resources-for-running-codeql.md similarity index 85% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/recommended-hardware-resources-for-running-codeql.md rename to content/code-security/reference/code-scanning/codeql/recommended-hardware-resources-for-running-codeql.md index 04482500a648..a319964a2d60 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/recommended-hardware-resources-for-running-codeql.md +++ b/content/code-security/reference/code-scanning/codeql/recommended-hardware-resources-for-running-codeql.md @@ -1,10 +1,11 @@ --- title: Recommended hardware resources for running CodeQL shortTitle: Hardware resources for CodeQL -intro: 'Recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis on self-hosted machines, based on the size of your codebase.' +intro: Recommended specifications (RAM, CPU cores, and disk) for running {% data variables.product.prodname_codeql %} analysis on self-hosted machines, based on the size of your codebase. product: '{% data reusables.gated-features.codeql %}' redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/recommended-hardware-resources-for-running-codeql + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/recommended-hardware-resources-for-running-codeql versions: fpt: '*' ghes: '*' @@ -16,6 +17,7 @@ topics: - Repositories - Integration - CI +contentType: reference --- You can configure {% data variables.product.prodname_codeql %} on {% data variables.product.prodname_actions %} or on an external CI system. {% data variables.product.prodname_codeql %} is fully compatible with {% data variables.product.prodname_dotcom %}-hosted runners on {% data variables.product.prodname_actions %}. diff --git a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/telemetry-in-codeql-for-visual-studio-code.md b/content/code-security/reference/code-scanning/codeql/telemetry-in-codeql-for-visual-studio-code.md similarity index 89% rename from content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/telemetry-in-codeql-for-visual-studio-code.md rename to content/code-security/reference/code-scanning/codeql/telemetry-in-codeql-for-visual-studio-code.md index 541b115081d2..277842903c69 100644 --- a/content/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/telemetry-in-codeql-for-visual-studio-code.md +++ b/content/code-security/reference/code-scanning/codeql/telemetry-in-codeql-for-visual-studio-code.md @@ -9,11 +9,12 @@ topics: - Code Security - Code scanning - CodeQL -type: reference allowTitleToDifferFromFilename: true -intro: 'If {% data variables.product.prodname_vscode_shortname %} telemetry is enabled, {% data variables.product.company_short %} will collect usage data and metrics for the purposes of helping the core developers to improve the {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode_shortname %}.' +intro: If {% data variables.product.prodname_vscode_shortname %} telemetry is enabled, {% data variables.product.company_short %} will collect usage data and metrics for the purposes of helping the core developers to improve the {% data variables.product.prodname_codeql %} extension for {% data variables.product.prodname_vscode_shortname %}. redirect_from: - /code-security/codeql-for-vs-code/about-telemetry-in-codeql-for-visual-studio-code + - /code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension/telemetry-in-codeql-for-visual-studio-code +contentType: reference --- This data will not be shared with any parties outside of {% data variables.product.company_short %}. IP addresses and installation IDs will be retained for a maximum of 30 days. Anonymous data will be retained for a maximum of 180 days. diff --git a/content/code-security/reference/code-scanning/index.md b/content/code-security/reference/code-scanning/index.md new file mode 100644 index 000000000000..b03d848a4c50 --- /dev/null +++ b/content/code-security/reference/code-scanning/index.md @@ -0,0 +1,19 @@ +--- +title: Reference for code scanning +shortTitle: Code scanning +intro: Find information to apply to your work with {% data variables.product.prodname_code_scanning %}. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Code scanning + - Vulnerabilities +contentType: reference +redirect_from: + - /code-security/code-scanning/reference +children: + - sarif-support-for-code-scanning + - codeql +--- diff --git a/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md b/content/code-security/reference/code-scanning/sarif-support-for-code-scanning.md similarity index 98% rename from content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md rename to content/code-security/reference/code-scanning/sarif-support-for-code-scanning.md index 2c99fca036ee..747578b4ad4b 100644 --- a/content/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning.md +++ b/content/code-security/reference/code-scanning/sarif-support-for-code-scanning.md @@ -1,7 +1,7 @@ --- title: SARIF support for code scanning shortTitle: SARIF support -intro: 'To display results from a third-party static analysis tool in your repository on {% data variables.product.prodname_dotcom %}, you''ll need your results stored in a SARIF file that supports a specific subset of the SARIF 2.1.0 JSON schema for {% data variables.product.prodname_code_scanning %}. If you use the default {% data variables.product.prodname_codeql %} static analysis engine, then your results will display in your repository on {% data variables.product.prodname_dotcom %} automatically.' +intro: To display results from a third-party static analysis tool in your repository on {% data variables.product.prodname_dotcom %}, you'll need your results stored in a SARIF file that supports a specific subset of the SARIF 2.1.0 JSON schema for {% data variables.product.prodname_code_scanning %}. If you use the default {% data variables.product.prodname_codeql %} static analysis engine, then your results will display in your repository on {% data variables.product.prodname_dotcom %} automatically. product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/about-sarif-support-for-code-scanning @@ -9,16 +9,17 @@ redirect_from: - /code-security/secure-coding/sarif-support-for-code-scanning - /code-security/secure-coding/integrating-with-code-scanning/sarif-support-for-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning/sarif-support-for-code-scanning + - /code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Code Security - Code scanning - Integration - SARIF +contentType: reference --- ## About SARIF support diff --git a/content/code-security/reference/index.md b/content/code-security/reference/index.md new file mode 100644 index 000000000000..3d9de9cbfacd --- /dev/null +++ b/content/code-security/reference/index.md @@ -0,0 +1,24 @@ +--- +title: Reference for security and code quality +shortTitle: Reference +intro: Find information to apply to your work with {% data variables.product.github %}'s security and code quality features. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: reference +children: + - /secret-security + - /code-scanning + - /supply-chain-security + - /code-quality + - /permission-levels-for-repository-security-advisories +--- diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/permission-levels-for-repository-security-advisories.md b/content/code-security/reference/permission-levels-for-repository-security-advisories.md similarity index 96% rename from content/code-security/security-advisories/working-with-repository-security-advisories/permission-levels-for-repository-security-advisories.md rename to content/code-security/reference/permission-levels-for-repository-security-advisories.md index ce706b933421..6e109806df3c 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/permission-levels-for-repository-security-advisories.md +++ b/content/code-security/reference/permission-levels-for-repository-security-advisories.md @@ -8,15 +8,16 @@ redirect_from: - /code-security/security-advisories/permission-levels-for-security-advisories - /code-security/repository-security-advisories/permission-levels-for-repository-security-advisories - /code-security/security-advisories/repository-security-advisories/permission-levels-for-repository-security-advisories + - /code-security/security-advisories/working-with-repository-security-advisories/permission-levels-for-repository-security-advisories versions: fpt: '*' ghec: '*' -type: reference topics: - Security advisories - Vulnerabilities - Permissions shortTitle: Permission levels +contentType: reference --- ## Permissions overview diff --git a/content/code-security/reference/secret-security/index.md b/content/code-security/reference/secret-security/index.md new file mode 100644 index 000000000000..06e6024a26de --- /dev/null +++ b/content/code-security/reference/secret-security/index.md @@ -0,0 +1,16 @@ +--- +title: Secret security +intro: Learn about secret scanning patterns, risk report CSV contents, and {% data variables.product.github %} secrets. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning +contentType: reference +children: + - /understanding-github-secret-types + - /supported-secret-scanning-patterns + - /risk-report-csv-contents +--- diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/risk-report-csv-contents.md b/content/code-security/reference/secret-security/risk-report-csv-contents.md similarity index 84% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/risk-report-csv-contents.md rename to content/code-security/reference/secret-security/risk-report-csv-contents.md index bd1cd264107a..3c4cd9ee7728 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/risk-report-csv-contents.md +++ b/content/code-security/reference/secret-security/risk-report-csv-contents.md @@ -1,7 +1,7 @@ --- -title: 'Contents of the secret risk assessment report CSV' -shortTitle: 'Risk report CSV contents' -intro: 'Understand the data included in the CSV export of the {% data variables.product.prodname_secret_risk_assessment %} report.' +title: Contents of the secret risk assessment report CSV +shortTitle: Risk report CSV contents +intro: Understand the data included in the CSV export of the {% data variables.product.prodname_secret_risk_assessment %} report. product: '{% data reusables.gated-features.secret-risk-assessment-report %}' permissions: '{% data reusables.permissions.secret-risk-assessment-report-generation %}' type: reference @@ -13,6 +13,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/risk-report-csv-contents +contentType: reference --- The {% data variables.product.prodname_secret_risk_assessment %} report CSV file includes the following information: diff --git a/content/code-security/secret-scanning/introduction/supported-secret-scanning-patterns.md b/content/code-security/reference/secret-security/supported-secret-scanning-patterns.md similarity index 97% rename from content/code-security/secret-scanning/introduction/supported-secret-scanning-patterns.md rename to content/code-security/reference/secret-security/supported-secret-scanning-patterns.md index 802e62d407ac..acac7d6f538b 100644 --- a/content/code-security/secret-scanning/introduction/supported-secret-scanning-patterns.md +++ b/content/code-security/reference/secret-security/supported-secret-scanning-patterns.md @@ -1,20 +1,22 @@ --- title: Supported secret scanning patterns -intro: 'Lists of supported secrets and the partners that {% data variables.product.company_short %} works with to prevent fraudulent use of secrets that were committed accidentally.' +intro: Lists of supported secrets and the partners that {% data variables.product.company_short %} works with to prevent fraudulent use of secrets that were committed accidentally. product: '{% data reusables.gated-features.secret-scanning %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: reference topics: - Secret scanning - Secret Protection redirect_from: - /code-security/secret-scanning/secret-scanning-partners - /code-security/secret-scanning/secret-scanning-patterns + - /code-security/secret-scanning/introduction/supported-secret-scanning-patterns layout: inline shortTitle: Supported patterns +autogenerated: secret-scanning +contentType: reference --- ## About {% data variables.product.prodname_secret_scanning %} patterns diff --git a/content/code-security/getting-started/understanding-github-secret-types.md b/content/code-security/reference/secret-security/understanding-github-secret-types.md similarity index 98% rename from content/code-security/getting-started/understanding-github-secret-types.md rename to content/code-security/reference/secret-security/understanding-github-secret-types.md index c4877ffa27f8..50f7e105ef6d 100644 --- a/content/code-security/getting-started/understanding-github-secret-types.md +++ b/content/code-security/reference/secret-security/understanding-github-secret-types.md @@ -1,17 +1,19 @@ --- title: Understanding GitHub secret types -intro: 'Learn about the usage, scope, and access permissions for {% data variables.product.github %} secrets.' +intro: Learn about the usage, scope, and access permissions for {% data variables.product.github %} secrets. versions: fpt: '*' ghes: '*' ghec: '*' -type: overview topics: - Repositories - Dependencies - Vulnerabilities - Advanced Security shortTitle: GitHub secret types +redirect_from: + - /code-security/getting-started/understanding-github-secret-types +contentType: reference --- ## About {% data variables.product.github %}'s secret types diff --git a/content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md b/content/code-security/reference/supply-chain-security/dependabot-options-reference.md similarity index 99% rename from content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md rename to content/code-security/reference/supply-chain-security/dependabot-options-reference.md index 7edb8c20ddde..6210c27ce753 100644 --- a/content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md +++ b/content/code-security/reference/supply-chain-security/dependabot-options-reference.md @@ -1,6 +1,6 @@ --- title: Dependabot options reference -intro: 'Detailed information for all the options you can use to customize how {% data variables.product.prodname_dependabot %} maintains your repositories.' +intro: Detailed information for all the options you can use to customize how {% data variables.product.prodname_dependabot %} maintains your repositories. permissions: '{% data reusables.permissions.dependabot-yml-configure %}' allowTitleToDifferFromFilename: true redirect_from: @@ -8,18 +8,19 @@ redirect_from: - /code-security/supply-chain-security/configuration-options-for-dependency-updates - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates - /code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file + - /code-security/dependabot/working-with-dependabot/dependabot-options-reference versions: fpt: '*' ghec: '*' ghes: '*' -type: reference topics: - Dependabot - Version updates - Repositories - Dependencies - Pull requests -shortTitle: Dependabot options reference +shortTitle: Dependabot options +contentType: reference --- ## About the `dependabot.yml` file @@ -473,7 +474,7 @@ Change the limit on the maximum number of pull requests for version updates open When `open-pull-requests-limit` is defined: -* {% data variables.product.prodname_dependabot %} opens pull requests up to the defined integer value. +* {% data variables.product.prodname_dependabot %} opens pull requests up to the defined integer value. A large value can be set to effectively remove the open pull request limit. * You can temporarily disable version updates for a package manager by setting this option to zero, see [Disabling {% data variables.product.prodname_dependabot_version_updates %}](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#disabling-dependabot-version-updates). ## `package-ecosystem` {% octicon "versions" aria-label="Version updates only" height="24" %} diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems.md b/content/code-security/reference/supply-chain-security/dependency-graph-supported-package-ecosystems.md similarity index 93% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems.md rename to content/code-security/reference/supply-chain-security/dependency-graph-supported-package-ecosystems.md index 75ebf0467b91..13e6e74681c6 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems.md +++ b/content/code-security/reference/supply-chain-security/dependency-graph-supported-package-ecosystems.md @@ -1,9 +1,8 @@ --- title: Dependency graph supported package ecosystems -shortTitle: Dependency graph ecosystem support # Max 31 characters -intro: 'Dependency graph supports a variety of ecosystems.' +shortTitle: Dependency graph ecosystems +intro: Dependency graph supports a variety of ecosystems. allowTitleToDifferFromFilename: true -type: reference topics: - Dependency graph - Dependencies @@ -14,6 +13,9 @@ versions: fpt: '*' ghec: '*' ghes: '*' +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/dependency-graph-supported-package-ecosystems +contentType: reference --- ## About the dependency graph diff --git a/content/code-security/reference/supply-chain-security/index.md b/content/code-security/reference/supply-chain-security/index.md new file mode 100644 index 000000000000..148c135d4618 --- /dev/null +++ b/content/code-security/reference/supply-chain-security/index.md @@ -0,0 +1,25 @@ +--- +title: Reference for supply chain security +shortTitle: Supply chain security +intro: Find information to apply to your work with {% data variables.product.prodname_dependabot %} and the dependency graph. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Dependabot + - Version updates + - Repositories + - Dependencies + - Pull requests + - Dependency graph + - Alerts + - Vulnerabilities +contentType: reference +children: + - /dependabot-options-reference + - /supported-ecosystems-and-repositories + - /dependency-graph-supported-package-ecosystems +redirect_from: + - /code-security/dependabot/ecosystems-supported-by-dependabot +--- diff --git a/content/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories.md b/content/code-security/reference/supply-chain-security/supported-ecosystems-and-repositories.md similarity index 94% rename from content/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories.md rename to content/code-security/reference/supply-chain-security/supported-ecosystems-and-repositories.md index 60e66b2aabbb..20b10a6520e0 100644 --- a/content/code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories.md +++ b/content/code-security/reference/supply-chain-security/supported-ecosystems-and-repositories.md @@ -1,9 +1,8 @@ --- title: Dependabot supported ecosystems and repositories -shortTitle: Dependabot ecosystem support # Max 31 characters +shortTitle: Dependabot ecosystems intro: '{% data variables.product.prodname_dependabot %} supports a variety of ecosystems and repositories' allowTitleToDifferFromFilename: true -type: reference topics: - Dependabot - Dependencies @@ -14,6 +13,9 @@ versions: fpt: '*' ghec: '*' ghes: '*' +redirect_from: + - /code-security/dependabot/ecosystems-supported-by-dependabot/supported-ecosystems-and-repositories +contentType: reference --- ## About {% data variables.product.prodname_dependabot %} diff --git a/content/code-security/code-quality/responsible-use/code-quality.md b/content/code-security/responsible-use/code-quality.md similarity index 97% rename from content/code-security/code-quality/responsible-use/code-quality.md rename to content/code-security/responsible-use/code-quality.md index 5d514ee04f90..9b7d811c18f1 100644 --- a/content/code-security/code-quality/responsible-use/code-quality.md +++ b/content/code-security/responsible-use/code-quality.md @@ -1,7 +1,7 @@ --- title: Responsible use of GitHub Code Quality shortTitle: Code quality -intro: 'Use {% data variables.product.prodname_code_quality %} responsibly by understanding its purposes, capabilities, and limitations.' +intro: Use {% data variables.product.prodname_code_quality %} responsibly by understanding its purposes, capabilities, and limitations. versions: feature: code-quality topics: @@ -9,6 +9,8 @@ topics: - CodeQL - AI contentType: rai +redirect_from: + - /code-security/code-quality/responsible-use/code-quality --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/responsible-use/index.md b/content/code-security/responsible-use/index.md new file mode 100644 index 000000000000..9ecbc347ac92 --- /dev/null +++ b/content/code-security/responsible-use/index.md @@ -0,0 +1,24 @@ +--- +title: Responsible use of {% data variables.product.github %}'s security and code quality features +shortTitle: Responsible use +intro: Use {% data variables.product.github %}'s security and code quality features responsibly by understanding their purposes, capabilities, and limitations. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Code Quality +contentType: rai +children: + - /responsible-use-autofix-code-scanning + - /responsible-ai-generic-secrets + - /responsible-ai-regex-generator + - /code-quality +redirect_from: + - /code-security/code-quality/responsible-use +--- diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md b/content/code-security/responsible-use/responsible-ai-generic-secrets.md similarity index 95% rename from content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md rename to content/code-security/responsible-use/responsible-ai-generic-secrets.md index 7f82b8e44c95..cfbf6517d102 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets.md +++ b/content/code-security/responsible-use/responsible-ai-generic-secrets.md @@ -1,13 +1,12 @@ --- title: Responsible detection of generic secrets with Copilot secret scanning -shortTitle: Generic secret detection -intro: 'Learn how {% data variables.secret-scanning.copilot-secret-scanning %} uses AI responsibly to scan and create alerts for unstructured secrets, such as passwords.' +shortTitle: Copilot secret scanning +intro: Learn how {% data variables.secret-scanning.copilot-secret-scanning %} uses AI responsibly to scan and create alerts for unstructured secrets, such as passwords. allowTitleToDifferFromFilename: true product: '{% data reusables.rai.secret-scanning.copilot-secret-scanning-gated-feature %}' versions: feature: secret-scanning-ai-generic-secret-detection fpt: '*' -type: rai topics: - Secret scanning - Secret Protection @@ -17,6 +16,9 @@ redirect_from: - /code-security/secret-scanning/about-the-detection-of-generic-secrets-with-secret-scanning - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/about-the-detection-of-generic-secrets-with-secret-scanning - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets + - /code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets + - /code-security/secret-scanning/copilot-secret-scanning +contentType: rai --- diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-regex-generator.md b/content/code-security/responsible-use/responsible-ai-regex-generator.md similarity index 94% rename from content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-regex-generator.md rename to content/code-security/responsible-use/responsible-ai-regex-generator.md index b22bad0c63a3..863eb49f5ec2 100644 --- a/content/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-regex-generator.md +++ b/content/code-security/responsible-use/responsible-ai-regex-generator.md @@ -1,12 +1,11 @@ --- title: Responsible generation of regular expressions with Copilot secret scanning -shortTitle: Generate regular expressions with AI -intro: 'Learn about the capabilities and limitations of the {% data variables.secret-scanning.custom-pattern-regular-expression-generator %} in helping you to define custom patterns to extend the capabilities of {% data variables.product.prodname_secret_scanning %}.' +shortTitle: Regular expressions generator +intro: Learn about the capabilities and limitations of the {% data variables.secret-scanning.custom-pattern-regular-expression-generator %} in helping you to define custom patterns to extend the capabilities of {% data variables.product.prodname_secret_scanning %}. product: '{% data reusables.rai.secret-scanning.copilot-secret-scanning-gated-feature %}' allowTitleToDifferFromFilename: true versions: feature: secret-scanning-custom-pattern-ai-generated -type: rai topics: - Secret Protection - Secret scanning @@ -18,6 +17,8 @@ redirect_from: - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/about-generating-regular-expressions-with-ai - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/responsible-use-ai-regex-generator - /code-security/secret-scanning/copilot-secret-scanning/responsible-use-ai-regex-generator + - /code-security/secret-scanning/copilot-secret-scanning/responsible-ai-regex-generator +contentType: rai --- diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning.md b/content/code-security/responsible-use/responsible-use-autofix-code-scanning.md similarity index 97% rename from content/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning.md rename to content/code-security/responsible-use/responsible-use-autofix-code-scanning.md index 4351a7e817ef..0c4e2bffd82a 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning.md +++ b/content/code-security/responsible-use/responsible-use-autofix-code-scanning.md @@ -1,12 +1,11 @@ --- title: Responsible use of Copilot Autofix for code scanning shortTitle: Copilot Autofix for code scanning -intro: Learn how GitHub uses AI to suggest potential fixes for {% data variables.product.prodname_code_scanning %} alerts and find out how best to mitigate limitations in the AI suggestions. +intro: Learn how {% data variables.product.github %} uses AI to suggest potential fixes for {% data variables.product.prodname_code_scanning %} alerts and find out how best to mitigate limitations in the AI suggestions. allowTitleToDifferFromFilename: true product: '{% data reusables.rai.code-scanning.gated-feature-autofix %}' versions: feature: code-scanning-autofix -type: rai topics: - Code Security - Code scanning @@ -14,6 +13,8 @@ topics: - AI redirect_from: - /code-security/code-scanning/managing-code-scanning-alerts/about-autofix-for-codeql-code-scanning + - /code-security/code-scanning/managing-code-scanning-alerts/responsible-use-autofix-code-scanning +contentType: rai --- ## About {% data variables.copilot.copilot_autofix_short %} for {% data variables.product.prodname_code_scanning %} diff --git a/content/code-security/secret-scanning/copilot-secret-scanning/index.md b/content/code-security/secret-scanning/copilot-secret-scanning/index.md deleted file mode 100644 index 0ca6512eaf93..000000000000 --- a/content/code-security/secret-scanning/copilot-secret-scanning/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Enhance your secret detection capabilities with Copilot secret scanning -shortTitle: Copilot secret scanning -allowTitleToDifferFromFilename: true -intro: 'Learn how {% data variables.product.prodname_secret_scanning %} uses AI to detect generic secrets in your code, and generate regular expressions for your custom patterns.' -product: '{% data reusables.rai.secret-scanning.copilot-secret-scanning-gated-feature %}' -versions: - ghec: '*' -topics: - - Secret scanning - - Secret Protection - - Repositories - - Copilot -children: - - /responsible-ai-generic-secrets - - /enabling-ai-powered-generic-secret-detection - - /responsible-ai-regex-generator - - /generating-regular-expressions-for-custom-patterns-with-copilot-secret-scanning -redirect_from: - - /code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection ---- diff --git a/content/code-security/secret-scanning/enabling-secret-scanning-features/index.md b/content/code-security/secret-scanning/enabling-secret-scanning-features/index.md deleted file mode 100644 index 1f89d98525a8..000000000000 --- a/content/code-security/secret-scanning/enabling-secret-scanning-features/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Enabling secret scanning features -shortTitle: Enable features -allowTitleToDifferFromFilename: true -intro: 'Learn how to enable {% data variables.product.prodname_secret_scanning %} to detect secrets that are already visible in a repository, as well as push protection to proactively secure you against leaking additional secrets by blocking pushes containing secrets.' -product: '{% data reusables.gated-features.secret-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Secret scanning - - Secret Protection - - Repositories -children: - - /enabling-secret-scanning-for-your-repository - - /enabling-push-protection-for-your-repository - - /enabling-validity-checks-for-your-repository - - /enabling-extended-metadata-checks-for-your-repository -redirect_from: - - /github/administering-a-repository/configuring-secret-scanning-for-private-repositories - - /github/administering-a-repository/configuring-secret-scanning-for-your-repositories - - /code-security/secret-scanning/configuring-secret-scanning-for-your-repositories ---- diff --git a/content/code-security/secret-scanning/index.md b/content/code-security/secret-scanning/index.md deleted file mode 100644 index 3af8406c0ed3..000000000000 --- a/content/code-security/secret-scanning/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Keeping secrets secure with secret scanning -shortTitle: Secret scanning -allowTitleToDifferFromFilename: true -intro: 'Let {% data variables.product.company_short %} do the hard work of ensuring that tokens, private keys, and other code secrets are not exposed in your repository.' -product: '{% data reusables.gated-features.secret-scanning %}' -redirect_from: - - /code-security/secret-security -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Secret scanning - - Secret Protection - - Repositories -children: - - /introduction - - /enabling-secret-scanning-features - - /managing-alerts-from-secret-scanning - - /working-with-secret-scanning-and-push-protection - - /using-advanced-secret-scanning-and-push-protection-features - - /copilot-secret-scanning - - /troubleshooting-secret-scanning-and-push-protection - - /secret-scanning-partnership-program ---- diff --git a/content/code-security/secret-scanning/introduction/index.md b/content/code-security/secret-scanning/introduction/index.md deleted file mode 100644 index 286b2a482c96..000000000000 --- a/content/code-security/secret-scanning/introduction/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Introduction to secret scanning -shortTitle: Introduction -allowTitleToDifferFromFilename: true -intro: 'Learn how {% data variables.product.prodname_secret_scanning %} detects secrets in existing content and new commits, helping you to avoid exposing sensitive data that could be exploited.' -product: '{% data reusables.gated-features.secret-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -type: overview -topics: - - Secret scanning - - Secret Protection -children: - - /about-secret-scanning - - /about-push-protection - - /about-secret-scanning-for-partners - - /supported-secret-scanning-patterns ---- diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/index.md b/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/index.md deleted file mode 100644 index dfcebdae2a61..000000000000 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: Managing alerts from secret scanning -intro: 'Learn how to find, evaluate, and resolve alerts for secrets stored in your repository.' -product: '{% data reusables.gated-features.secret-scanning %}' -redirect_from: - - /github/administering-a-repository/managing-alerts-from-secret-scanning - - /code-security/secret-security/managing-alerts-from-secret-scanning - -versions: - fpt: '*' - ghes: '*' - ghec: '*' -type: how_to -topics: - - Secret scanning - - Secret Protection - - Alerts - - Repositories -shortTitle: Manage alerts -children: - - /about-alerts - - /viewing-alerts - - /evaluating-alerts - - /resolving-alerts - - /monitoring-alerts ---- diff --git a/content/code-security/secret-scanning/secret-scanning-partnership-program/index.md b/content/code-security/secret-scanning/secret-scanning-partnership-program/index.md deleted file mode 100644 index cdf66c1e9353..000000000000 --- a/content/code-security/secret-scanning/secret-scanning-partnership-program/index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Secret scanning partnership program -intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' -versions: - fpt: '*' - ghec: '*' -topics: - - API -shortTitle: Partner program -children: - - /secret-scanning-partner-program ---- - diff --git a/content/code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/index.md b/content/code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/index.md deleted file mode 100644 index 1bbb095f9e4e..000000000000 --- a/content/code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Troubleshooting secret scanning and push protection -shortTitle: Troubleshoot -intro: 'If you have problems with {% data variables.product.prodname_secret_scanning %} or push protection, you can use these tips to help resolve issues.' -product: '{% data reusables.gated-features.secret-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -type: how_to -topics: - - Secret scanning - - Secret Protection - - Troubleshooting -children: - - /troubleshooting-secret-scanning ---- diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/index.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/index.md deleted file mode 100644 index 97aa6ed566ab..000000000000 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Custom patterns -shortTitle: Custom patterns -allowTitleToDifferFromFilename: true -intro: 'You can extend the capabilities of {% data variables.product.prodname_secret_scanning %} to search for your own patterns. These custom patterns can range from your service API keys to connection strings into cloud resources.' -product: '{% data reusables.gated-features.secret-scanning-custom-patterns %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Secret scanning - - Secret Protection - - Repositories -children: - - /defining-custom-patterns-for-secret-scanning - - /managing-custom-patterns - - /metrics-for-custom-patterns ---- diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/index.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/index.md deleted file mode 100644 index 2812f66d7470..000000000000 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Delegated bypass for push protection -shortTitle: Delegated bypass -allowTitleToDifferFromFilename: true -intro: 'You can control the ability to bypass push protection by setting up a reviewers group to assess requests. When a contributor proposes bypassing protections, any member of the bypass list can approve or block the request.' -product: '{% data reusables.gated-features.secret-scanning %}' -versions: - feature: push-protection-delegated-bypass -topics: - - Secret scanning - - Secret Protection - - Repositories -children: - - /about-delegated-bypass-for-push-protection - - /enabling-delegated-bypass-for-push-protection - - /managing-requests-to-bypass-push-protection ---- diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/index.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/index.md deleted file mode 100644 index 16cda4669c97..000000000000 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Using advanced secret scanning and push protection features -shortTitle: Advanced features -allowTitleToDifferFromFilename: true -intro: 'Learn how you can customize {% data variables.product.prodname_secret_scanning %} to meet the needs of your company.' -product: '{% data reusables.gated-features.secret-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Secret scanning - - Secret Protection - - Repositories -children: - - /excluding-folders-and-files-from-secret-scanning - - /non-provider-patterns - - /custom-patterns - - /delegated-bypass-for-push-protection - - /enabling-delegated-alert-dismissal-for-secret-scanning ---- diff --git a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/index.md b/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/index.md deleted file mode 100644 index f1ec83a2e10f..000000000000 --- a/content/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/non-provider-patterns/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Non-provider patterns -shortTitle: Non-provider patterns -allowTitleToDifferFromFilename: true -intro: '{% data variables.product.prodname_secret_scanning_caps %} can also alert you to the potential use of other types of secret in code, for example: HTTP authentication headers, connection strings, and private keys. These non-provider patterns are more difficult to detect reliably so this feature is not enabled by default.' -product: '{% data reusables.gated-features.secret-scanning-non-provider-patterns %}' -versions: - feature: secret-scanning-non-provider-patterns -topics: - - Secret scanning - - Secret Protection - - Repositories -children: - - /enabling-secret-scanning-for-non-provider-patterns ---- diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/index.md b/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/index.md deleted file mode 100644 index e29f0415305d..000000000000 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Working with secret scanning and push protection -shortTitle: Work with secret scanning -allowTitleToDifferFromFilename: true -intro: 'Avoid leaking sensitive data by blocking pushes containing tokens and other secrets.' -product: '{% data reusables.gated-features.secret-scanning %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Secret scanning - - Secret Protection - - Repositories -children: - - /remediating-a-leaked-secret - - /push-protection-for-users - - /working-with-push-protection-from-the-command-line - - /working-with-push-protection-from-the-rest-api - - /working-with-push-protection-in-the-github-ui - - /working-with-push-protection-and-the-github-mcp-server -redirect_from: - - /code-security/secret-scanning/working-with-push-protection - - /code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection ---- diff --git a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/index.md b/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/index.md deleted file mode 100644 index f896dc82111c..000000000000 --- a/content/code-security/securing-your-organization/enabling-security-features-in-your-organization/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Enabling security features in your organization -shortTitle: Enable security features -intro: '{% ifversion security-configurations-cloud %}Enable the {% data variables.product.prodname_github_security_configuration %} or c{% elsif security-configurations-ghes-only %}C{% endif %}reate and apply {% data variables.product.prodname_custom_security_configurations %} to quickly secure your organization.' -versions: - feature: security-configurations -topics: - - Code Security - - Secret Protection - - Organizations - - Security -children: - - /applying-the-github-recommended-security-configuration-in-your-organization - - /creating-a-custom-security-configuration - - /applying-a-custom-security-configuration - - /configuring-global-security-settings-for-your-organization - - /giving-org-access-private-registries -redirect_from: - - /code-security/securing-your-organization/meeting-your-specific-security-needs-with-custom-security-configurations ---- diff --git a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/index.md b/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/index.md deleted file mode 100644 index 5c3294e7563d..000000000000 --- a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Fixing security alerts at scale -shortTitle: Fix alerts at scale -intro: 'Once you detect security alerts across your organization, you will want to create security campaigns to engage with developers and collaborate on fixing alerts.' -versions: - feature: security-campaigns -audience: - - driver -topics: - - Code Security - - Secret Protection - - Organizations - - Security -children: - - /about-security-campaigns - - /best-practice-fix-alerts-at-scale - - /creating-managing-security-campaigns - - /tracking-security-campaigns ---- diff --git a/content/code-security/securing-your-organization/index.md b/content/code-security/securing-your-organization/index.md deleted file mode 100644 index 3176ebc37ba3..000000000000 --- a/content/code-security/securing-your-organization/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Securing your organization -shortTitle: Secure your organization -intro: 'Secure your organization at scale with {% data variables.product.company_short %}''s security products{% ifversion security-configurations %} through {% data variables.product.prodname_security_configurations %} and {% data variables.product.prodname_global_settings %}{% endif %}.{% ifversion secret-risk-assessment %}
{% data variables.secret-scanning.secret-risk-assessment-cta-product %}{% endif %}' -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Code Security - - Secret Protection - - Organizations - - Security -children: - - /introduction-to-securing-your-organization-at-scale - - /enabling-security-features-in-your-organization - - /managing-the-security-of-your-organization - - /understanding-your-organizations-exposure-to-leaked-secrets - - /understanding-your-organizations-exposure-to-vulnerabilities - - /fixing-security-alerts-at-scale - - /troubleshooting-security-configurations ---- diff --git a/content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/index.md b/content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/index.md deleted file mode 100644 index 6e3cede7ec92..000000000000 --- a/content/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Introduction to securing your organization at scale -shortTitle: Introduction -intro: 'Learn about securing your organization with {% data variables.product.prodname_security_configurations %} and {% data variables.product.prodname_global_settings %}.' -versions: - feature: security-configurations -topics: - - Code Security - - Secret Protection - - Organizations - - Security -children: - - /about-enabling-security-features-at-scale - - /choosing-a-security-configuration-for-your-repositories ---- diff --git a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/index.md b/content/code-security/securing-your-organization/managing-the-security-of-your-organization/index.md deleted file mode 100644 index 6b3f51f5dc72..000000000000 --- a/content/code-security/securing-your-organization/managing-the-security-of-your-organization/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Managing the security of your organization -shortTitle: Manage organization security -intro: 'You can interpret security findings and manage your security enablement settings to better secure your organization.' -versions: - feature: security-configurations -topics: - - Code Security - - Secret Protection - - Organizations - - Security -children: - - /interpreting-security-findings - - /filtering-repositories-in-your-organization-using-the-repository-table - - /editing-a-custom-security-configuration - - /managing-your-github-advanced-security-license-usage - - /detaching-repositories-from-their-security-configurations - - /finding-repositories-with-attachment-failures - - /deleting-a-custom-security-configuration ---- diff --git a/content/code-security/securing-your-organization/troubleshooting-security-configurations/index.md b/content/code-security/securing-your-organization/troubleshooting-security-configurations/index.md deleted file mode 100644 index 76de4e969f01..000000000000 --- a/content/code-security/securing-your-organization/troubleshooting-security-configurations/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Troubleshooting security configurations -shortTitle: Troubleshoot configurations -intro: 'To successfully apply a {% data variables.product.prodname_security_configuration %}, you may need to troubleshoot unexpected issues.' -versions: - feature: security-configurations -topics: - - Code Security - - Secret Protection - - Organizations - - Security -children: - - /a-repository-is-using-advanced-setup-for-code-scanning - - /unexpected-default-setup - - /not-enough-github-advanced-security-licenses - - /feature-disappears ---- diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/index.md b/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/index.md deleted file mode 100644 index 3dfa52c4d034..000000000000 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Understanding your organization's exposure to leaked secrets -shortTitle: Exposure to leaked secrets -intro: You can generate a secret risk assessment report to evaluate the extent of your organization's vulnerability to leaked secrets. Decide whether to enable {% data variables.product.prodname_secret_protection %} to protect your organization from further leaks.
{% data variables.secret-scanning.secret-risk-assessment-cta-product %} -versions: - feature: secret-risk-assessment -topics: - - Organizations - - Secret scanning - - Secret Protection - - Code Security - - Security -children: - - /about-secret-security-with-github - - /assess-your-secret-risk - - /viewing-the-secret-risk-assessment-report-for-your-organization - - /export-risk-report-csv - - /risk-report-csv-contents - - /interpreting-secret-risk-assessment-results - - /protect-your-secrets - - /calculating-the-cost-savings-of-push-protection - - /estimating-the-price-of-secret-protection - - /organizing-remediation-efforts-for-leaked-secrets ---- diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/index.md b/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/index.md deleted file mode 100644 index a43170bef68a..000000000000 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: 'Understanding your organization''s exposure to vulnerabilities' -shortTitle: Exposure to vulnerabilities -intro: 'Understanding your organization''s exposure to vulnerable code and dependencies is crucial for identifying and prioritizing security risks. This awareness allows you to prioritize remediation efforts, reduce the likelihood of security breaches, protect sensitive data, and maintain the overall integrity and reputation of the organization.' -versions: - feature: dependabot-metrics -topics: - - Code Security - - Dependabot - - Code scanning - - Organizations - - Security -children: - - /about-your-exposure-to-vulnerable-dependencies - - /prioritizing-dependabot-alerts-using-metrics - - /alerts-in-production-code -redirect_from: - - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites ---- diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/index.md b/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/index.md deleted file mode 100644 index 5bfb16d09c67..000000000000 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Guidance on reporting and writing information about vulnerabilities -shortTitle: Guidance on reporting and writing -intro: Best practices for writing security advisories and managing privately reported security vulnerabilities. -redirect_from: - - /code-security/security-advisories/guidance-on-reporting-and-writing -versions: - fpt: '*' - ghec: '*' -topics: - - Security advisories - - Vulnerabilities - - Repositories - - CVEs -children: - - /about-coordinated-disclosure-of-security-vulnerabilities - - /best-practices-for-writing-repository-security-advisories - - /privately-reporting-a-security-vulnerability - - /managing-privately-reported-security-vulnerabilities ---- diff --git a/content/code-security/security-advisories/index.md b/content/code-security/security-advisories/index.md deleted file mode 100644 index 6f8e62ecc91a..000000000000 --- a/content/code-security/security-advisories/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Working with security advisories -shortTitle: Security advisories -allowTitleToDifferFromFilename: true -intro: 'Learn how to work with security advisories on {% data variables.product.prodname_dotcom %},{% ifversion fpt or ghec %} whether you want to contribute to an existing global advisory, or create a security advisory for a repository,{% endif %} improving collaboration between repository maintainers and security researchers.' -versions: - fpt: '*' - ghec: '*' - ghes: '*' -topics: - - Security advisories - - Vulnerabilities - - Repositories - - CVEs -children: - - /working-with-global-security-advisories-from-the-github-advisory-database - - /working-with-repository-security-advisories - - /guidance-on-reporting-and-writing-information-about-vulnerabilities ---- diff --git a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/index.md b/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/index.md deleted file mode 100644 index 3212095636ff..000000000000 --- a/content/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Working with global security advisories from the GitHub Advisory Database -shortTitle: Global security advisories -intro: 'Browse the {% data variables.product.prodname_advisory_database %} and submit improvements to any global security advisory.' -redirect_from: - - /code-security/security-advisories/global-security-advisories -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Security advisories - - Vulnerabilities - - Repositories - - CVEs -children: - - /about-the-github-advisory-database - - /about-global-security-advisories - - /browsing-security-advisories-in-the-github-advisory-database - - /editing-security-advisories-in-the-github-advisory-database ---- diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/index.md b/content/code-security/security-advisories/working-with-repository-security-advisories/index.md deleted file mode 100644 index b391f0fa8f54..000000000000 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Working with repository security advisories -shortTitle: Repository security advisories -intro: 'Discuss, fix, and disclose security vulnerabilities in your public repositories using repository security advisories.' -redirect_from: - - /articles/managing-security-vulnerabilities-in-your-project - - /github/managing-security-vulnerabilities/managing-security-vulnerabilities-in-your-project - - /code-security/repository-security-advisories - - /code-security/security-advisories/repository-security-advisories -versions: - fpt: '*' - ghec: '*' -topics: - - Security advisories - - Vulnerabilities - - Repositories - - CVEs -children: - - /about-repository-security-advisories - - /permission-levels-for-repository-security-advisories - - /configuring-private-vulnerability-reporting-for-a-repository - - /configuring-private-vulnerability-reporting-for-an-organization - - /creating-a-repository-security-advisory - - /editing-a-repository-security-advisory - - /evaluating-the-security-settings-of-a-repository - - /collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability - - /publishing-a-repository-security-advisory - - /adding-a-collaborator-to-a-repository-security-advisory - - /removing-a-collaborator-from-a-repository-security-advisory - - /deleting-a-repository-security-advisory ---- diff --git a/content/code-security/security-overview/index.md b/content/code-security/security-overview/index.md deleted file mode 100644 index f90ce3e7af1c..000000000000 --- a/content/code-security/security-overview/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Viewing security information for your organization or enterprise -shortTitle: Security overview -allowTitleToDifferFromFilename: true -intro: 'Visualize adoption rates for {% data variables.product.prodname_GHAS %} features, alert discovery, and remediation for your organization or enterprise.' -product: '{% data reusables.gated-features.security-overview-general %}' -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Security overview - - Code Security - - Secret Protection -children: - - /about-security-overview - - /viewing-security-insights - - /assessing-adoption-code-security - - /assessing-code-security-risk - - /filtering-alerts-in-security-overview - - /enabling-security-features-for-multiple-repositories - - /exporting-data-from-security-overview - - /viewing-metrics-for-dependabot-alerts - - /viewing-metrics-for-secret-scanning-push-protection - - /viewing-metrics-for-pull-request-alerts - - /reviewing-requests-to-bypass-push-protection - - /review-alert-dismissal-requests ---- diff --git a/content/code-security/supply-chain-security/index.md b/content/code-security/supply-chain-security/index.md deleted file mode 100644 index f14e6bb758a3..000000000000 --- a/content/code-security/supply-chain-security/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Securing your software supply chain -shortTitle: Supply chain security -allowTitleToDifferFromFilename: true -intro: 'Visualize, maintain, and secure the dependencies in your software supply chain.' -redirect_from: - - /categories/managing-security-vulnerabilities - - /github/managing-security-vulnerabilities -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Dependabot - - Dependencies - - Repositories -children: - - /understanding-your-software-supply-chain - - /end-to-end-supply-chain ---- diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md b/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md deleted file mode 100644 index 10402c12f2aa..000000000000 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Understanding your software supply chain -versions: - fpt: '*' - ghes: '*' - ghec: '*' -topics: - - Dependency graph - - Dependencies - - Repositories -shortTitle: Understand your supply chain -children: - - /about-supply-chain-security - - /about-the-dependency-graph - - /dependency-graph-supported-package-ecosystems - - /configuring-the-dependency-graph - - /configuring-automatic-dependency-submission-for-your-repository - - /exporting-a-software-bill-of-materials-for-your-repository - - /using-the-dependency-submission-api - - /about-dependency-review - - /configuring-the-dependency-review-action - - /customizing-your-dependency-review-action-configuration - - /enforcing-dependency-review-across-an-organization - - /exploring-the-dependencies-of-a-repository - - /troubleshooting-the-dependency-graph - - /immutable-releases - - /preventing-changes-to-your-releases - - /verifying-the-integrity-of-a-release ---- diff --git a/content/code-security/adopting-github-advanced-security-at-scale/index.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/index.md similarity index 78% rename from content/code-security/adopting-github-advanced-security-at-scale/index.md rename to content/code-security/tutorials/adopting-github-advanced-security-at-scale/index.md index 851f649edbba..c41b7d3e7253 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/index.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/index.md @@ -1,5 +1,5 @@ --- -title: 'Adopting {% data variables.product.prodname_GHAS %} at scale' +title: Adopting {% data variables.product.prodname_GHAS %} at scale shortTitle: Adopt GHAS at scale intro: A phased approach to rolling out {% data variables.product.prodname_GHAS %} at your company using industry and GitHub best practices. versions: @@ -18,4 +18,8 @@ children: - /phase-4-create-internal-documentation - /phase-5-rollout-and-scale-code-scanning - /phase-6-rollout-and-scale-secret-scanning +redirect_from: + - /code-security/adopting-github-advanced-security-at-scale +contentType: tutorials --- + diff --git a/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md similarity index 92% rename from content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md rename to content/code-security/tutorials/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md index e27939d99691..3abb5cf31055 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale.md @@ -1,6 +1,6 @@ --- -title: 'Introduction to adopting {% data variables.product.prodname_GHAS %} at scale' -intro: 'You can adopt {% data variables.product.prodname_GHAS %} at scale in your company following industry and {% data variables.product.github %} best practices.' +title: Introduction to adopting {% data variables.product.prodname_GHAS %} at scale +intro: You can adopt {% data variables.product.prodname_GHAS %} at scale in your company following industry and {% data variables.product.github %} best practices. allowTitleToDifferFromFilename: true versions: ghes: '*' @@ -14,6 +14,8 @@ redirect_from: - /admin/code-security/managing-github-advanced-security-for-your-enterprise/overview-of-github-advanced-security-deployment - /admin/advanced-security/deploying-github-advanced-security-in-your-enterprise - /admin/code-security/managing-github-advanced-security-for-your-enterprise/deploying-github-advanced-security-in-your-enterprise + - /code-security/adopting-github-advanced-security-at-scale/introduction-to-adopting-github-advanced-security-at-scale +contentType: tutorials --- ## About these articles diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md similarity index 97% rename from content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md rename to content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md index a991d592136f..7735b7d6e379 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals.md @@ -8,6 +8,9 @@ topics: - Code Security - Secret Protection shortTitle: 1. Align on strategy +redirect_from: + - /code-security/adopting-github-advanced-security-at-scale/phase-1-align-on-your-rollout-strategy-and-goals +contentType: tutorials --- > [!TIP] diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md similarity index 95% rename from content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md rename to content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md index 898c9292a642..b0d27d88efa2 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale.md @@ -1,6 +1,6 @@ --- title: 'Phase 2: Preparing to enable at scale' -intro: 'In this phase you will prepare developers and collect data about your repositories to ensure your teams are ready and you have everything you need for pilot programs and rolling out {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}.' +intro: In this phase you will prepare developers and collect data about your repositories to ensure your teams are ready and you have everything you need for pilot programs and rolling out {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}. versions: ghes: '*' ghec: '*' @@ -8,6 +8,9 @@ topics: - Code Security - Secret Protection shortTitle: 2. Preparation +redirect_from: + - /code-security/adopting-github-advanced-security-at-scale/phase-2-preparing-to-enable-at-scale +contentType: tutorials --- > [!TIP] diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md similarity index 93% rename from content/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md rename to content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md index ed0256735419..787f5716b39c 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-3-pilot-programs.md @@ -1,6 +1,6 @@ --- title: 'Phase 3: Pilot programs' -intro: 'You may benefit from beginning with a few high-impact projects and teams with which to pilot an initial rollout. This will allow an initial group within your company to get familiar with GHAS, learn how to enable and configure GHAS, and build a solid foundation on GHAS before rolling out to the remainder of your company.' +intro: You may benefit from beginning with a few high-impact projects and teams with which to pilot an initial rollout. This will allow an initial group within your company to get familiar with GHAS, learn how to enable and configure GHAS, and build a solid foundation on GHAS before rolling out to the remainder of your company. versions: ghes: '*' ghec: '*' @@ -8,6 +8,9 @@ topics: - Code Security - Secret Protection shortTitle: 3. Pilot programs +redirect_from: + - /code-security/adopting-github-advanced-security-at-scale/phase-3-pilot-programs +contentType: tutorials --- >[!TIP] diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation.md similarity index 88% rename from content/code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation.md rename to content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation.md index b1b459a738bf..721810850dde 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation.md @@ -1,6 +1,6 @@ --- title: 'Phase 4: Create internal documentation' -intro: 'You will create internal documentation and then communicate this to the consumers of {% data variables.product.prodname_GHAS %}.' +intro: You will create internal documentation and then communicate this to the consumers of {% data variables.product.prodname_GHAS %}. versions: ghes: '*' ghec: '*' @@ -8,6 +8,9 @@ topics: - Code Security - Secret Protection shortTitle: 4. Create internal documentation +redirect_from: + - /code-security/adopting-github-advanced-security-at-scale/phase-4-create-internal-documentation +contentType: tutorials --- >[!TIP] diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md similarity index 88% rename from content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md rename to content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md index befbe3610d18..8d79e782de21 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning.md @@ -1,6 +1,6 @@ --- title: 'Phase 5: Rollout and scale code scanning' -intro: 'You can {% ifversion security-configuration-enterprise-level %}use security configurations{% else %}leverage the available APIs{% endif %} to rollout {% data variables.product.prodname_code_scanning %} across your enterprise{% ifversion security-configurations %}{% else %} using the repository data you collected earlier{% endif %}.' +intro: You can {% ifversion security-configuration-enterprise-level %}use security configurations{% else %}leverage the available APIs{% endif %} to rollout {% data variables.product.prodname_code_scanning %} across your enterprise{% ifversion security-configurations %}{% else %} using the repository data you collected earlier{% endif %}. versions: ghes: '*' ghec: '*' @@ -8,6 +8,9 @@ topics: - Code Security - Secret Protection shortTitle: 5. Rollout code scanning +redirect_from: + - /code-security/adopting-github-advanced-security-at-scale/phase-5-rollout-and-scale-code-scanning +contentType: tutorials --- >[!TIP] diff --git a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md similarity index 95% rename from content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md rename to content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md index 29aa4e4a9402..57ba27fdec09 100644 --- a/content/code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md +++ b/content/code-security/tutorials/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning.md @@ -1,6 +1,6 @@ --- title: 'Phase 6: Rollout and scale secret scanning' -intro: 'For the final phase, you will focus on the rollout of {% data variables.product.prodname_secret_scanning %}. {% data variables.product.prodname_secret_scanning_caps %} is a more straightforward tool to rollout than {% data variables.product.prodname_code_scanning %}, as it involves less configuration, but it''s critical to have a strategy for handling new and old results.' +intro: For the final phase, you will focus on the rollout of {% data variables.product.prodname_secret_scanning %}. {% data variables.product.prodname_secret_scanning_caps %} is a more straightforward tool to rollout than {% data variables.product.prodname_code_scanning %}, as it involves less configuration, but it's critical to have a strategy for handling new and old results. versions: ghes: '*' ghec: '*' @@ -8,6 +8,9 @@ topics: - Code Security - Secret Protection shortTitle: 6. Rollout secret scanning +redirect_from: + - /code-security/adopting-github-advanced-security-at-scale/phase-6-rollout-and-scale-secret-scanning +contentType: tutorials --- >[!TIP] diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md b/content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md similarity index 98% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md rename to content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md index d93491335667..8df772412566 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries.md +++ b/content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md @@ -1,6 +1,6 @@ --- title: Analyzing your code with CodeQL queries -intro: 'You can run queries against a {% data variables.product.prodname_codeql %} database extracted from a codebase.' +intro: You can run queries against a {% data variables.product.prodname_codeql %} database extracted from a codebase. product: '{% data reusables.gated-features.codeql %}' shortTitle: Analyzing code versions: @@ -14,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/analyzing-databases-with-the-codeql-cli - /code-security/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/analyzing-your-code-with-codeql-queries +contentType: tutorials --- ## About analyzing databases with the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs.md b/content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md similarity index 97% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs.md rename to content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md index 40f61d290d41..95083cf19990 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs.md +++ b/content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md @@ -1,6 +1,6 @@ --- title: Creating and working with CodeQL packs -intro: 'You can use {% data variables.product.prodname_codeql %} packs to create, share, depend on, and run {% data variables.product.prodname_codeql %} queries and libraries.' +intro: You can use {% data variables.product.prodname_codeql %} packs to create, share, depend on, and run {% data variables.product.prodname_codeql %} queries and libraries. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/creating-and-working-with-codeql-packs - /code-security/codeql-cli/using-the-codeql-cli/creating-and-working-with-codeql-packs + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-and-working-with-codeql-packs +contentType: tutorials --- ## About {% data variables.product.prodname_codeql %} packs and the {% data variables.product.prodname_codeql_cli %} diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites.md b/content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md similarity index 98% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites.md rename to content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md index 61ade5aa67be..e6fcd9cdf3e4 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites.md +++ b/content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md @@ -1,6 +1,6 @@ --- title: Creating CodeQL query suites -intro: 'You can create query suites for queries you frequently use in your {% data variables.product.prodname_codeql %} analyses.' +intro: You can create query suites for queries you frequently use in your {% data variables.product.prodname_codeql %} analyses. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/creating-codeql-query-suites - /code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites +contentType: tutorials --- ## About creating {% data variables.product.prodname_codeql %} query suites diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md b/content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md similarity index 97% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md rename to content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md index 94f4b969366c..63c8bdb91b64 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs.md +++ b/content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md @@ -1,6 +1,6 @@ --- title: Customizing analysis with CodeQL packs -intro: 'You can use {% data variables.product.prodname_codeql %} packs to run {% data variables.product.prodname_codeql %} queries maintained by other people, or to share {% data variables.product.prodname_codeql %} queries that you''ve developed.' +intro: You can use {% data variables.product.prodname_codeql %} packs to run {% data variables.product.prodname_codeql %} queries maintained by other people, or to share {% data variables.product.prodname_codeql %} queries that you've developed. shortTitle: Customizing analysis product: '{% data reusables.gated-features.codeql %}' versions: @@ -14,6 +14,8 @@ topics: redirect_from: - /code-security/codeql-cli/about-codeql-packs - /code-security/codeql-cli/codeql-cli-reference/about-codeql-packs + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs +contentType: tutorials --- ## About {% data variables.product.prodname_codeql %} packs diff --git a/content/code-security/tutorials/customize-code-scanning/index.md b/content/code-security/tutorials/customize-code-scanning/index.md new file mode 100644 index 000000000000..17a12f1d3a79 --- /dev/null +++ b/content/code-security/tutorials/customize-code-scanning/index.md @@ -0,0 +1,23 @@ +--- +title: Customize code scanning +intro: Learn how to customize code scanning to meet your project's unique security needs by creating and using CodeQL packs and custom queries. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Code Security + - Code scanning + - CodeQL +contentType: tutorials +children: + - /preparing-your-code-for-codeql-analysis + - /analyzing-your-code-with-codeql-queries + - /uploading-codeql-analysis-results-to-github + - /running-codeql-code-scanning-in-a-container + - /customizing-analysis-with-codeql-packs + - /creating-codeql-query-suites + - /testing-custom-queries + - /creating-and-working-with-codeql-packs + - /publishing-and-using-codeql-packs +--- diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis.md b/content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md similarity index 99% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis.md rename to content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md index 39d3a7e08239..1d94a6f999d7 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis.md +++ b/content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md @@ -1,6 +1,6 @@ --- title: Preparing your code for CodeQL analysis -intro: 'You can build a {% data variables.product.prodname_codeql %} database containing the data needed to analyze your code.' +intro: You can build a {% data variables.product.prodname_codeql %} database containing the data needed to analyze your code. shortTitle: Preparing code for analysis permissions: '{% data reusables.permissions.repo-checkout %}' product: '{% data reusables.gated-features.codeql %}' @@ -19,6 +19,8 @@ redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system - /github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-code-scanning-in-your-ci-system - /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis +contentType: tutorials --- diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md b/content/code-security/tutorials/customize-code-scanning/publishing-and-using-codeql-packs.md similarity index 99% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md rename to content/code-security/tutorials/customize-code-scanning/publishing-and-using-codeql-packs.md index 6a0952b94bf2..c356ed620f3a 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs.md +++ b/content/code-security/tutorials/customize-code-scanning/publishing-and-using-codeql-packs.md @@ -1,6 +1,6 @@ --- title: Publishing and using CodeQL packs -intro: 'You can publish your own {% data variables.product.prodname_codeql %} packs and use packs published by other people.' +intro: You can publish your own {% data variables.product.prodname_codeql %} packs and use packs published by other people. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/publishing-and-using-codeql-packs - /code-security/codeql-cli/using-the-codeql-cli/publishing-and-using-codeql-packs + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs +contentType: tutorials --- {% ifversion ghec or ghes %} diff --git a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container.md b/content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md similarity index 94% rename from content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container.md rename to content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md index f34d0e7c3052..8c276b4003af 100644 --- a/content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container.md +++ b/content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md @@ -1,7 +1,7 @@ --- title: Running CodeQL code scanning in a container shortTitle: '{% data variables.product.prodname_code_scanning_caps %} in a container' -intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.' +intro: You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container. product: '{% data reusables.gated-features.code-scanning %}' redirect_from: - /github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container @@ -9,11 +9,11 @@ redirect_from: - /code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container - /github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container + - /code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/running-codeql-code-scanning-in-a-container versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Code Security - Code scanning @@ -22,6 +22,7 @@ topics: - Repositories - Containers - Java +contentType: tutorials --- ## About {% data variables.product.prodname_code_scanning %} with a containerized build diff --git a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md b/content/code-security/tutorials/customize-code-scanning/testing-custom-queries.md similarity index 97% rename from content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md rename to content/code-security/tutorials/customize-code-scanning/testing-custom-queries.md index 448bfa67c7a6..4459b2a6ed93 100644 --- a/content/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries.md +++ b/content/code-security/tutorials/customize-code-scanning/testing-custom-queries.md @@ -1,6 +1,6 @@ --- title: Testing custom queries -intro: 'You can set up tests for your {% data variables.product.prodname_codeql %} queries to ensure that they continue to return the expected results with new releases of the {% data variables.product.prodname_codeql_cli %}.' +intro: You can set up tests for your {% data variables.product.prodname_codeql %} queries to ensure that they continue to return the expected results with new releases of the {% data variables.product.prodname_codeql_cli %}. product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -13,6 +13,8 @@ topics: redirect_from: - /code-security/codeql-cli/testing-custom-queries - /code-security/codeql-cli/using-the-codeql-cli/testing-custom-queries + - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/testing-custom-queries +contentType: tutorials --- ## About testing custom queries diff --git a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md b/content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md similarity index 97% rename from content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md rename to content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md index 585de6fcccbc..c0a90c2bab4e 100644 --- a/content/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github.md +++ b/content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md @@ -1,7 +1,7 @@ --- title: Uploading CodeQL analysis results to GitHub shortTitle: Uploading results to GitHub -intro: 'You can use the {% data variables.product.prodname_codeql_cli %} to upload {% data variables.product.prodname_codeql %} analysis results to {% data variables.product.github %}.' +intro: You can use the {% data variables.product.prodname_codeql_cli %} to upload {% data variables.product.prodname_codeql %} analysis results to {% data variables.product.github %}. permissions: '{% data reusables.permissions.code-scanning-all-alerts %}' product: '{% data reusables.gated-features.codeql %}' versions: @@ -12,6 +12,9 @@ topics: - Code Security - Code scanning - CodeQL +redirect_from: + - /code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github +contentType: tutorials --- ## About SARIF output diff --git a/content/code-security/security-advisories/working-with-repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability.md b/content/code-security/tutorials/fix-reported-vulnerabilities/collaborate-in-a-fork.md similarity index 97% rename from content/code-security/security-advisories/working-with-repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability.md rename to content/code-security/tutorials/fix-reported-vulnerabilities/collaborate-in-a-fork.md index 63a5c228fede..372f5f85d2e4 100644 --- a/content/code-security/security-advisories/working-with-repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability.md +++ b/content/code-security/tutorials/fix-reported-vulnerabilities/collaborate-in-a-fork.md @@ -8,16 +8,17 @@ redirect_from: - /code-security/security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-security-vulnerability - /code-security/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability - /code-security/security-advisories/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability + - /code-security/security-advisories/working-with-repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability versions: fpt: '*' ghec: '*' -type: how_to topics: - Security advisories - Vulnerabilities - Collaboration - Forks -shortTitle: Temporary private forks +shortTitle: Collaborate in a fork +contentType: tutorials --- {% data reusables.security-advisory.repository-level-advisory-note %} diff --git a/content/code-security/tutorials/fix-reported-vulnerabilities/index.md b/content/code-security/tutorials/fix-reported-vulnerabilities/index.md new file mode 100644 index 000000000000..0dfe0622fff8 --- /dev/null +++ b/content/code-security/tutorials/fix-reported-vulnerabilities/index.md @@ -0,0 +1,12 @@ +--- +title: Fixing reported vulnerabilities +shortTitle: Fix reported vulnerabilities +intro: Build skills in collaborating on fixing security vulnerabilities in repositories. +versions: + fpt: '*' + ghec: '*' +contentType: tutorials +children: + - collaborate-in-a-fork + - write-security-advisories +--- diff --git a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories.md b/content/code-security/tutorials/fix-reported-vulnerabilities/write-security-advisories.md similarity index 97% rename from content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories.md rename to content/code-security/tutorials/fix-reported-vulnerabilities/write-security-advisories.md index 36ff38b19a68..8743ca38802a 100644 --- a/content/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories.md +++ b/content/code-security/tutorials/fix-reported-vulnerabilities/write-security-advisories.md @@ -5,14 +5,16 @@ versions: fpt: '*' ghec: '*' permissions: '{% data reusables.permissions.security-repo-enable %}' -type: how_to +contentType: tutorials topics: - Security advisories - Vulnerabilities -shortTitle: Best practices +shortTitle: Write security advisories redirect_from: - /code-security/repository-security-advisories/best-practices-for-writing-repository-security-advisories - /code-security/security-advisories/guidance-on-reporting-and-writing/best-practices-for-writing-repository-security-advisories + - /code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/best-practices-for-writing-repository-security-advisories + - /code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities --- {% data reusables.security-advisory.security-researcher-cannot-create-advisory %} diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md b/content/code-security/tutorials/implement-supply-chain-best-practices/end-to-end-supply-chain-overview.md similarity index 89% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/end-to-end-supply-chain-overview.md index 296cada673dd..e713b8865a1f 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/end-to-end-supply-chain-overview.md @@ -2,17 +2,19 @@ title: Securing your end-to-end supply chain shortTitle: Overview allowTitleToDifferFromFilename: true -intro: 'Introducing best practice guides on complete end-to-end supply chain security including personal accounts, code, and build processes.' +intro: Introducing best practice guides on complete end-to-end supply chain security including personal accounts, code, and build processes. versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Organizations - Teams - Dependencies - Code Security +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview +contentType: tutorials --- ## What is the end-to-end supply chain? diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/index.md b/content/code-security/tutorials/implement-supply-chain-best-practices/index.md similarity index 51% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/index.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/index.md index 598d609e0452..fc1afaae7c8b 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/index.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/index.md @@ -1,6 +1,6 @@ --- -title: End-to-end supply chain -intro: 'How to think about securing your user accounts, your code, and your build process' +title: Implement supply chain best practices +intro: How to think about securing your user accounts, your code, and your build process versions: fpt: '*' ghec: '*' @@ -16,4 +16,8 @@ children: - /securing-accounts - /securing-code - /securing-builds +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain +contentType: tutorials --- + diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md similarity index 99% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md index 51884a55312c..0e56b685aa43 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md @@ -7,13 +7,15 @@ versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Organizations - Teams - SSH - Security - Accounts +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts +contentType: tutorials --- ## About this guide diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md similarity index 98% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md index 2c83c9acb40e..57cfd1cc171a 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md @@ -7,12 +7,14 @@ versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Fundamentals - Security - CI - CD +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain/securing-builds +contentType: tutorials --- ## About this guide diff --git a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md similarity index 98% rename from content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md rename to content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md index 278daddd6761..0cdc432e1dd2 100644 --- a/content/code-security/supply-chain-security/end-to-end-supply-chain/securing-code.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md @@ -7,7 +7,6 @@ versions: fpt: '*' ghec: '*' ghes: '*' -type: overview topics: - Dependabot - Security updates @@ -15,6 +14,9 @@ topics: - Code Security - Secret Protection - Secret scanning +redirect_from: + - /code-security/supply-chain-security/end-to-end-supply-chain/securing-code +contentType: tutorials --- ## About this guide diff --git a/content/code-security/code-quality/tutorials/fix-findings-in-prs.md b/content/code-security/tutorials/improve-code-quality/fix-findings-in-prs.md similarity index 94% rename from content/code-security/code-quality/tutorials/fix-findings-in-prs.md rename to content/code-security/tutorials/improve-code-quality/fix-findings-in-prs.md index 3a9ffe17c743..557c6b5593b9 100644 --- a/content/code-security/code-quality/tutorials/fix-findings-in-prs.md +++ b/content/code-security/tutorials/improve-code-quality/fix-findings-in-prs.md @@ -1,7 +1,7 @@ --- title: Fixing code quality findings before merging your pull request shortTitle: Fix findings in PRs -intro: 'Catch quality issues before they reach your default branch and fix them with {% data variables.copilot.copilot_autofix_short %} and {% data variables.copilot.copilot_coding_agent %}.' +intro: Catch quality issues before they reach your default branch and fix them with {% data variables.copilot.copilot_autofix_short %} and {% data variables.copilot.copilot_coding_agent %}. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' @@ -9,6 +9,8 @@ permissions: '{% data reusables.permissions.code-quality-see-repo-findings %}' topics: - Code Quality contentType: tutorials +redirect_from: + - /code-security/code-quality/tutorials/fix-findings-in-prs --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/code-quality/tutorials/improve-recent-merges.md b/content/code-security/tutorials/improve-code-quality/improve-recent-merges.md similarity index 96% rename from content/code-security/code-quality/tutorials/improve-recent-merges.md rename to content/code-security/tutorials/improve-code-quality/improve-recent-merges.md index 221ada52a503..79ae15497de9 100644 --- a/content/code-security/code-quality/tutorials/improve-recent-merges.md +++ b/content/code-security/tutorials/improve-code-quality/improve-recent-merges.md @@ -1,7 +1,7 @@ --- title: Improving the quality of recently merged code with AI shortTitle: Improve recent merges -intro: 'Explore {% data variables.product.prodname_code_quality %} findings for recently merged code and fix with {% data variables.copilot.copilot_autofix_short %} or delegate remediation work to {% data variables.copilot.copilot_coding_agent %}.' +intro: Explore {% data variables.product.prodname_code_quality %} findings for recently merged code and fix with {% data variables.copilot.copilot_autofix_short %} or delegate remediation work to {% data variables.copilot.copilot_coding_agent %}. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' @@ -11,6 +11,7 @@ topics: contentType: tutorials redirect_from: - /code-security/code-quality/tutorials/improve-active-code + - /code-security/code-quality/tutorials/improve-recent-merges --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/code-quality/tutorials/improve-your-codebase.md b/content/code-security/tutorials/improve-code-quality/improve-your-codebase.md similarity index 96% rename from content/code-security/code-quality/tutorials/improve-your-codebase.md rename to content/code-security/tutorials/improve-code-quality/improve-your-codebase.md index fe1e7c19e29a..1c000054ddac 100644 --- a/content/code-security/code-quality/tutorials/improve-your-codebase.md +++ b/content/code-security/tutorials/improve-code-quality/improve-your-codebase.md @@ -1,7 +1,7 @@ --- title: Improving the quality of your repository's code shortTitle: Improve your codebase -intro: 'Assess and remediate code quality issues detected on your default branch so you can improve the quality of your codebase. As you progress, you''ll see your repository''s code quality rating rise as a result.' +intro: Assess and remediate code quality issues detected on your default branch so you can improve the quality of your codebase. As you progress, you'll see your repository's code quality rating rise as a result. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' @@ -9,6 +9,8 @@ permissions: '{% data reusables.permissions.code-quality-see-repo-findings %}' topics: - Code Quality contentType: tutorials +redirect_from: + - /code-security/code-quality/tutorials/improve-your-codebase --- {% data reusables.code-quality.code-quality-preview-note %} diff --git a/content/code-security/tutorials/improve-code-quality/index.md b/content/code-security/tutorials/improve-code-quality/index.md new file mode 100644 index 000000000000..3a08f87c5960 --- /dev/null +++ b/content/code-security/tutorials/improve-code-quality/index.md @@ -0,0 +1,18 @@ +--- +title: Improving the quality of your code +shortTitle: Improve code quality +intro: Build skills and knowledge about {% data variables.product.prodname_code_quality %} through examples. +versions: + feature: code-quality +topics: + - Code Quality +contentType: tutorials +children: + - /quickstart + - /fix-findings-in-prs + - /improve-your-codebase + - /improve-recent-merges +redirect_from: + - /code-security/code-quality/tutorials +--- + diff --git a/content/code-security/code-quality/get-started/quickstart.md b/content/code-security/tutorials/improve-code-quality/quickstart.md similarity index 93% rename from content/code-security/code-quality/get-started/quickstart.md rename to content/code-security/tutorials/improve-code-quality/quickstart.md index d83df156c546..4e07d7ba7b84 100644 --- a/content/code-security/code-quality/get-started/quickstart.md +++ b/content/code-security/tutorials/improve-code-quality/quickstart.md @@ -1,6 +1,6 @@ --- title: Quickstart for GitHub Code Quality -intro: 'Review code quality findings, generate a {% data variables.copilot.copilot_autofix_short %}, and merge a pull request to improve reliability and maintainability with {% data variables.product.prodname_code_quality %}.' +intro: Review code quality findings, generate a {% data variables.copilot.copilot_autofix_short %}, and merge a pull request to improve reliability and maintainability with {% data variables.product.prodname_code_quality %}. allowTitleToDifferFromFilename: true versions: feature: code-quality @@ -9,7 +9,10 @@ product: '{% data reusables.gated-features.code-quality-availability %}' permissions: '{% data reusables.permissions.code-quality-see-repo-findings %}' topics: - Code Quality -contentType: get-started +contentType: tutorials +redirect_from: + - /code-security/code-quality/get-started/quickstart + - /code-security/code-quality/get-started --- ## Introduction diff --git a/content/code-security/tutorials/index.md b/content/code-security/tutorials/index.md new file mode 100644 index 000000000000..d68285311f25 --- /dev/null +++ b/content/code-security/tutorials/index.md @@ -0,0 +1,30 @@ +--- +title: Tutorials for security and code quality +shortTitle: Tutorials +intro: Build skills and knowledge about {% data variables.product.github %}'s security and code quality features through examples and hands-on activities. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: tutorials +children: + - /trialing-github-advanced-security + - /adopting-github-advanced-security-at-scale + - /secure-your-organization + - /remediate-leaked-secrets + - /secret-scanning-partner-program + - /customize-code-scanning + - /secure-your-dependencies + - /implement-supply-chain-best-practices + - /manage-security-alerts + - /improve-code-quality + - /fix-reported-vulnerabilities +--- diff --git a/content/code-security/code-scanning/managing-code-scanning-alerts/best-practices-for-participating-in-a-security-campaign.md b/content/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md similarity index 95% rename from content/code-security/code-scanning/managing-code-scanning-alerts/best-practices-for-participating-in-a-security-campaign.md rename to content/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md index fdbe9ff4e022..d8f3a61d39aa 100644 --- a/content/code-security/code-scanning/managing-code-scanning-alerts/best-practices-for-participating-in-a-security-campaign.md +++ b/content/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md @@ -1,11 +1,11 @@ --- title: Best practices for participating in a code security campaign shortTitle: Best practices for campaigns -intro: 'Learn how you can successfully take part in a security campaign for {% data variables.product.prodname_code_scanning %} alerts and how it can benefit your career as well as your code.' +intro: Learn how you can successfully take part in a security campaign for {% data variables.product.prodname_code_scanning %} alerts and how it can benefit your career as well as your code. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.code-scanning-all-alerts %}' product: '{% data reusables.gated-features.security-campaigns %}' -type: how_to +contentType: tutorials versions: feature: security-campaigns topics: @@ -13,6 +13,8 @@ topics: - Code scanning - Alerts - Repositories +redirect_from: + - /code-security/code-scanning/managing-code-scanning-alerts/best-practices-for-participating-in-a-security-campaign --- ## What is a code security campaign diff --git a/content/code-security/tutorials/manage-security-alerts/index.md b/content/code-security/tutorials/manage-security-alerts/index.md new file mode 100644 index 000000000000..aa77103748bf --- /dev/null +++ b/content/code-security/tutorials/manage-security-alerts/index.md @@ -0,0 +1,21 @@ +--- +title: Manage security alerts +shortTitle: Manage security alerts +intro: Build skills and knowledge about {% data variables.product.github %}'s security and code quality features through examples and hands-on activities. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +topics: + - Secret Protection + - Secret scanning + - Code Security + - Code scanning + - Vulnerabilities + - Dependencies + - Dependabot +contentType: tutorials +children: + - prioritizing-dependabot-alerts-using-metrics + - best-practices-for-participating-in-a-security-campaign +--- diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/prioritizing-dependabot-alerts-using-metrics.md b/content/code-security/tutorials/manage-security-alerts/prioritizing-dependabot-alerts-using-metrics.md similarity index 92% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/prioritizing-dependabot-alerts-using-metrics.md rename to content/code-security/tutorials/manage-security-alerts/prioritizing-dependabot-alerts-using-metrics.md index d1c58040742d..c859788f8fcd 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/prioritizing-dependabot-alerts-using-metrics.md +++ b/content/code-security/tutorials/manage-security-alerts/prioritizing-dependabot-alerts-using-metrics.md @@ -1,7 +1,7 @@ --- title: Prioritizing Dependabot alerts using metrics shortTitle: Prioritize Dependabot alerts using metrics -intro: 'You can prioritize {% data variables.product.prodname_dependabot_alerts %} in your organization by analyzing the provided metrics. Using this approach, you can tell your developers to focus on the most important vulnerabilities first.' +intro: You can prioritize {% data variables.product.prodname_dependabot_alerts %} in your organization by analyzing the provided metrics. Using this approach, you can tell your developers to focus on the most important vulnerabilities first. allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.security-overview-fpt-cs-only %}' permissions: '{% data reusables.permissions.security-org-enable %}' @@ -16,6 +16,8 @@ topics: - Security redirect_from: - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilites/prioritizing-dependabot-alerts-using-metrics + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/prioritizing-dependabot-alerts-using-metrics + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities --- ## Prioritizing {% data variables.product.prodname_dependabot_alerts %} using metrics diff --git a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts.md b/content/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts.md similarity index 97% rename from content/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts.md rename to content/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts.md index 2b3b29a2465e..712c6c941aac 100644 --- a/content/code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts.md +++ b/content/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts.md @@ -1,12 +1,11 @@ --- title: Evaluating alerts from secret scanning -intro: 'Learn about additional features that can help you evaluate alerts and prioritize their remediation, such as checking a secret''s validity.' +intro: Learn about additional features that can help you evaluate alerts and prioritize their remediation, such as checking a secret's validity. permissions: '{% data reusables.permissions.secret-scanning-alerts %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: how_to topics: - Secret scanning - Secret Protection @@ -14,6 +13,9 @@ topics: - Repositories shortTitle: Evaluate alerts allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/secret-scanning/managing-alerts-from-secret-scanning/evaluating-alerts +contentType: tutorials --- ## About evaluating alerts diff --git a/content/code-security/tutorials/remediate-leaked-secrets/index.md b/content/code-security/tutorials/remediate-leaked-secrets/index.md new file mode 100644 index 000000000000..39f59c330cc0 --- /dev/null +++ b/content/code-security/tutorials/remediate-leaked-secrets/index.md @@ -0,0 +1,12 @@ +--- +title: Remediate leaked secrets +intro: Learn how to identify and remediate leaked secrets in your codebase. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: tutorials +children: + - /evaluating-alerts + - /remediating-a-leaked-secret +--- diff --git a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret.md b/content/code-security/tutorials/remediate-leaked-secrets/remediating-a-leaked-secret.md similarity index 99% rename from content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret.md rename to content/code-security/tutorials/remediate-leaked-secrets/remediating-a-leaked-secret.md index 8bc4a2f89512..9cc81e0cf0d9 100644 --- a/content/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret.md +++ b/content/code-security/tutorials/remediate-leaked-secrets/remediating-a-leaked-secret.md @@ -3,7 +3,6 @@ title: Remediating a leaked secret in your repository shortTitle: Remediate a leaked secret allowTitleToDifferFromFilename: true intro: Learn how to respond effectively to a leaked secret in your {% data variables.product.github %} repository. -type: how_to topics: - Secret scanning - Secret Protection @@ -13,6 +12,9 @@ versions: fpt: '*' ghec: '*' ghes: '*' +redirect_from: + - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret +contentType: tutorials --- ## Introduction diff --git a/content/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program.md b/content/code-security/tutorials/secret-scanning-partner-program.md similarity index 97% rename from content/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program.md rename to content/code-security/tutorials/secret-scanning-partner-program.md index 92cddfced8cf..e742e073bd1b 100644 --- a/content/code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program.md +++ b/content/code-security/tutorials/secret-scanning-partner-program.md @@ -1,6 +1,6 @@ --- title: Secret scanning partner program -intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.' +intro: As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider's verify endpoint. product: '{% data reusables.gated-features.secret-scanning-partner-alerts %}' redirect_from: - /partnerships/token-scanning @@ -8,6 +8,8 @@ redirect_from: - /developers/overview/secret-scanning - /developers/overview/secret-scanning-partner-program - /code-security/secret-scanning/secret-scanning-partner-program + - /code-security/secret-scanning/secret-scanning-partnership-program/secret-scanning-partner-program + - /code-security/secret-scanning/secret-scanning-partnership-program versions: fpt: '*' ghec: '*' @@ -16,6 +18,7 @@ topics: - Secret scanning - Secret Protection shortTitle: Partner program +contentType: tutorials --- {% data variables.product.prodname_dotcom %} scans repositories for known secret formats to prevent fraudulent use of credentials that were committed accidentally. {% data variables.product.prodname_secret_scanning_caps %} happens by default on public repositories and public npm packages. Repository administrators and organization owners can also enable {% data variables.product.prodname_secret_scanning %} on private repositories. As a service provider, you can partner with {% data variables.product.prodname_dotcom %} so that your secret formats are included in our {% data variables.product.prodname_secret_scanning %}. diff --git a/content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md b/content/code-security/tutorials/secure-your-dependencies/automating-dependabot-with-github-actions.md similarity index 97% rename from content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md rename to content/code-security/tutorials/secure-your-dependencies/automating-dependabot-with-github-actions.md index 8cf6baf132a5..d6de57f93ce1 100644 --- a/content/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions.md +++ b/content/code-security/tutorials/secure-your-dependencies/automating-dependabot-with-github-actions.md @@ -1,12 +1,12 @@ --- title: Automating Dependabot with GitHub Actions -intro: 'Examples of how you can use {% data variables.product.prodname_actions %} to automate common {% data variables.product.prodname_dependabot %} related tasks.' +intro: Examples of how you can use {% data variables.product.prodname_actions %} to automate common {% data variables.product.prodname_dependabot %} related tasks. permissions: '{% data reusables.permissions.dependabot-various-tasks %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: tutorials topics: - Actions - Dependabot @@ -18,6 +18,7 @@ topics: shortTitle: Use Dependabot with Actions redirect_from: - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions + - /code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions --- {% ifversion dependabot-on-actions-opt-in %} diff --git a/content/code-security/dependabot/working-with-dependabot/configuring-multi-ecosystem-updates.md b/content/code-security/tutorials/secure-your-dependencies/configuring-multi-ecosystem-updates.md similarity index 97% rename from content/code-security/dependabot/working-with-dependabot/configuring-multi-ecosystem-updates.md rename to content/code-security/tutorials/secure-your-dependencies/configuring-multi-ecosystem-updates.md index 504723d8c1cc..91137c4edd70 100644 --- a/content/code-security/dependabot/working-with-dependabot/configuring-multi-ecosystem-updates.md +++ b/content/code-security/tutorials/secure-your-dependencies/configuring-multi-ecosystem-updates.md @@ -1,9 +1,9 @@ --- title: Configuring multi-ecosystem updates for Dependabot -intro: 'Learn how to configure {% data variables.product.prodname_dependabot %} to group updates across different ecosystems so that you receive a single, consolidated pull request per group instead of one pull request for each ecosystem.' +intro: Learn how to configure {% data variables.product.prodname_dependabot %} to group updates across different ecosystems so that you receive a single, consolidated pull request per group instead of one pull request for each ecosystem. permissions: '{% data reusables.permissions.dependabot-yml-configure %}' allowTitleToDifferFromFilename: true -type: how_to +contentType: tutorials versions: fpt: '*' ghec: '*' @@ -14,7 +14,9 @@ topics: - Repositories - Dependencies - Pull requests -shortTitle: Multi-ecosystem updates +shortTitle: Configure multi-ecosystem updates +redirect_from: + - /code-security/dependabot/working-with-dependabot/configuring-multi-ecosystem-updates --- ## About multi-ecosystem updates diff --git a/content/code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs.md b/content/code-security/tutorials/secure-your-dependencies/customizing-dependabot-prs.md similarity index 98% rename from content/code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs.md rename to content/code-security/tutorials/secure-your-dependencies/customizing-dependabot-prs.md index c4a310f400a4..4ee29eab82ce 100644 --- a/content/code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs.md +++ b/content/code-security/tutorials/secure-your-dependencies/customizing-dependabot-prs.md @@ -1,13 +1,13 @@ --- title: Customizing Dependabot pull requests to fit your processes -intro: 'Learn how to tailor your Dependabot pull requests to better suit your own internal workflows.' +intro: Learn how to tailor your Dependabot pull requests to better suit your own internal workflows. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.dependabot-yml-configure %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: tutorials topics: - Dependabot - Version updates @@ -15,6 +15,8 @@ topics: - Dependencies - Pull requests shortTitle: Customize Dependabot PRs +redirect_from: + - /code-security/dependabot/dependabot-version-updates/customizing-dependabot-prs --- There are various ways to customize your {% data variables.product.prodname_dependabot %} pull requests so that they better suit your own internal processes. diff --git a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/customizing-your-dependency-review-action-configuration.md b/content/code-security/tutorials/secure-your-dependencies/customizing-your-dependency-review-action-configuration.md similarity index 95% rename from content/code-security/supply-chain-security/understanding-your-software-supply-chain/customizing-your-dependency-review-action-configuration.md rename to content/code-security/tutorials/secure-your-dependencies/customizing-your-dependency-review-action-configuration.md index 39e2ae2893ae..ff950fbf4b71 100644 --- a/content/code-security/supply-chain-security/understanding-your-software-supply-chain/customizing-your-dependency-review-action-configuration.md +++ b/content/code-security/tutorials/secure-your-dependencies/customizing-your-dependency-review-action-configuration.md @@ -1,17 +1,19 @@ --- title: Customizing your dependency review action configuration shortTitle: Customize dependency review action -intro: 'Learn how to add a basic customization to your dependency review action configuration.' +intro: Learn how to add a basic customization to your dependency review action configuration. permissions: '{% data reusables.permissions.security-repo-enable %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: tutorial +contentType: tutorials topics: - Dependency graph - Dependencies - Repositories +redirect_from: + - /code-security/supply-chain-security/understanding-your-software-supply-chain/customizing-your-dependency-review-action-configuration --- ## Introduction diff --git a/content/code-security/getting-started/dependabot-quickstart-guide.md b/content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide.md similarity index 98% rename from content/code-security/getting-started/dependabot-quickstart-guide.md rename to content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide.md index 492a4ede1bd9..d856f10390af 100644 --- a/content/code-security/getting-started/dependabot-quickstart-guide.md +++ b/content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide.md @@ -1,12 +1,12 @@ --- title: Dependabot quickstart guide -intro: 'Find and fix vulnerable dependencies you rely on with {% data variables.product.prodname_dependabot %}.' +intro: Find and fix vulnerable dependencies you rely on with {% data variables.product.prodname_dependabot %}. product: '{% data reusables.gated-features.dependabot-alerts %}' versions: fpt: '*' ghes: '*' ghec: '*' -type: quick_start +contentType: tutorials topics: - Dependabot - Alerts @@ -14,6 +14,8 @@ topics: - Repositories - Dependencies shortTitle: Dependabot quickstart +redirect_from: + - /code-security/getting-started/dependabot-quickstart-guide --- ## About {% data variables.product.prodname_dependabot %} diff --git a/content/code-security/tutorials/secure-your-dependencies/index.md b/content/code-security/tutorials/secure-your-dependencies/index.md new file mode 100644 index 000000000000..d5b67dcd3dad --- /dev/null +++ b/content/code-security/tutorials/secure-your-dependencies/index.md @@ -0,0 +1,18 @@ +--- +title: Secure your dependencies +shortTitle: Secure your dependencies +intro: Build skills to help you keep your dependencies up to date and protected from vulnerabilities using automated tools and workflows. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: tutorials +children: + - /dependabot-quickstart-guide + - /automating-dependabot-with-github-actions + - /optimizing-pr-creation-version-updates + - /setting-dependabot-to-run-on-self-hosted-runners-using-arc + - /configuring-multi-ecosystem-updates + - /customizing-dependabot-prs + - /customizing-your-dependency-review-action-configuration +--- diff --git a/content/code-security/dependabot/dependabot-version-updates/optimizing-pr-creation-version-updates.md b/content/code-security/tutorials/secure-your-dependencies/optimizing-pr-creation-version-updates.md similarity index 96% rename from content/code-security/dependabot/dependabot-version-updates/optimizing-pr-creation-version-updates.md rename to content/code-security/tutorials/secure-your-dependencies/optimizing-pr-creation-version-updates.md index 409b9d7d9b4e..89c75b22f00e 100644 --- a/content/code-security/dependabot/dependabot-version-updates/optimizing-pr-creation-version-updates.md +++ b/content/code-security/tutorials/secure-your-dependencies/optimizing-pr-creation-version-updates.md @@ -1,13 +1,13 @@ --- title: Optimizing the creation of pull requests for Dependabot version updates -intro: 'Learn how to streamline and efficiently manage your {% data variables.product.prodname_dependabot %} pull requests.' +intro: Learn how to streamline and efficiently manage your {% data variables.product.prodname_dependabot %} pull requests. allowTitleToDifferFromFilename: true permissions: '{% data reusables.permissions.dependabot-yml-configure %}' versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to +contentType: tutorials topics: - Dependabot - Version updates @@ -15,6 +15,8 @@ topics: - Dependencies - Pull requests shortTitle: Optimize PR creation +redirect_from: + - /code-security/dependabot/dependabot-version-updates/optimizing-pr-creation-version-updates --- By default, {% data variables.product.prodname_dependabot %} opens a new pull request to update each dependency. When you enable security updates, new pull requests are opened when a vulnerable dependency is found. When you configure version updates for one or more ecosystems, new pull requests are opened when new versions of dependencies are available, with the frequency defined in the `dependabot.yml` file. diff --git a/content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-self-hosted-runners-using-arc.md b/content/code-security/tutorials/secure-your-dependencies/setting-dependabot-to-run-on-self-hosted-runners-using-arc.md similarity index 98% rename from content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-self-hosted-runners-using-arc.md rename to content/code-security/tutorials/secure-your-dependencies/setting-dependabot-to-run-on-self-hosted-runners-using-arc.md index 4d5b45cacf0a..1884bae5defd 100644 --- a/content/code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-self-hosted-runners-using-arc.md +++ b/content/code-security/tutorials/secure-your-dependencies/setting-dependabot-to-run-on-self-hosted-runners-using-arc.md @@ -11,8 +11,11 @@ topics: - Security updates - Dependencies - Pull requests +contentType: tutorials allowTitleToDifferFromFilename: true shortTitle: Configure ARC +redirect_from: + - /code-security/dependabot/working-with-dependabot/setting-dependabot-to-run-on-self-hosted-runners-using-arc --- ## Working with the {% data variables.product.prodname_actions_runner_controller %} (ARC) diff --git a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/best-practice-fix-alerts-at-scale.md b/content/code-security/tutorials/secure-your-organization/best-practice-fix-alerts-at-scale.md similarity index 96% rename from content/code-security/securing-your-organization/fixing-security-alerts-at-scale/best-practice-fix-alerts-at-scale.md rename to content/code-security/tutorials/secure-your-organization/best-practice-fix-alerts-at-scale.md index 5afb721b2457..9b467c0f544b 100644 --- a/content/code-security/securing-your-organization/fixing-security-alerts-at-scale/best-practice-fix-alerts-at-scale.md +++ b/content/code-security/tutorials/secure-your-organization/best-practice-fix-alerts-at-scale.md @@ -1,10 +1,9 @@ --- title: Best practices for fixing security alerts at scale -shortTitle: Best practices -intro: 'Guidance on how to create successful security campaigns that engage developers and help them grow their understanding of secure coding.' +shortTitle: Fix alerts at scale +intro: Guidance on how to create successful security campaigns that engage developers and help them grow their understanding of secure coding. allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.security-campaigns %}' -type: reference audience: - driver contentType: tutorials @@ -15,6 +14,9 @@ topics: - Secret Protection - Organizations - Security +redirect_from: + - /code-security/securing-your-organization/fixing-security-alerts-at-scale/best-practice-fix-alerts-at-scale + - /code-security/securing-your-organization/fixing-security-alerts-at-scale --- ## Elements of a successful security campaign diff --git a/content/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization.md b/content/code-security/tutorials/secure-your-organization/best-practices-for-preventing-data-leaks-in-your-organization.md similarity index 98% rename from content/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization.md rename to content/code-security/tutorials/secure-your-organization/best-practices-for-preventing-data-leaks-in-your-organization.md index 719089e68df5..5a41edc73c19 100644 --- a/content/code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization.md +++ b/content/code-security/tutorials/secure-your-organization/best-practices-for-preventing-data-leaks-in-your-organization.md @@ -1,17 +1,19 @@ --- title: Best practices for preventing data leaks in your organization -intro: 'Learn guidance and recommendations to help you avoid private or sensitive data present in your organization from being exposed.' +intro: Learn guidance and recommendations to help you avoid private or sensitive data present in your organization from being exposed. versions: fpt: '*' ghec: '*' ghes: '*' -type: how_to topics: - Organizations - Vulnerabilities - Secret scanning - Secret Protection shortTitle: Prevent data leaks +redirect_from: + - /code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization +contentType: tutorials --- ## About this guide diff --git a/content/code-security/tutorials/secure-your-organization/index.md b/content/code-security/tutorials/secure-your-organization/index.md new file mode 100644 index 000000000000..5ca7639433d9 --- /dev/null +++ b/content/code-security/tutorials/secure-your-organization/index.md @@ -0,0 +1,16 @@ +--- +title: Securing your organization +shortTitle: Secure your organization +intro: Build skills to help you prevent vulnerabilities and address alerts in your organization. +versions: + fpt: '*' + ghes: '*' + ghec: '*' +contentType: tutorials +children: + - /best-practices-for-preventing-data-leaks-in-your-organization + - /best-practice-fix-alerts-at-scale + - /prioritize-alerts-in-production-code + - /interpreting-secret-risk-assessment-results + - /organizing-remediation-efforts-for-leaked-secrets +--- diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/interpreting-secret-risk-assessment-results.md b/content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md similarity index 90% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/interpreting-secret-risk-assessment-results.md rename to content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md index 2c91017f48b0..a67e21356540 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/interpreting-secret-risk-assessment-results.md +++ b/content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md @@ -1,8 +1,8 @@ --- -title: 'Interpreting secret risk assessment results' -shortTitle: 'Interpret results' -intro: 'Understand the results from your {% data variables.product.prodname_secret_risk_assessment %} and prioritize leak remediation.' -permissions: 'Organization owners, security managers, and users with the **admin** role' +title: Interpreting secret risk assessment results +shortTitle: Interpret secret risk assessment +intro: Understand the results from your {% data variables.product.prodname_secret_risk_assessment %} and prioritize leak remediation. +permissions: Organization owners, security managers, and users with the **admin** role allowTitleToDifferFromFilename: true versions: feature: secret-risk-assessment @@ -11,6 +11,8 @@ topics: - Organizations - Security contentType: tutorials +redirect_from: + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/interpreting-secret-risk-assessment-results --- ## Introduction diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/organizing-remediation-efforts-for-leaked-secrets.md b/content/code-security/tutorials/secure-your-organization/organizing-remediation-efforts-for-leaked-secrets.md similarity index 94% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/organizing-remediation-efforts-for-leaked-secrets.md rename to content/code-security/tutorials/secure-your-organization/organizing-remediation-efforts-for-leaked-secrets.md index 588dc43b739e..9acf69ab2b99 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/organizing-remediation-efforts-for-leaked-secrets.md +++ b/content/code-security/tutorials/secure-your-organization/organizing-remediation-efforts-for-leaked-secrets.md @@ -1,8 +1,8 @@ --- title: Organizing remediation efforts for leaked secrets shortTitle: Organize leak remediation -intro: 'Systematically organize and manage the remediation of leaked secrets using security campaigns and alert assignments.' -permissions: 'Organization owners, security managers, and users with the **admin** role' +intro: Systematically organize and manage the remediation of leaked secrets using security campaigns and alert assignments. +permissions: Organization owners, security managers, and users with the **admin** role allowTitleToDifferFromFilename: true versions: feature: security-campaigns @@ -12,6 +12,8 @@ topics: - Organizations - Security contentType: tutorials +redirect_from: + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/organizing-remediation-efforts-for-leaked-secrets --- ## Introduction diff --git a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/alerts-in-production-code.md b/content/code-security/tutorials/secure-your-organization/prioritize-alerts-in-production-code.md similarity index 92% rename from content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/alerts-in-production-code.md rename to content/code-security/tutorials/secure-your-organization/prioritize-alerts-in-production-code.md index c4e21a5ee2fc..793e05006665 100644 --- a/content/code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/alerts-in-production-code.md +++ b/content/code-security/tutorials/secure-your-organization/prioritize-alerts-in-production-code.md @@ -1,7 +1,7 @@ --- title: Prioritizing Dependabot and code scanning alerts using production context -shortTitle: Alerts in production code -intro: 'Focus remediation on real risk by targeting {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_code_scanning %} alerts in artifacts deployed to production, using metadata from external registries like JFrog Artifactory, your own CI/CD workflows, or from {% data variables.product.prodname_microsoft_defender %}.' +shortTitle: Prioritize alerts in production code +intro: Focus remediation on real risk by targeting {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_code_scanning %} alerts in artifacts deployed to production, using metadata from external registries like JFrog Artifactory, your own CI/CD workflows, or from {% data variables.product.prodname_microsoft_defender %}. versions: fpt: '*' ghec: '*' @@ -14,6 +14,8 @@ topics: - Security redirect_from: - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/prioritizing-dependabot-alerts-using-production-context + - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-vulnerabilities/alerts-in-production-code + - /code-security/tutorials/secure-your-organization/alerts-in-production-code --- {% data reusables.security.production-context-mdc-preview %} diff --git a/content/code-security/trialing-github-advanced-security/enable-security-features-trial.md b/content/code-security/tutorials/trialing-github-advanced-security/enable-security-features-trial.md similarity index 95% rename from content/code-security/trialing-github-advanced-security/enable-security-features-trial.md rename to content/code-security/tutorials/trialing-github-advanced-security/enable-security-features-trial.md index 171c0da1581a..3c0aacb6f6f5 100644 --- a/content/code-security/trialing-github-advanced-security/enable-security-features-trial.md +++ b/content/code-security/tutorials/trialing-github-advanced-security/enable-security-features-trial.md @@ -2,8 +2,7 @@ title: Enabling security features in your trial enterprise shortTitle: Enable security features in trial allowTitleToDifferFromFilename: true -intro: 'Quickly create an enterprise-level configuration and apply {% data variables.product.prodname_cs_and_sp %} features across all repositories in your trial enterprise.' -type: quick_start +intro: Quickly create an enterprise-level configuration and apply {% data variables.product.prodname_cs_and_sp %} features across all repositories in your trial enterprise. permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}' topics: - Code Security @@ -12,6 +11,9 @@ versions: fpt: '*' ghec: '*' ghes: '> 3.15' +redirect_from: + - /code-security/trialing-github-advanced-security/enable-security-features-trial +contentType: tutorials --- This article assumes that you have planned and then started a trial of {% data variables.product.prodname_GHAS %}. For more information, see [AUTOTITLE](/code-security/trialing-github-advanced-security/planning-a-trial-of-ghas). diff --git a/content/code-security/trialing-github-advanced-security/explore-trial-code-scanning.md b/content/code-security/tutorials/trialing-github-advanced-security/explore-trial-code-scanning.md similarity index 96% rename from content/code-security/trialing-github-advanced-security/explore-trial-code-scanning.md rename to content/code-security/tutorials/trialing-github-advanced-security/explore-trial-code-scanning.md index df27727b9b65..b2181850b424 100644 --- a/content/code-security/trialing-github-advanced-security/explore-trial-code-scanning.md +++ b/content/code-security/tutorials/trialing-github-advanced-security/explore-trial-code-scanning.md @@ -1,15 +1,17 @@ --- -title: 'Exploring your enterprise trial of {% data variables.product.prodname_GH_code_security_always %}' -shortTitle: 'Trial {% data variables.product.prodname_code_security %}' +title: Exploring your enterprise trial of {% data variables.product.prodname_GH_code_security_always %} +shortTitle: Trial {% data variables.product.prodname_code_security %} allowTitleToDifferFromFilename: true -intro: 'Introduction to the features of code and dependency scanning available with {% data variables.product.prodname_GH_code_security_always %} in {% data variables.product.prodname_ghe_cloud %} so you can assess their fit to your business needs.' -type: quick_start +intro: Introduction to the features of code and dependency scanning available with {% data variables.product.prodname_GH_code_security_always %} in {% data variables.product.prodname_ghe_cloud %} so you can assess their fit to your business needs. topics: - Code Security versions: fpt: '*' ghec: '*' ghes: '> 3.15' +redirect_from: + - /code-security/trialing-github-advanced-security/explore-trial-code-scanning +contentType: tutorials --- This guide assumes that you have planned and started a trial of {% data variables.product.prodname_GHAS %} for an existing or trial {% data variables.product.github %} enterprise account, see [AUTOTITLE](/code-security/trialing-github-advanced-security/planning-a-trial-of-ghas). diff --git a/content/code-security/trialing-github-advanced-security/explore-trial-secret-scanning.md b/content/code-security/tutorials/trialing-github-advanced-security/explore-trial-secret-scanning.md similarity index 94% rename from content/code-security/trialing-github-advanced-security/explore-trial-secret-scanning.md rename to content/code-security/tutorials/trialing-github-advanced-security/explore-trial-secret-scanning.md index b310ef8275b9..4f5f50f14a1b 100644 --- a/content/code-security/trialing-github-advanced-security/explore-trial-secret-scanning.md +++ b/content/code-security/tutorials/trialing-github-advanced-security/explore-trial-secret-scanning.md @@ -1,15 +1,17 @@ --- -title: 'Exploring your enterprise trial of {% data variables.product.prodname_GH_secret_protection_always %}' -shortTitle: 'Trial Secret Protection' +title: Exploring your enterprise trial of {% data variables.product.prodname_GH_secret_protection_always %} +shortTitle: Trial Secret Protection allowTitleToDifferFromFilename: true -intro: 'Introduction to the features available with {% data variables.product.prodname_GH_secret_protection_always %} in {% data variables.product.prodname_ghe_cloud %} so you can assess their fit to your business needs.' -type: quick_start +intro: Introduction to the features available with {% data variables.product.prodname_GH_secret_protection_always %} in {% data variables.product.prodname_ghe_cloud %} so you can assess their fit to your business needs. topics: - Secret Protection versions: fpt: '*' ghec: '*' ghes: '> 3.15' +redirect_from: + - /code-security/trialing-github-advanced-security/explore-trial-secret-scanning +contentType: tutorials --- This guide assumes that you have planned and started a trial of {% data variables.product.prodname_GHAS %} for an existing or trial {% data variables.product.github %} enterprise account. See [AUTOTITLE](/code-security/trialing-github-advanced-security/planning-a-trial-of-ghas). diff --git a/content/code-security/trialing-github-advanced-security/index.md b/content/code-security/tutorials/trialing-github-advanced-security/index.md similarity index 72% rename from content/code-security/trialing-github-advanced-security/index.md rename to content/code-security/tutorials/trialing-github-advanced-security/index.md index d5a3eefe4830..d6d2d82f1225 100644 --- a/content/code-security/trialing-github-advanced-security/index.md +++ b/content/code-security/tutorials/trialing-github-advanced-security/index.md @@ -1,7 +1,7 @@ --- title: Trialing {% data variables.product.prodname_GHAS %} shortTitle: Trial {% data variables.product.prodname_GHAS %} -intro: 'Determine how you can meet your security goals using {% data variables.product.prodname_GH_cs_and_sp %}.' +intro: Determine how you can meet your security goals using {% data variables.product.prodname_GH_cs_and_sp %}. permissions: '{% data reusables.advanced-security.ghas-trial-permission %}' product: '{% data reusables.gated-features.ghas-trial %}' versions: @@ -18,4 +18,8 @@ children: - /enable-security-features-trial - /explore-trial-secret-scanning - /explore-trial-code-scanning +redirect_from: + - /code-security/trialing-github-advanced-security +contentType: tutorials --- + diff --git a/content/code-security/trialing-github-advanced-security/planning-a-trial-of-ghas.md b/content/code-security/tutorials/trialing-github-advanced-security/planning-a-trial-of-ghas.md similarity index 96% rename from content/code-security/trialing-github-advanced-security/planning-a-trial-of-ghas.md rename to content/code-security/tutorials/trialing-github-advanced-security/planning-a-trial-of-ghas.md index 34b2876e1a02..9148231df654 100644 --- a/content/code-security/trialing-github-advanced-security/planning-a-trial-of-ghas.md +++ b/content/code-security/tutorials/trialing-github-advanced-security/planning-a-trial-of-ghas.md @@ -1,9 +1,8 @@ --- -title: 'Planning a trial of {% data variables.product.prodname_GHAS %}' -shortTitle: 'Plan GHAS trial' +title: Planning a trial of {% data variables.product.prodname_GHAS %} +shortTitle: Plan GHAS trial allowTitleToDifferFromFilename: true -intro: 'Learn how to prepare for a successful trial of {% data variables.product.prodname_AS %}.' -type: overview +intro: Learn how to prepare for a successful trial of {% data variables.product.prodname_AS %}. topics: - Code Security - Secret Protection @@ -11,6 +10,9 @@ versions: fpt: '*' ghec: '*' ghes: '> 3.15' +redirect_from: + - /code-security/trialing-github-advanced-security/planning-a-trial-of-ghas +contentType: tutorials --- ## Is a self-serve trial right for you? diff --git a/content/code-security/trialing-github-advanced-security/trial-advanced-security.md b/content/code-security/tutorials/trialing-github-advanced-security/trial-advanced-security.md similarity index 94% rename from content/code-security/trialing-github-advanced-security/trial-advanced-security.md rename to content/code-security/tutorials/trialing-github-advanced-security/trial-advanced-security.md index 179783e48b1c..379c4269112b 100644 --- a/content/code-security/trialing-github-advanced-security/trial-advanced-security.md +++ b/content/code-security/tutorials/trialing-github-advanced-security/trial-advanced-security.md @@ -1,6 +1,6 @@ --- title: Setting up a trial of GitHub Advanced Security -intro: 'You can try the full set of {% data variables.product.prodname_GHAS %} features for free.' +intro: You can try the full set of {% data variables.product.prodname_GHAS %} features for free. permissions: '{% data reusables.advanced-security.ghas-trial-permission %}' product: '{% data reusables.gated-features.ghas-trial %}' versions: @@ -11,12 +11,13 @@ redirect_from: - /billing/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security - /billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/setting-up-a-trial-of-github-advanced-security - /billing/how-tos/products/trial-advanced-security + - /code-security/trialing-github-advanced-security/trial-advanced-security topics: - Billing - Advanced Security - Enterprise shortTitle: Trial Advanced Security -contentType: how-tos +contentType: tutorials --- ## Prerequisites diff --git a/content/codespaces/developing-in-a-codespace/Mekrix b/content/codespaces/developing-in-a-codespace/Mekrix new file mode 100644 index 000000000000..8b137891791f --- /dev/null +++ b/content/codespaces/developing-in-a-codespace/Mekrix @@ -0,0 +1 @@ + diff --git a/content/contributing/style-guide-and-content-model/about-the-content-model.md b/content/contributing/style-guide-and-content-model/about-the-content-model.md index d07db0d92859..85736888bc74 100644 --- a/content/contributing/style-guide-and-content-model/about-the-content-model.md +++ b/content/contributing/style-guide-and-content-model/about-the-content-model.md @@ -43,8 +43,6 @@ If a new top-level doc set is created, it is added to the homepage. If a category serves as the starting point for using a {% data variables.product.prodname_dotcom %} product or feature, it can be added to the homepage. -For example, under the "Security" grouping on the homepage, in addition to the [Code security](/code-security) top-level doc set, the [Supply chain security](/code-security/supply-chain-security), [Security advisories](/code-security/security-advisories), [{% data variables.product.prodname_dependabot %}](/code-security/dependabot), [{% data variables.product.prodname_code_scanning_caps %}](/code-security/code-scanning), and [{% data variables.product.prodname_secret_scanning_caps %}](/code-security/secret-scanning) categories are included because each of those categories are the entry point to {% data variables.product.prodname_dotcom %} products and features. [Security overview](/code-security/security-overview) is not included on the homepage because it provides additional information for using secure coding features and is not an introduction to a product or feature. - ## Top-level doc set Top-level doc sets are organized around a {% data variables.product.prodname_dotcom %} product, feature, or core workflow. All top-level doc sets appear on the {% data variables.product.prodname_docs %} homepage. You should only create a top-level doc set when there is a large amount of content to be contained in the new doc set, multiple categories that are broken down into map topics, and the topic applies across products, features, or account types. If the content could fit in any existing top-level doc set, it probably belongs in that existing doc set. diff --git a/content/copilot/concepts/agents/about-agent-skills.md b/content/copilot/concepts/agents/about-agent-skills.md index 76d8ef527305..6cf3dd7ee5f4 100644 --- a/content/copilot/concepts/agents/about-agent-skills.md +++ b/content/copilot/concepts/agents/about-agent-skills.md @@ -17,22 +17,23 @@ Agent Skills work with {% data variables.copilot.copilot_coding_agent %}, the {% You can create your own skills to teach {% data variables.product.prodname_copilot_short %} to perform tasks in a specific, repeatable way—or use skills shared online, for example in the [`anthropics/skills`](https://github.com/anthropics/skills) repository or {% data variables.product.company_short %}'s community created [`github/awesome-copilot`](https://github.com/github/awesome-copilot) collection. -Currently, skills can only be created at the repository level. Support for organization-level and enterprise-level skills is coming soon. +{% data variables.product.prodname_copilot_short %} supports: -You can use both skills and custom instructions to teach {% data variables.product.prodname_copilot_short %} how to work in your repository and how to perform specific tasks. We recommend using custom instructions for simple instructions relevant to almost every task (for example information about your repository's coding standards), and skills for more detailed instructions that {% data variables.product.prodname_copilot_short %} should access when relevant. To learn more about repository custom instructions, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). +* Project skills, stored in your repository (`.github/skills` or `.claude/skills`) +* Personal skills, stored in your home directory and shared across projects (`~/.copilot/skills` or `~/.claude/skills`) ({% data variables.copilot.copilot_coding_agent %} and {% data variables.copilot.copilot_cli %} only) + +Support for organization-level and enterprise-level skills is coming soon. > [!NOTE] > {% data reusables.cli.preview-note-cli-body %} +## Creating and adding skills -## Adding skills to your repository +1. Create a subdirectory for your new skill. Each skill should have its own directory (for example, `.github/skills/webapp-testing`). Skill directory names should be lowercase, use hyphens for spaces, and typically match the `name` in the `SKILL.md` frontmatter. -1. Create a `.github/skills` directory to store your skills. + For project skills, specific to a single repository, store your skill under `.github/skills` or `.claude/skills`. - > [!NOTE] - > Skills stored in the `.claude/skills` directory are also supported. - -1. Create a subdirectory for your new skill. Each skill should have its own directory (for example, `.github/skills/webapp-testing`). Skill directory names should be lowercase, use hyphens for spaces, and typically match the `name` in the `SKILL.md` frontmatter. + For personal skills, shared across projects, store your skill under `~/.copilot/skills` or `~/.claude/skills`. 1. Create a `SKILL.md` file with your skill's instructions. @@ -51,7 +52,9 @@ You can use both skills and custom instructions to teach {% data variables.produ ### Example `SKILL.md` file -This file would be located in the `.github/skills/github-actions-failure-debugging` directory. +For a project skill, this file would be located in the `/path/to/repository/.github/skills/github-actions-failure-debugging` directory. + +For a personal skill, this file would be located in the `~/.copilot/skills/github-actions-failure-debugging` directory. ```markdown copy --- @@ -73,3 +76,11 @@ To debug failing GitHub Actions workflows in a pull request, follow this process When performing tasks, {% data variables.product.prodname_copilot_short %} will decide when to use your skills based on your prompt and the skill's description. When {% data variables.product.prodname_copilot_short %} chooses to use a skill, the `SKILL.md` file will be injected in the agent's context, giving the agent access to your instructions. It can then follow those instructions, and use any scripts or examples you may have included in the skill's directory. + +## Skills versus custom instructions + +You can use both skills and custom instructions to teach {% data variables.product.prodname_copilot_short %} how to work in your repository and how to perform specific tasks. + +We recommend using custom instructions for simple instructions relevant to almost every task (for example information about your repository's coding standards), and skills for more detailed instructions that {% data variables.product.prodname_copilot_short %} should access when relevant. + +To learn more about repository custom instructions, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). diff --git a/content/copilot/concepts/agents/about-copilot-cli.md b/content/copilot/concepts/agents/about-copilot-cli.md index a6a0d18928a8..5a93c225a5cb 100644 --- a/content/copilot/concepts/agents/about-copilot-cli.md +++ b/content/copilot/concepts/agents/about-copilot-cli.md @@ -148,9 +148,11 @@ You can customize {% data variables.copilot.copilot_cli %} in a number of ways: * **Custom instructions**: Custom instructions allow you to give {% data variables.product.prodname_copilot_short %} additional context on your project and how to build, test and validate its changes. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-instructions). * **Model Context Protocol (MCP) servers**: MCP servers allow you to give {% data variables.product.prodname_copilot_short %} access to different data sources and tools. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#add-an-mcp-server). -* **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents). +* **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. {% data variables.copilot.copilot_cli %} includes specialized {% data variables.copilot.custom_agents_short %} that it automatically delegates common tasks to. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents). +* **Hooks**: Hooks allow you to execute custom shell commands at key points during agent execution, enabling you to add validation, logging, security scanning, or workflow automation. See [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-hooks). * **Skills**: Skills allow you to enhance the ability of {% data variables.product.prodname_copilot_short %} to perform specialized tasks with instructions, scripts, and resources. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). + ## Security considerations When you use {% data variables.copilot.copilot_cli_short %}, {% data variables.product.prodname_copilot_short %} can perform tasks on your behalf, such as executing or modifying files, or running shell commands. diff --git a/content/copilot/concepts/agents/code-review.md b/content/copilot/concepts/agents/code-review.md index 6c5461b52fae..2f023f1b71e7 100644 --- a/content/copilot/concepts/agents/code-review.md +++ b/content/copilot/concepts/agents/code-review.md @@ -111,16 +111,24 @@ Premium requests generated by users without a license are not attributed to any {% data reusables.copilot.ccr-model-settings %} -## Providing instructions for {% data variables.product.prodname_copilot_short %} code reviews - -You can tailor the reviews that {% data variables.product.prodname_copilot_short %} generates by providing custom instructions. This helps {% data variables.product.prodname_copilot_short %} to review the code in a way that matches your team's coding standards, tools, and practices. See [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions?tool=webui) and [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-organization-instructions). - ## Validating {% data variables.product.prodname_copilot_short %} code reviews {% data variables.product.prodname_copilot_short %} isn't guaranteed to spot all problems or issues in a pull request, and sometimes it will make mistakes. Always validate {% data variables.product.prodname_copilot_short %}'s feedback carefully, and supplement {% data variables.product.prodname_copilot_short %}'s feedback with a human review. For more information, see [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-github-copilot-code-review). +## Enhancing {% data variables.product.prodname_copilot_short %}'s knowledge of a repository + +The more {% data variables.product.prodname_copilot_short %} knows about the code in your repository, the tools you use, and your coding standards and practices, the more accurate and useful its reviews will become. There are two ways you can enhance {% data variables.product.prodname_copilot_short %}'s knowledge of your repositories. + +* **Custom instructions** + + These are short, natural‑language statements that you write and store as one or more files in a repository. If you are the owner of an organization on {% data variables.product.github %} you can also define custom instructions in the settings for your organization. For more information, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#about-repository-custom-instructions). + +* **{% data variables.copilot.copilot_memory %}** ({% data variables.release-phases.public_preview %}) + + If you have a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, you can enable {% data variables.copilot.copilot_memory %}. This allows {% data variables.product.prodname_copilot_short %} to store useful details it has worked out for itself about a repository. {% data variables.product.prodname_copilot_short %} can then use this information when it is reviewing pull requests in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). + ## About automatic pull request reviews By default, {% data variables.product.prodname_copilot_short %} will only review a pull request if it's assigned to the pull request in the same way you would assign a human reviewer. However: diff --git a/content/copilot/concepts/agents/coding-agent/about-coding-agent.md b/content/copilot/concepts/agents/coding-agent/about-coding-agent.md index 932503094f46..c0aaeebd4f79 100644 --- a/content/copilot/concepts/agents/coding-agent/about-coding-agent.md +++ b/content/copilot/concepts/agents/coding-agent/about-coding-agent.md @@ -17,7 +17,7 @@ redirect_from: - /copilot/concepts/coding-agent/about-copilot-coding-agent - /copilot/concepts/coding-agent/coding-agent contentType: concepts -category: +category: - Learn about Copilot --- @@ -91,6 +91,18 @@ Support for selecting a model is coming soon for {% data variables.copilot.copil For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model). +## Enhancing {% data variables.copilot.copilot_coding_agent %}'s knowledge of a repository + +The more {% data variables.copilot.copilot_coding_agent %} knows about the code in your repository, the tools you use, and your coding standards and practices, the more effective it will become. There are two ways you can enhance {% data variables.copilot.copilot_coding_agent %}'s knowledge of a repository. + +* **Custom instructions** + + These are short, natural‑language statements that you write and store as one or more files in a repository. If you are the owner of an organization on {% data variables.product.github %} you can also define custom instructions in the settings for your organization. For more information, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#about-repository-custom-instructions). + +* **{% data variables.copilot.copilot_memory %}** ({% data variables.release-phases.public_preview %}) + + If you have a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, you can enable {% data variables.copilot.copilot_memory %}. This allows {% data variables.product.prodname_copilot_short %} to store useful details it has worked out for itself about a repository. {% data variables.copilot.copilot_coding_agent %} can then use this information when it is working in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). + ## {% data variables.copilot.copilot_coding_agent %} usage costs {% data variables.copilot.copilot_coding_agent %} uses {% data variables.product.prodname_actions %} minutes and {% data variables.product.prodname_copilot_short %} premium requests. @@ -106,6 +118,7 @@ You can customize {% data variables.copilot.copilot_coding_agent %} in a number * **Custom instructions**: Custom instructions allow you to give {% data variables.product.prodname_copilot_short %} additional context on your project and how to build, test and validate its changes. For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). * **Model Context Protocol (MCP) servers**: MCP servers allow you to give {% data variables.product.prodname_copilot_short %} access to different data sources and tools. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp). * **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. For more information, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). +* **Hooks**: Hooks allow you to execute custom shell commands at key points during agent execution, enabling you to add validation, logging, security scanning, or workflow automation. For more information, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-hooks). * **Skills**: Skills allow you to enhance the ability of {% data variables.product.prodname_copilot_short %} to perform specialized tasks with instructions, scripts, and resources. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). ## Built-in security protections @@ -168,7 +181,6 @@ Users can include hidden messages in issues assigned to {% data variables.copilo ### Limitations in {% data variables.copilot.copilot_coding_agent %}'s compatibility with other features * **{% data variables.product.prodname_copilot_short %} isn't able to comply with certain rules that may be configured for your repository**. If you have configured a ruleset or branch protection rule that isn't compatible with {% data variables.copilot.copilot_coding_agent %} (for example the "Require signed commits" rule), access to the agent will be blocked. If the rule is configured using rulesets, you can add {% data variables.product.prodname_copilot_short %} as a bypass actor to enable access. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-branch-or-tag-ruleset). -* **{% data variables.copilot.copilot_coding_agent %} does not work in personal repositories owned by {% data variables.enterprise.prodname_managed_users %}**. This is because {% data variables.copilot.copilot_coding_agent %} requires {% data variables.product.company_short %}-hosted runners, which are not available to personal repositories owned by {% data variables.enterprise.prodname_managed_users %}. See [AUTOTITLE](/actions/using-github-hosted-runners/using-github-hosted-runners/about-github-hosted-runners). * **{% data variables.copilot.copilot_coding_agent %} doesn't account for content exclusions**. Content exclusions allow administrators to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When using {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} will not ignore these files, and will be able to see and update them. See [AUTOTITLE](/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot). * **{% data variables.copilot.copilot_coding_agent %} only works with repositories hosted on {% data variables.product.github %}**. If your repository is stored using a different code hosting platform, {% data variables.product.prodname_copilot_short %} won't be able to work on it. diff --git a/content/copilot/concepts/agents/coding-agent/about-hooks.md b/content/copilot/concepts/agents/coding-agent/about-hooks.md new file mode 100644 index 000000000000..b0004f92764f --- /dev/null +++ b/content/copilot/concepts/agents/coding-agent/about-hooks.md @@ -0,0 +1,164 @@ +--- +title: About hooks +shortTitle: Hooks +intro: 'Extend and customize {% data variables.product.prodname_copilot %} agent behavior by executing custom shell commands at key points during agent execution.' +product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +topics: + - Copilot +contentType: concepts +category: + - Configure Copilot +--- + +## About hooks + +Hooks enable you to execute custom shell commands at strategic points in an agent's workflow, such as when an agent session starts or ends, or before and after a prompt is entered or a tool is called. + +Hooks receive detailed information about agent actions via JSON input, enabling context-aware automation. For example, you can use hooks to: + +* Programmatically approve or deny tool executions. +* Utilize built-in security features like secret scanning to prevent credential leaks. +* Implement custom validation rules and audit logging for compliance. + +{% data variables.product.prodname_copilot_short %} agents support hooks stored in JSON files in your repository at `.github/hooks/*.json`. + +Hooks are available for use with: + +* {% data variables.copilot.copilot_coding_agent %} on {% data variables.product.github %} +* {% data variables.copilot.copilot_cli %} in the terminal + +## Types of hooks + +The following types of hooks are available: + +* **sessionStart**: Executed when a new agent session begins or when resuming an existing session. Can be used to initialize environments, log session starts for auditing, validate project state, and set up temporary resources. +* **sessionEnd**: Executed when the agent session completes or is terminated. Can be used to cleanup temporary resources, generate and archive session reports and logs, or send notifications about session completion. +* **userPromptSubmitted**: Executed when the user submits a prompt to the agent. Can be used to log user requests for auditing and usage analysis. +* **preToolUse**: Executed before the agent uses any tool (such as `bash`, `edit`, `view`). This is the most powerful hook as it can **approve or deny tool executions**. Use this hook to block dangerous commands, enforce security policies and coding standards, require approval for sensitive operations, or log tool usage for compliance. +* **postToolUse**: Executed after a tool completes execution (whether successful or failed). Can be used to log execution results, track usage statistics, generate audit trails, monitor performance metrics, and send failure alerts. +* **errorOccurred**: Executed when an error occurs during agent execution. Can be used to log errors for debugging, send notifications, track error patterns, and generate reports. + +To see a complete reference of hook types with example use cases, best practices, and advanced patterns, see [AUTOTITLE](/copilot/reference/hooks-configuration). + +## Hook configuration format + +You configure hooks using a special JSON format. The JSON must contain a `version` field with a value of `1` and a `hooks` object containing arrays of hook definitions. + +```json copy +{ + "version": 1, + "hooks": { + "sessionStart": [ + { + "type": "command", + "bash": "string (optional)", + "powershell": "string (optional)", + "cwd": "string (optional)", + "env": { "KEY": "value" }, + "timeoutSec": 30 + } + ], + } +} +``` + +The hook object can contain the following keys: + +| Property | Required | Description | +| --- | --- | --- | +| `type` | Yes | Must be `"command"` | +| `bash` | Yes (on Unix systems) | Path to the bash script to execute | +| `powershell` | Yes (on Windows) | Path to the PowerShell script to execute | +| `cwd` | No | Working directory for the script (relative to repository root) | +| `env` | No | Additional environment variables that are merged with the existing environment | +| `timeoutSec` | No | Maximum execution time in seconds (default: 30) | + +## Example hook configuration file + +This is an example configuration file that lives in `~/.github/hooks/project-hooks.json` within a repository. + +```json copy +{ + "version": 1, + "hooks": { + "sessionStart": [ + { + "type": "command", + "bash": "echo \"Session started: $(date)\" >> logs/session.log", + "powershell": "Add-Content -Path logs/session.log -Value \"Session started: $(Get-Date)\"", + "cwd": ".", + "timeoutSec": 10 + } + ], + "userPromptSubmitted": [ + { + "type": "command", + "bash": "./scripts/log-prompt.sh", + "powershell": "./scripts/log-prompt.ps1", + "cwd": "scripts", + "env": { + "LOG_LEVEL": "INFO" + } + } + ], + "preToolUse": [ + { + "type": "command", + "bash": "./scripts/security-check.sh", + "powershell": "./scripts/security-check.ps1", + "cwd": "scripts", + "timeoutSec": 15 + }, + { + "type": "command", + "bash": "./scripts/log-tool-use.sh", + "powershell": "./scripts/log-tool-use.ps1", + "cwd": "scripts" + } + ], + "postToolUse": [ + { + "type": "command", + "bash": "cat >> logs/tool-results.jsonl", + "powershell": "$input | Add-Content -Path logs/tool-results.jsonl" + } + ], + "sessionEnd": [ + { + "type": "command", + "bash": "./scripts/cleanup.sh", + "powershell": "./scripts/cleanup.ps1", + "cwd": "scripts", + "timeoutSec": 60 + } + ] + } +} +``` + +## Performance considerations + +Hooks run synchronously and block agent execution. To ensure a responsive experience, keep the following considerations in mind: + +* **Minimize execution time**: Keep hook execution time under 5 seconds when possible. +* **Optimize logging**: Use asynchronous logging, like appending to files, rather than synchronous I/O. +* **Use background processing**: For expensive operations, consider background processing. +* **Cache results**: Cache expensive computations when possible. + +## Security considerations + +To ensure security is maintained when using hooks, keep the following considerations in mind: + +* **Always validate and sanitize the input processed by hooks**. Untrusted input could lead to unexpected behavior. +* **Use proper shell escaping when constructing commands**. This prevents command injection vulnerabilities. +* **Never log sensitive data, such as tokens or passwords**. +* **Ensure hook scripts and logs have the appropriate permissions**. +* **Be cautious with hooks that make external network calls**. These can introduce latency, failures, or expose data to third parties. +* **Set appropriate timeouts to prevent resource exhaustion**. Long-running hooks can block agent execution and degrade performance. + +## Next steps + +To start creating hooks, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks). + diff --git a/content/copilot/concepts/agents/coding-agent/index.md b/content/copilot/concepts/agents/coding-agent/index.md index f295144cabd6..891b75fd423e 100644 --- a/content/copilot/concepts/agents/coding-agent/index.md +++ b/content/copilot/concepts/agents/coding-agent/index.md @@ -11,6 +11,7 @@ children: - /about-coding-agent - /agent-management - /about-custom-agents + - /about-hooks - /access-management - /mcp-and-coding-agent contentType: concepts diff --git a/content/copilot/concepts/agents/copilot-memory.md b/content/copilot/concepts/agents/copilot-memory.md new file mode 100644 index 000000000000..0e882182d1ff --- /dev/null +++ b/content/copilot/concepts/agents/copilot-memory.md @@ -0,0 +1,73 @@ +--- +title: About agentic memory for GitHub Copilot +shortTitle: Copilot Memory +allowTitleToDifferFromFilename: true +intro: 'Find out how {% data variables.product.prodname_copilot_short %} can store details it has learned about a codebase and use that knowledge for future work in a repository.' +product: '{% data reusables.gated-features.copilot-memory %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +topics: + - Copilot +contentType: concepts +category: + - Learn about Copilot +--- + +> [!NOTE] +> This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change. + +## Introduction + +As a developer, when you start working on an existing codebase—perhaps as a new member of the development team—you can read the README for the repository, the coding conventions documentation, and other information to help you understand the repository and how you should work when updating or adding code. This will help you submit good quality pull requests. However, the quality of work you're able to deliver will steadily improve as you work on the codebase and learn more about it. In the same way, by allowing {% data variables.product.prodname_copilot_short %} to build its own understanding of your repository, you can enable it to become increasingly effective over time. + +Copilot can develop a persistent understanding of a repository by storing "memories." + +Memories are tightly scoped pieces of information about a repository, that are deduced by Copilot as it works on the repository. Memories are: + +* Repository-specific. +* Only created in response to {% data variables.product.prodname_copilot_short %} activity initiated by users who have had {% data variables.copilot.copilot_memory %} enabled. + +Memories created by one part of {% data variables.product.prodname_copilot_short %} can be used by another part of {% data variables.product.prodname_copilot_short %}. So, for example, if {% data variables.copilot.copilot_coding_agent %} discovers how your repository handles database connections, {% data variables.copilot.copilot_code-review_short %} can later apply that knowledge to spot inconsistent patterns in a pull request it is reviewing. Similarly, if {% data variables.copilot.copilot_code-review_short %} learns about settings that must stay synchronized in two separate files, then {% data variables.copilot.copilot_coding_agent %} will know that if it alters the settings in one of those files it must update the other file accordingly. + +## Benefits of using {% data variables.copilot.copilot_memory %} + +AI that is stateless and doesn't retain an understanding of a codebase between separate human/AI interactions, requires you either to repeatedly explain coding conventions and important details about specific code in your prompts, or to create detailed custom instructions files, which you must then maintain. + +{% data variables.copilot.copilot_memory %}: + +* Reduces the burden of repeatedly providing the same details in your prompts. +* Reduces the need for regular, manual maintenance of custom instruction files. + +By building and maintaining a persistent, repository-level memory, {% data variables.product.prodname_copilot_short %} develops its own knowledge of your codebase, adapts to your coding requirements, and increases the value it can deliver over time. + +## Where is {% data variables.copilot.copilot_memory %} used? + +Currently {% data variables.copilot.copilot_memory %} is used by {% data variables.copilot.copilot_coding_agent %} and {% data variables.copilot.copilot_code-review_short %} when these features are working on pull requests on the {% data variables.product.github %} website, and by {% data variables.copilot.copilot_cli_short %}. Memories are only created and used by {% data variables.product.prodname_copilot_short %} when {% data variables.copilot.copilot_memory %} has been enabled for the user initiating the {% data variables.product.prodname_copilot_short %} operation. + +Agentic memory will be extended to other parts of {% data variables.product.prodname_copilot_short %}, and for personal and organizational scopes, in future releases. + +## How memories are stored, retained and used + +Each memory that {% data variables.product.prodname_copilot_short %} generates is stored with citations. These are references to specific code locations that support the memory. When {% data variables.product.prodname_copilot_short %} finds a memory that relates to the work it is doing, it checks the citations against the current codebase to validate that the information is still accurate and is relevant to the current branch. The memory is only used if it is successfully validated. + +To avoid stale memories being retained, resulting in outdated information adversely affecting {% data variables.product.prodname_copilot_short %}'s decision making, memories are automatically deleted after 28 days. + +If a memory is validated and used by {% data variables.product.prodname_copilot_short %}, then a new memory with the same details may be stored, which increases the longevity of that memory. + +Memories can be created from code in pull requests that were closed without being merged. However, the validation mechanism ensures that such memories will not affect {% data variables.product.prodname_copilot_short %}'s behavior if there is no substantiating evidence in the current codebase. + +{% data variables.product.prodname_copilot_short %} only creates memories in a repository in response to actions taken within that repository by people who have write permission for the repository, and for whom {% data variables.copilot.copilot_memory %} has been enabled. Memories are repository scoped, not user scoped, so all memories stored for a repository are available for use in {% data variables.product.prodname_copilot_short %} operations initiated by any user who has access to {% data variables.copilot.copilot_memory %} for that repository. The memories stored for a repository can only be used in {% data variables.product.prodname_copilot_short %} operations on that same repository. In this way, what {% data variables.product.prodname_copilot_short %} learns about a repository stays within that repository, ensuring privacy and security. + +If you are the owner of a repository where {% data variables.copilot.copilot_memory %} is being used, you can review and manually delete the memories for that repository. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/copilot-memory). + +## About enabling {% data variables.copilot.copilot_memory %} + +{% data variables.copilot.copilot_memory %} is turned off by default and can be enabled in the enterprise, organization, and personal settings. + +The ability to use {% data variables.copilot.copilot_memory %} is granted to users, rather than being enabled for repositories. After {% data variables.copilot.copilot_memory %} has been enabled for a user, {% data variables.product.prodname_copilot_short %} will be able to use agentic memory in any repository in which that person uses {% data variables.product.prodname_copilot %}. + +When enabled at the enterprise or organization level, {% data variables.copilot.copilot_memory %} will be available to all organization members who receive a {% data variables.product.prodname_copilot_short %} subscription from that organization. + +Users who have an individual {% data variables.product.prodname_copilot_short %} subscription, from a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, must enable {% data variables.copilot.copilot_memory %} in their personal {% data variables.product.prodname_copilot_short %} settings on {% data variables.product.github %}. + +For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/copilot-memory). diff --git a/content/copilot/concepts/agents/index.md b/content/copilot/concepts/agents/index.md index dee16420477c..a45bb46ae71a 100644 --- a/content/copilot/concepts/agents/index.md +++ b/content/copilot/concepts/agents/index.md @@ -11,6 +11,7 @@ children: - /coding-agent - /code-review - /about-copilot-cli + - /copilot-memory - /openai-codex - /about-agent-skills - /enterprise-management diff --git a/content/copilot/concepts/billing/copilot-requests.md b/content/copilot/concepts/billing/copilot-requests.md index c62d6c388a04..1dd22e79ec74 100644 --- a/content/copilot/concepts/billing/copilot-requests.md +++ b/content/copilot/concepts/billing/copilot-requests.md @@ -103,6 +103,6 @@ If you use **{% data variables.copilot.copilot_free_short %}**, you have access Premium request usage is based on the model’s multiplier and the feature you’re using. For example: -* **Using {% data variables.copilot.copilot_claude_opus_41 %} in {% data variables.copilot.copilot_chat_short %}**: With a 10× multiplier, one interaction counts as 10 premium requests. +* **Using {% data variables.copilot.copilot_claude_opus_45 %} in {% data variables.copilot.copilot_chat_short %}**: With a 3× multiplier, one interaction counts as 3 premium requests. * **Using {% data variables.copilot.copilot_gpt_5_mini %} on {% data variables.copilot.copilot_free_short %}**: Each interaction counts as 1 premium request. * **Using {% data variables.copilot.copilot_gpt_5_mini %} on a paid plan**: No premium requests are consumed. diff --git a/content/copilot/concepts/prompting/response-customization.md b/content/copilot/concepts/prompting/response-customization.md index 47a72bca905b..7b98b54e6c19 100644 --- a/content/copilot/concepts/prompting/response-customization.md +++ b/content/copilot/concepts/prompting/response-customization.md @@ -48,8 +48,6 @@ You can use three types of repository custom instructions in {% data variables.p {% data reusables.copilot.custom-instructions-about %} -{% data reusables.copilot.repository-custom-instructions-support %} - ## About organization custom instructions {% data reusables.copilot.custom-instructions-org-support %} @@ -71,7 +69,7 @@ The following list shows the complete order of precedence, with instructions hig * **Personal** instructions * **Repository** custom instructions: - * **Path-specific** instructions in any applicable `.github/instructions/**/NAME.instructions.md` file + * **Path-specific** instructions in any applicable `.github/instructions/**/*.instructions.md` file * **Repository-wide** instructions in the `.github/copilot-instructions.md` file * **Agent** instructions (for example, in an `AGENTS.md` file) * **Organization** custom instructions @@ -103,6 +101,10 @@ Here are some common use cases and examples for each type of custom instructions * [AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) * [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot) +## Further reading + +* [AUTOTITLE](/copilot/concepts/agents/copilot-memory) + {% endwebui %} @@ -132,8 +134,6 @@ You can use three types of repository custom instructions in {% data variables.p {% data reusables.copilot.custom-instructions-about %} -{% data reusables.copilot.repository-custom-instructions-support %} - ## About prompt files > [!NOTE] Prompt files are {% data variables.release-phases.public_preview %} and subject to change. @@ -225,16 +225,14 @@ You can use two types of repository custom instructions in {% data variables.pro * **Path-specific custom instructions**, which apply to requests made in the context of files that match a specified path. - These are specified in one or more `NAME.instructions.md` files within the `.github/instructions` directory in the repository. + These are specified in one or more `NAME.instructions.md` files within or below the `.github/instructions` directory in the repository. By using path-specific instructions you can avoid overloading your repository-wide instructions with information that only applies to files of certain types, or in certain directories. -See the table below for details of support for each of these types of repository custom instructions across different {% data variables.product.prodname_copilot_short %} features. +For details of support for each of these types of repository custom instructions across different {% data variables.product.prodname_copilot_short %} features, see [AUTOTITLE](/copilot/reference/custom-instructions-support). For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-instructions). -{% data reusables.copilot.repository-custom-instructions-support %} - ## About prompt files Prompt files let you build and share reusable prompt instructions with additional context. A prompt file is a Markdown file, stored in your workspace, that mimics the existing format of writing prompts in {% data variables.copilot.copilot_chat_short %} (for example, `Rewrite #file:x.ts`). This allows blending natural language instructions, additional context, and even linking to other prompt files as dependencies. @@ -317,7 +315,9 @@ While custom instructions help to add codebase-wide context to each AI workflow, In JetBrains IDEs, repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt. -{% data reusables.copilot.repository-custom-instructions-support %} +### Support for repository custom instructions + +For details of which types of custom instructions are supported across various environments, see [AUTOTITLE](/copilot/reference/custom-instructions-support). ### Use cases for custom instructions @@ -411,7 +411,9 @@ For a curated collection of examples, see [AUTOTITLE](/copilot/tutorials/customi In Xcode, repository custom instructions consist of a single file, `.github/copilot-instructions.md`, that you create in a repository. The instructions you add to the file should be short, self-contained statements that add context or relevant information to supplement a {% data variables.product.prodname_copilot_short %} prompt. -{% data reusables.copilot.repository-custom-instructions-support %} +### Support for repository custom instructions + +For details of which types of custom instructions are supported across various environments, see [AUTOTITLE](/copilot/reference/custom-instructions-support). ### Use cases for custom instructions diff --git a/content/copilot/get-started/features.md b/content/copilot/get-started/features.md index 6e67084c5da3..fe0da3c66c90 100644 --- a/content/copilot/get-started/features.md +++ b/content/copilot/get-started/features.md @@ -59,6 +59,10 @@ AI-generated text completion to help you write pull request descriptions quickly Enhance {% data variables.copilot.copilot_chat_short %} responses by providing contextual details on your preferences, tools, and requirements. See [AUTOTITLE](/copilot/concepts/about-customizing-github-copilot-chat-responses). +### {% data variables.copilot.copilot_memory %} ({% data variables.release-phases.public_preview %}) + +{% data variables.product.prodname_copilot_short %} can deduce and store useful information about a repository, which {% data variables.copilot.copilot_coding_agent %} and {% data variables.copilot.copilot_code-review_short %} can use to improve the quality of their output when working in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). + ### {% data variables.copilot.copilot_desktop_short %} Automatically generate commit messages and descriptions with {% data variables.copilot.copilot_desktop_short %} based on the changes you make to your project. diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies.md index 7dc4b4802652..3d586ae08480 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies.md @@ -20,7 +20,7 @@ category: - Manage Copilot for a team --- -When an organization owner assigns a {% data variables.product.prodname_copilot_short %} license to a member of their organization, the availability of features and models is controlled by policies. +When an organization owner assigns a {% data variables.product.prodname_copilot_short %} license to a member of their organization, the availability of features and models is controlled by policies. If you are using a dedicated enterprise to manage {% data variables.copilot.copilot_business_short %} without {% data variables.product.prodname_enterprise %} licenses, see [AUTOTITLE](/copilot/how-tos/set-up/set-up-a-dedicated-enterprise-for-copilot-business). ## Defining policies for your enterprise diff --git a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md index 7c14f994f5ad..924658ba75f3 100644 --- a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md +++ b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md @@ -217,7 +217,7 @@ Once saved, these instructions will apply to the current project in Eclipse that * **Path-specific custom instructions**, which apply to requests made in the context of files that match a specified path. - These are specified in one or more `NAME.instructions.md` files within the `.github/instructions` directory in the repository. See [Creating path-specific custom instructions](#creating-path-specific-custom-instructions). + These are specified in one or more `NAME.instructions.md` files within or below the `.github/instructions` directory in the repository. See [Creating path-specific custom instructions](#creating-path-specific-custom-instructions). If the path you specify matches a file that {% data variables.product.prodname_copilot_short %} is working on, and a repository-wide custom instructions file also exists, then the instructions from both files are used. You should avoid potential conflicts between instructions as {% data variables.product.prodname_copilot_short %}'s choice between conflicting instructions is non-deterministic. @@ -253,7 +253,7 @@ Once saved, these instructions will apply to the current project in Eclipse that * **Path-specific custom instructions**, which apply to requests made in the context of files that match a specified path. - These are specified in one or more `NAME.instructions.md` files within the `.github/instructions` directory in the repository. See [Creating path-specific custom instructions](#creating-path-specific-custom-instructions-1). + These are specified in one or more `NAME.instructions.md` files within or below the `.github/instructions` directory in the repository. See [Creating path-specific custom instructions](#creating-path-specific-custom-instructions-1). If the path you specify matches a file that {% data variables.product.prodname_copilot_short %} is working on, and a repository-wide custom instructions file also exists, then the instructions from both files are used. @@ -290,7 +290,7 @@ Once saved, these instructions will apply to the current project in Eclipse that * **Path-specific custom instructions**, which apply to requests made in the context of files that match a specified path. - These are specified in one or more `NAME.instructions.md` files within the `.github/instructions` directory in the repository. See [Creating path-specific custom instructions](#creating-path-specific-custom-instructions-2). + These are specified in one or more `NAME.instructions.md` files within or below the `.github/instructions` directory in the repository. See [Creating path-specific custom instructions](#creating-path-specific-custom-instructions-2). If the path you specify matches a file that {% data variables.product.prodname_copilot_short %} is working on, and a repository-wide custom instructions file also exists, then the instructions from both files are used. @@ -320,7 +320,7 @@ Once saved, these instructions will apply to the current project in Eclipse that * **Path-specific custom instructions** apply to requests made in the context of files that match a specified path. - These are specified in one or more `NAME.instructions.md` files within the `.github/instructions` directory in the repository. See [Creating path-specific custom instructions](#creating-path-specific-custom-instructions-2). + These are specified in one or more `NAME.instructions.md` files within or below the `.github/instructions` directory in the repository. See [Creating path-specific custom instructions](#creating-path-specific-custom-instructions-2). If the path you specify matches a file that {% data variables.product.prodname_copilot_short %} is working on, and a repository-wide custom instructions file also exists, then the instructions from both files are used. diff --git a/content/copilot/how-tos/provide-context/use-mcp/configure-toolsets.md b/content/copilot/how-tos/provide-context/use-mcp/configure-toolsets.md index e809de04af36..d3166c21b8f3 100644 --- a/content/copilot/how-tos/provide-context/use-mcp/configure-toolsets.md +++ b/content/copilot/how-tos/provide-context/use-mcp/configure-toolsets.md @@ -43,4 +43,3 @@ For detailed setup instructions, see [Local {% data variables.product.github %} * [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server) * [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server) -* [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/configure-toolsets) diff --git a/content/copilot/how-tos/set-up/set-up-for-self.md b/content/copilot/how-tos/set-up/set-up-for-self.md index 672ea7944256..cf2c30c84a69 100644 --- a/content/copilot/how-tos/set-up/set-up-for-self.md +++ b/content/copilot/how-tos/set-up/set-up-for-self.md @@ -12,7 +12,7 @@ redirect_from: - /copilot/get-started/setting-up-github-copilot/setting-up-github-copilot-for-yourself - /copilot/how-tos/set-up/setting-up-github-copilot-for-yourself contentType: how-tos -category: +category: - Configure Copilot --- @@ -55,8 +55,9 @@ All users can configure {% data variables.product.prodname_copilot_short %} sett If you have your own {% data variables.product.prodname_copilot_short %} plan (instead of using your organization or enterprise's plan), you can: -* **Install Model Context Protocol (MCP) servers to integrate with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp). +* **Install Model Context Protocol (MCP) servers** to integrate with {% data variables.copilot.copilot_chat_short %}. See [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp). * **Manage policies**. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber). +* **Enable {% data variables.copilot.copilot_memory %}**, which allows {% data variables.product.prodname_copilot_short %} to generate and store useful information about your repositories. See [AUTOTITLE](/copilot/concepts/agents/copilot-memory). ## 7. Start using {% data variables.product.prodname_copilot_short %} diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md index ed3b941f86c5..4113f067b4ff 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md @@ -20,6 +20,7 @@ children: - /changing-the-ai-model - /customize-the-agent-environment - /customize-the-agent-firewall + - /use-hooks - /troubleshoot-coding-agent redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks.md new file mode 100644 index 000000000000..a9e549792da4 --- /dev/null +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks.md @@ -0,0 +1,115 @@ +--- +title: Using hooks with GitHub Copilot agents +shortTitle: Use hooks +intro: 'Learn how to extend and customize {% data variables.product.prodname_copilot %} agent behavior by executing custom shell commands at key points during agent execution.' +versions: + feature: copilot +topics: + - Copilot +contentType: how-tos +category: + - Configure Copilot +--- + +Hooks allow you to extend and customize the behavior of {% data variables.product.prodname_copilot %} agents by executing custom shell commands at key points during agent execution. For a conceptual overview of hooks, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-hooks). + +## Creating a hook in a repository on {% data variables.product.github %} + +1. Create a new `hooks.json` file with the name of your choice in the `.github/hooks/` folder of your repository. The hooks configuration file **must be present** on your repository's default branch to be used by {% data variables.copilot.copilot_coding_agent %}. For {% data variables.copilot.copilot_cli %}, hooks are loaded from your current working directory. + +1. In your text editor, copy and paste the following hook template. Remove any hooks you don't plan on using from the `hooks` array. + + ```json copy + { + "version": 1, + "hooks": { + "sessionStart": [...], + "sessionEnd": [...], + "userPromptSubmitted": [...], + "preToolUse": [...], + "postToolUse": [...], + "errorOccurred": [...] + } + } + ``` + +1. Configure your hook syntax under the `bash` or `powershell` keys, or directly reference script files you have created. + + * This example runs a script that outputs the start date of the session to a log file using the `sessionStart` hook: + + ```json copy + "sessionStart": [ + { + "type": "command", + "bash": "echo \"Session started: $(date)\" >> logs/session.log", + "powershell": "Add-Content -Path logs/session.log -Value \"Session started: $(Get-Date)\"", + "cwd": ".", + "timeoutSec": 10 + } + ], + ``` + + * This example calls out to an external `log-prompt` script: + + ```json copy + "userPromptSubmitted": [ + { + "type": "command", + "bash": "./scripts/log-prompt.sh", + "powershell": "./scripts/log-prompt.ps1", + "cwd": "scripts", + "env": { + "LOG_LEVEL": "INFO" + } + } + ], + ``` + + For a full reference on the input JSON from agent sessions along with sample scripts, see [AUTOTITLE](/copilot/reference/hooks-configuration). + +1. Commit the file to the repository and merge it into the default branch. Your hooks will now run during agent sessions. + +## Troubleshooting + +If you run into problems using hooks, use the following table to troubleshoot. + +| Issue | Action | +| --- | --- | +| Hooks are not executing | | +| Hooks are timing out |