diff --git a/.github/workflows/notify-about-deployment.yml b/.github/workflows/notify-about-deployment.yml index e7fb384447b3..0aa3dd0b97b4 100644 --- a/.github/workflows/notify-about-deployment.yml +++ b/.github/workflows/notify-about-deployment.yml @@ -1,6 +1,9 @@ name: Notify about production deployment -# **What it does**: Posts a comment on the PR whose merge got into production. +# **What it does**: Posts a comment on every PR in the deploy that got into +# production. The merge queue can batch several PRs into one +# deploy, so it walks back from the deployed commit to find +# all of them. # **Why we have it**: So that the PR author can be informed when their merged PR is in production. # **Who does it impact**: Writers @@ -38,38 +41,12 @@ jobs: - name: Sleep a little to give Fastly Purge a chance run: sleep 30 - - name: Find last PR - id: get-number + - name: Find PRs and post production comments timeout-minutes: 5 env: GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_BASE }} run: npm run find-past-built-pr - - name: Find content directory changes comment - if: ${{ steps.get-number.outputs.number != '' }} - uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad - id: findComment - with: - issue-number: ${{ steps.get-number.outputs.number }} - comment-author: 'github-actions[bot]' - body-includes: '' - - - name: Update comment - if: ${{ steps.get-number.outputs.number != '' }} - uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 - with: - comment-id: ${{ steps.findComment.outputs.comment-id }} - issue-number: ${{ steps.get-number.outputs.number }} - body: | - - 🚀 **This pull request has gone into production!** - - The SHA of https://docs.github.com/_build matches the merge commit in this PR. - - If you don't see updates when expected, try adding a random query string to the URL like `?bla=1234` and see if that helps. - If that shows the expected content, it would indicate that the CDN is "overly caching" the page still. It will eventually update, but it can take a while. - edit-mode: replace - - uses: ./.github/actions/slack-alert if: ${{ failure() }} with: diff --git a/config/moda/deployment.yaml b/config/moda/deployment.yaml index a12c2f4b6497..6b86d97682c3 100644 --- a/config/moda/deployment.yaml +++ b/config/moda/deployment.yaml @@ -12,6 +12,8 @@ environments: # 15 staging environments, evergreens only # they should all contain the same configs + # intentionally pinned to a single cluster via the `name` selector + - name: staging-balsam require_pipeline: false notify_still_locked: true # Notify last person to lock this after an hour @@ -22,6 +24,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':balsam: Review at https://docs-internal-staging-balsam.githubapp.com/' - name: staging-boxwood @@ -34,6 +37,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':boxwood: Review at https://docs-internal-staging-boxwood.githubapp.com/' - name: staging-cedar @@ -46,6 +50,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':cedar: Review at https://docs-internal-staging-cedar.githubapp.com/' - name: staging-cypress @@ -58,6 +63,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':cypress: Review at https://docs-internal-staging-cypress.githubapp.com/' - name: staging-fir @@ -70,6 +76,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':fir: Review at https://docs-internal-staging-fir.githubapp.com/' - name: staging-hemlock @@ -82,6 +89,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':hemlock: Review at https://docs-internal-staging-hemlock.githubapp.com/' - name: staging-hinoki @@ -94,6 +102,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':hinoki: Review at https://docs-internal-staging-hinoki.githubapp.com/' - name: staging-holly @@ -106,6 +115,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':holly_: Review at https://docs-internal-staging-holly.githubapp.com/' - name: staging-juniper @@ -118,6 +128,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':juniper: Review at https://docs-internal-staging-juniper.githubapp.com/' - name: staging-laurel @@ -130,6 +141,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':laurel: Review at https://docs-internal-staging-laurel.githubapp.com/' - name: staging-pine @@ -142,6 +154,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':pine: Review at https://docs-internal-staging-pine.githubapp.com/' - name: staging-redwood @@ -154,6 +167,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':redwood: Review at https://docs-internal-staging-redwood.githubapp.com/' - name: staging-sequoia @@ -166,6 +180,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':sequoia: Review at https://docs-internal-staging-sequoia.githubapp.com/' - name: staging-spruce @@ -178,6 +193,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':spruce: Review at https://docs-internal-staging-spruce.githubapp.com/' - name: staging-yew @@ -190,6 +206,7 @@ environments: cluster_selector: profile: general region: iad + name: general-2-ash1-iad extra_completed_message: ':yew: Review at https://docs-internal-staging-yew.githubapp.com/' required_builds: diff --git a/content/code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues.md b/content/code-security/concepts/code-scanning/alert-tracking-with-issues.md similarity index 96% rename from content/code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues.md rename to content/code-security/concepts/code-scanning/alert-tracking-with-issues.md index 9d276d285f98..312af1969ea0 100644 --- a/content/code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues.md +++ b/content/code-security/concepts/code-scanning/alert-tracking-with-issues.md @@ -8,6 +8,8 @@ versions: contentType: concepts category: - Find and fix code vulnerabilities +redirect_from: + - /code-security/concepts/code-scanning/code-scanning-alert-tracking-using-issues --- {% data reusables.code-scanning.alert-tracking-with-issues-preview-note %} diff --git a/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md b/content/code-security/concepts/code-scanning/code-scanning-alerts.md similarity index 99% rename from content/code-security/concepts/code-scanning/about-code-scanning-alerts.md rename to content/code-security/concepts/code-scanning/code-scanning-alerts.md index 7a550e913d7b..70fc86880f19 100644 --- a/content/code-security/concepts/code-scanning/about-code-scanning-alerts.md +++ b/content/code-security/concepts/code-scanning/code-scanning-alerts.md @@ -1,5 +1,5 @@ --- -title: About code scanning alerts +title: 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 %}' @@ -11,6 +11,7 @@ versions: redirect_from: - /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts - /code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts + - /code-security/concepts/code-scanning/about-code-scanning-alerts contentType: concepts category: - Find and fix code vulnerabilities diff --git a/content/code-security/concepts/code-scanning/about-code-scanning.md b/content/code-security/concepts/code-scanning/code-scanning.md similarity index 98% rename from content/code-security/concepts/code-scanning/about-code-scanning.md rename to content/code-security/concepts/code-scanning/code-scanning.md index ec0068aa536b..3ddc717391b6 100644 --- a/content/code-security/concepts/code-scanning/about-code-scanning.md +++ b/content/code-security/concepts/code-scanning/code-scanning.md @@ -1,6 +1,6 @@ --- -title: About code scanning -shortTitle: Introduction +title: Code scanning +shortTitle: 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 %}. product: '{% data reusables.gated-features.code-scanning %}' redirect_from: @@ -11,6 +11,7 @@ redirect_from: - /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 + - /code-security/concepts/code-scanning/about-code-scanning versions: fpt: '*' ghes: '*' diff --git a/content/code-security/concepts/code-scanning/codeql/about-the-codeql-cli.md b/content/code-security/concepts/code-scanning/codeql/codeql-cli.md similarity index 99% rename from content/code-security/concepts/code-scanning/codeql/about-the-codeql-cli.md rename to content/code-security/concepts/code-scanning/codeql/codeql-cli.md index 262d0c9b3a06..02ef951fac9c 100644 --- a/content/code-security/concepts/code-scanning/codeql/about-the-codeql-cli.md +++ b/content/code-security/concepts/code-scanning/codeql/codeql-cli.md @@ -1,5 +1,5 @@ --- -title: About the CodeQL CLI +title: CodeQL CLI 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 %}' @@ -22,6 +22,7 @@ redirect_from: - /code-security/codeql-cli/getting-started-with-the-codeql-cli/about-the-codeql-cli - /code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/advanced-setup-of-the-codeql-cli - /code-security/how-tos/scan-code-for-vulnerabilities/scan-from-the-command-line/advanced-setup-of-the-codeql-cli + - /code-security/concepts/code-scanning/codeql/about-the-codeql-cli contentType: concepts category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql.md b/content/code-security/concepts/code-scanning/codeql/codeql-code-scanning.md similarity index 98% rename from content/code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql.md rename to content/code-security/concepts/code-scanning/codeql/codeql-code-scanning.md index 9b8779ca4d6d..67269e976aef 100644 --- a/content/code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql.md +++ b/content/code-security/concepts/code-scanning/codeql/codeql-code-scanning.md @@ -1,5 +1,5 @@ --- -title: About code scanning with CodeQL +title: Code scanning with CodeQL 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 %}' @@ -7,6 +7,7 @@ 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 + - /code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql versions: fpt: '*' ghes: '*' diff --git a/content/code-security/concepts/code-scanning/codeql/about-codeql-code-scanning-for-compiled-languages.md b/content/code-security/concepts/code-scanning/codeql/codeql-for-compiled-languages.md similarity index 96% rename from content/code-security/concepts/code-scanning/codeql/about-codeql-code-scanning-for-compiled-languages.md rename to content/code-security/concepts/code-scanning/codeql/codeql-for-compiled-languages.md index 092beb49c870..dba49bd340c5 100644 --- a/content/code-security/concepts/code-scanning/codeql/about-codeql-code-scanning-for-compiled-languages.md +++ b/content/code-security/concepts/code-scanning/codeql/codeql-for-compiled-languages.md @@ -1,5 +1,5 @@ --- -title: 'About CodeQL code scanning for compiled languages' +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. 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' @@ -11,6 +11,8 @@ versions: contentType: concepts category: - Find and fix code vulnerabilities +redirect_from: + - /code-security/concepts/code-scanning/codeql/about-codeql-code-scanning-for-compiled-languages --- ## About the {% data variables.code-scanning.codeql_workflow %} and compiled languages diff --git a/content/code-security/concepts/code-scanning/codeql/about-codeql-for-vs-code.md b/content/code-security/concepts/code-scanning/codeql/codeql-for-vs-code.md similarity index 98% rename from content/code-security/concepts/code-scanning/codeql/about-codeql-for-vs-code.md rename to content/code-security/concepts/code-scanning/codeql/codeql-for-vs-code.md index 2f99def59bbd..ad06dad13e0b 100644 --- a/content/code-security/concepts/code-scanning/codeql/about-codeql-for-vs-code.md +++ b/content/code-security/concepts/code-scanning/codeql/codeql-for-vs-code.md @@ -1,5 +1,5 @@ --- -title: About CodeQL for VS Code +title: CodeQL for VS Code shortTitle: CodeQL for VS Code versions: fpt: '*' @@ -10,6 +10,7 @@ intro: You can write, run, and test {% data variables.product.prodname_codeql %} 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 + - /code-security/concepts/code-scanning/codeql/about-codeql-for-vs-code contentType: concepts category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/concepts/code-scanning/codeql/about-codeql-workspaces.md b/content/code-security/concepts/code-scanning/codeql/codeql-workspaces.md similarity index 98% rename from content/code-security/concepts/code-scanning/codeql/about-codeql-workspaces.md rename to content/code-security/concepts/code-scanning/codeql/codeql-workspaces.md index 4d03be77f1ac..854f39a1bc1a 100644 --- a/content/code-security/concepts/code-scanning/codeql/about-codeql-workspaces.md +++ b/content/code-security/concepts/code-scanning/codeql/codeql-workspaces.md @@ -1,5 +1,5 @@ --- -title: About CodeQL workspaces +title: CodeQL workspaces shortTitle: CodeQL workspaces intro: '{% data variables.product.prodname_codeql %} workspaces let you develop and maintain multiple related {% data variables.product.prodname_codeql %} packs together, resolving dependencies between them directly from source.' product: '{% data reusables.gated-features.codeql %}' @@ -11,6 +11,7 @@ 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 + - /code-security/concepts/code-scanning/codeql/about-codeql-workspaces contentType: concepts category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/concepts/code-scanning/codeql/custom-codeql-queries.md b/content/code-security/concepts/code-scanning/codeql/custom-queries.md similarity index 97% rename from content/code-security/concepts/code-scanning/codeql/custom-codeql-queries.md rename to content/code-security/concepts/code-scanning/codeql/custom-queries.md index ed3cb92f565d..dc05522d7104 100644 --- a/content/code-security/concepts/code-scanning/codeql/custom-codeql-queries.md +++ b/content/code-security/concepts/code-scanning/codeql/custom-queries.md @@ -10,6 +10,8 @@ versions: contentType: concepts category: - Customize vulnerability detection with CodeQL +redirect_from: + - /code-security/concepts/code-scanning/codeql/custom-codeql-queries --- ## What are custom {% data variables.product.prodname_codeql %} queries? diff --git a/content/code-security/concepts/code-scanning/codeql/index.md b/content/code-security/concepts/code-scanning/codeql/index.md index 0eb6f1c76a09..9264b4b25778 100644 --- a/content/code-security/concepts/code-scanning/codeql/index.md +++ b/content/code-security/concepts/code-scanning/codeql/index.md @@ -8,13 +8,14 @@ versions: ghec: '*' contentType: concepts children: - - /about-code-scanning-with-codeql - - /about-codeql-code-scanning-for-compiled-languages + - /codeql-code-scanning + - /codeql-for-compiled-languages - /codeql-query-suites - - /custom-codeql-queries - - /about-the-codeql-cli - - /about-codeql-for-vs-code - - /about-codeql-workspaces + - /custom-queries + - /codeql-cli + - /codeql-for-vs-code + - /codeql-workspaces - /query-reference-files - - /codeql-query-packs + - /query-packs --- + diff --git a/content/code-security/concepts/code-scanning/codeql/codeql-query-packs.md b/content/code-security/concepts/code-scanning/codeql/query-packs.md similarity index 98% rename from content/code-security/concepts/code-scanning/codeql/codeql-query-packs.md rename to content/code-security/concepts/code-scanning/codeql/query-packs.md index 3508c7ccb201..5eba8ac5343f 100644 --- a/content/code-security/concepts/code-scanning/codeql/codeql-query-packs.md +++ b/content/code-security/concepts/code-scanning/codeql/query-packs.md @@ -1,5 +1,6 @@ --- title: CodeQL query packs +shortTitle: Query packs intro: You can choose from different built-in {% data variables.product.prodname_codeql %} query suites to use in your {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} setup. product: '{% data reusables.gated-features.codeql %}' versions: @@ -9,6 +10,8 @@ versions: contentType: concepts category: - Customize vulnerability detection with CodeQL +redirect_from: + - /code-security/concepts/code-scanning/codeql/codeql-query-packs --- {% data reusables.code-scanning.codeql-cli-version-ghes %} diff --git a/content/code-security/concepts/code-scanning/codeql/query-reference-files.md b/content/code-security/concepts/code-scanning/codeql/query-reference-files.md index fdc00ddeb0ae..06bdef76d067 100644 --- a/content/code-security/concepts/code-scanning/codeql/query-reference-files.md +++ b/content/code-security/concepts/code-scanning/codeql/query-reference-files.md @@ -1,5 +1,6 @@ --- title: Query reference files +shortTitle: Query reference files intro: You can use query reference files to define the location of a query you want to run in tests. product: '{% data reusables.gated-features.codeql %}' versions: diff --git a/content/code-security/concepts/code-scanning/index.md b/content/code-security/concepts/code-scanning/index.md index c39b726db0d6..9245a2090c4d 100644 --- a/content/code-security/concepts/code-scanning/index.md +++ b/content/code-security/concepts/code-scanning/index.md @@ -10,14 +10,14 @@ redirect_from: - /code-security/code-scanning/introduction-to-code-scanning contentType: concepts children: - - /about-code-scanning - - /about-code-scanning-alerts - - /code-security-risk-assessment + - /code-scanning + - /code-scanning-alerts + - /risk-assessment - /copilot-autofix-for-code-scanning - /setup-types - - /about-integration-with-code-scanning + - /integration-with-code-scanning - /sarif-files - - /code-scanning-alert-tracking-using-issues + - /alert-tracking-with-issues - /merge-protection - /multi-repository-variant-analysis - /codeql @@ -25,3 +25,4 @@ children: - /pull-request-alert-metrics - /repository-properties --- + diff --git a/content/code-security/concepts/code-scanning/about-integration-with-code-scanning.md b/content/code-security/concepts/code-scanning/integration-with-code-scanning.md similarity index 95% rename from content/code-security/concepts/code-scanning/about-integration-with-code-scanning.md rename to content/code-security/concepts/code-scanning/integration-with-code-scanning.md index 3d714d59f88e..fb03fe85f71e 100644 --- a/content/code-security/concepts/code-scanning/about-integration-with-code-scanning.md +++ b/content/code-security/concepts/code-scanning/integration-with-code-scanning.md @@ -1,5 +1,5 @@ --- -title: About integration with code scanning +title: Integration with code scanning 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 %}' @@ -9,6 +9,7 @@ redirect_from: - /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 + - /code-security/concepts/code-scanning/about-integration-with-code-scanning versions: fpt: '*' ghes: '*' diff --git a/content/code-security/concepts/code-scanning/multi-repository-variant-analysis.md b/content/code-security/concepts/code-scanning/multi-repository-variant-analysis.md index 8f1ac1ea56f9..140c032d2d43 100644 --- a/content/code-security/concepts/code-scanning/multi-repository-variant-analysis.md +++ b/content/code-security/concepts/code-scanning/multi-repository-variant-analysis.md @@ -1,11 +1,14 @@ --- title: Multi-repository variant analysis +shortTitle: Multi-repository variant analysis intro: MRVA lets you test a query in {% data variables.product.prodname_vscode %} by running it against a large number of repositories. versions: feature: codeql-vs-code-mrva contentType: concepts category: - Customize vulnerability detection with CodeQL +redirect_from: + - /code-security/concepts/code-scanning/variant-analysis --- ## About MRVA diff --git a/content/code-security/concepts/code-scanning/code-security-risk-assessment.md b/content/code-security/concepts/code-scanning/risk-assessment.md similarity index 93% rename from content/code-security/concepts/code-scanning/code-security-risk-assessment.md rename to content/code-security/concepts/code-scanning/risk-assessment.md index 3cd7e0ad66a9..ea0ca655173a 100644 --- a/content/code-security/concepts/code-scanning/code-security-risk-assessment.md +++ b/content/code-security/concepts/code-scanning/risk-assessment.md @@ -1,6 +1,7 @@ --- title: Code security risk assessment -intro: 'Generate a free code security risk assessment to understand your organization''s exposure to vulnerabilities.' +shortTitle: Risk assessment +intro: Generate a free code security risk assessment to understand your organization's exposure to vulnerabilities. product: '{% data reusables.gated-features.secret-risk-assessment-report %}
Get started with security risk assessments {% octicon "link-external" height:16 %}' permissions: '{% data reusables.permissions.secret-risk-assessment-report-generation %}' versions: @@ -8,6 +9,8 @@ versions: contentType: concepts category: - Find and fix code vulnerabilities +redirect_from: + - /code-security/concepts/code-scanning/code-security-risk-assessment --- The {% data variables.product.prodname_code_security_risk_assessment %} is a free, self-serve scan that helps you understand your organization's exposure to code vulnerabilities. The assessment scans up to 20 of your organization's repositories and produces a report showing the vulnerabilities found, their severity, and how many can be fixed with {% data variables.copilot.copilot_autofix_short %}. diff --git a/content/code-security/concepts/index.md b/content/code-security/concepts/index.md index bc3d1fac9ea5..33cfaa1dbc3b 100644 --- a/content/code-security/concepts/index.md +++ b/content/code-security/concepts/index.md @@ -10,8 +10,9 @@ contentType: concepts children: - /secret-security - /code-scanning - - /about-code-quality - supply-chain-security - - /vulnerability-reporting-and-management + - /about-code-quality + - vulnerability-reporting-and-management - /security-at-scale --- + diff --git a/content/code-security/concepts/secret-security/about-bypass-requests-for-push-protection.md b/content/code-security/concepts/secret-security/bypass-requests.md similarity index 93% rename from content/code-security/concepts/secret-security/about-bypass-requests-for-push-protection.md rename to content/code-security/concepts/secret-security/bypass-requests.md index abfd75b3f47c..11d090a580cb 100644 --- a/content/code-security/concepts/secret-security/about-bypass-requests-for-push-protection.md +++ b/content/code-security/concepts/secret-security/bypass-requests.md @@ -1,15 +1,17 @@ --- -title: About bypass requests for push protection -intro: 'Learn how bypass requests work when push protection blocks commits containing secrets.' +title: Bypass requests for push protection +shortTitle: Bypass requests +intro: Learn how bypass requests work when push protection blocks commits containing secrets. permissions: '{% data reusables.permissions.delegated-bypass-list %}' versions: fpt: '*' ghec: '*' ghes: '*' -shortTitle: Bypass requests contentType: concepts category: - Protect your secrets +redirect_from: + - /code-security/concepts/secret-security/about-bypass-requests-for-push-protection --- ## About bypass requests for push protection diff --git a/content/code-security/concepts/secret-security/push-protection-from-the-command-line.md b/content/code-security/concepts/secret-security/command-line-push-protection.md similarity index 94% rename from content/code-security/concepts/secret-security/push-protection-from-the-command-line.md rename to content/code-security/concepts/secret-security/command-line-push-protection.md index f8cf081a1b92..c367cb07ad8c 100644 --- a/content/code-security/concepts/secret-security/push-protection-from-the-command-line.md +++ b/content/code-security/concepts/secret-security/command-line-push-protection.md @@ -1,6 +1,6 @@ --- title: Push protection from the command line -shortTitle: Command line protection +shortTitle: Command line push protection intro: Understand how {% data variables.product.github %} uses push protection to prevent secret leaks from the command line. permissions: '{% data reusables.permissions.push-protection-resolve-block %}' versions: @@ -10,6 +10,8 @@ versions: contentType: concepts category: - Protect your secrets +redirect_from: + - /code-security/concepts/secret-security/push-protection-from-the-command-line --- Push protection prevents you from accidentally committing secrets to a repository by blocking pushes containing supported secrets. diff --git a/content/code-security/concepts/secret-security/custom-patterns.md b/content/code-security/concepts/secret-security/custom-patterns.md index 1e239d736254..d1cda360ab2c 100644 --- a/content/code-security/concepts/secret-security/custom-patterns.md +++ b/content/code-security/concepts/secret-security/custom-patterns.md @@ -1,5 +1,6 @@ --- title: Custom patterns +shortTitle: Custom patterns intro: 'Detect secret types specific to your organization with custom patterns.' versions: fpt: '*' diff --git a/content/code-security/concepts/secret-security/about-delegated-bypass-for-push-protection.md b/content/code-security/concepts/secret-security/delegated-bypass.md similarity index 94% rename from content/code-security/concepts/secret-security/about-delegated-bypass-for-push-protection.md rename to content/code-security/concepts/secret-security/delegated-bypass.md index e0facba8af49..d7302d4824d9 100644 --- a/content/code-security/concepts/secret-security/about-delegated-bypass-for-push-protection.md +++ b/content/code-security/concepts/secret-security/delegated-bypass.md @@ -1,5 +1,5 @@ --- -title: About delegated bypass for push protection +title: Delegated bypass for push protection intro: Maintain your secret security while unblocking trusted actors with delegated bypass for push protection. product: '{% data reusables.gated-features.delegated-bypass %}' versions: @@ -10,6 +10,7 @@ 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 + - /code-security/concepts/secret-security/about-delegated-bypass-for-push-protection contentType: concepts category: - Protect your secrets diff --git a/content/code-security/concepts/secret-security/index.md b/content/code-security/concepts/secret-security/index.md index e94e33c07fa6..6124d3dc3ca6 100644 --- a/content/code-security/concepts/secret-security/index.md +++ b/content/code-security/concepts/secret-security/index.md @@ -9,20 +9,21 @@ versions: contentType: concepts children: - /secret-leakage-risks - - /about-secret-scanning - - /about-push-protection - - /about-secret-security-with-github + - /secret-scanning + - /push-protection + - /secret-security-with-github - /about-alerts - /custom-patterns - - /about-validity-checks - - /about-delegated-bypass-for-push-protection - - /about-bypass-requests-for-push-protection - - /about-secret-scanning-for-partners - - /github-secret-types + - /validity-checks + - /delegated-bypass + - /bypass-requests + - /secret-scanning-for-partners + - /secret-types - /push-protection-metrics - - /push-protection-from-the-command-line - - /working-with-push-protection-and-the-github-mcp-server - - /working-with-push-protection-from-the-rest-api + - /command-line-push-protection + - /push-protection-and-the-github-mcp-server + - /push-protection-from-the-rest-api redirect_from: - /code-security/secret-scanning/introduction --- + diff --git a/content/code-security/concepts/secret-security/working-with-push-protection-and-the-github-mcp-server.md b/content/code-security/concepts/secret-security/push-protection-and-the-github-mcp-server.md similarity index 92% rename from content/code-security/concepts/secret-security/working-with-push-protection-and-the-github-mcp-server.md rename to content/code-security/concepts/secret-security/push-protection-and-the-github-mcp-server.md index 8359af90b8fa..a0f050de1a93 100644 --- a/content/code-security/concepts/secret-security/working-with-push-protection-and-the-github-mcp-server.md +++ b/content/code-security/concepts/secret-security/push-protection-and-the-github-mcp-server.md @@ -8,6 +8,8 @@ versions: feature: copilot redirect_from: - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-and-the-github-mcp-server + - /code-security/concepts/secret-security/working-with-push-protection-and-the-github-mcp-server + - /code-security/concepts/secret-security/push-protection-with-the-github-mcp-server contentType: concepts category: - Protect your secrets diff --git a/content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md b/content/code-security/concepts/secret-security/push-protection-from-the-rest-api.md similarity index 92% rename from content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md rename to content/code-security/concepts/secret-security/push-protection-from-the-rest-api.md index 08eee769dde4..362355669af5 100644 --- a/content/code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api.md +++ b/content/code-security/concepts/secret-security/push-protection-from-the-rest-api.md @@ -9,6 +9,8 @@ versions: ghes: '*' redirect_from: - /code-security/secret-scanning/working-with-secret-scanning-and-push-protection/working-with-push-protection-from-the-rest-api + - /code-security/concepts/secret-security/working-with-push-protection-from-the-rest-api + - /code-security/concepts/secret-security/rest-api-push-protection contentType: concepts category: - Protect your secrets diff --git a/content/code-security/concepts/secret-security/about-push-protection.md b/content/code-security/concepts/secret-security/push-protection.md similarity index 98% rename from content/code-security/concepts/secret-security/about-push-protection.md rename to content/code-security/concepts/secret-security/push-protection.md index e0c856eb33e5..f6181328e4f2 100644 --- a/content/code-security/concepts/secret-security/about-push-protection.md +++ b/content/code-security/concepts/secret-security/push-protection.md @@ -1,5 +1,5 @@ --- -title: About push protection +title: Push protection intro: Secure your secrets by stopping them from ever reaching your repository with push protection. versions: fpt: '*' @@ -10,6 +10,7 @@ redirect_from: - /code-security/secret-scanning/protecting-pushes-with-secret-scanning - /code-security/secret-scanning/push-protection-for-repositories-and-organizations - /code-security/secret-scanning/introduction/about-push-protection + - /code-security/concepts/secret-security/about-push-protection shortTitle: Push protection contentType: concepts category: diff --git a/content/code-security/concepts/secret-security/about-secret-scanning-for-partners.md b/content/code-security/concepts/secret-security/secret-scanning-for-partners.md similarity index 95% rename from content/code-security/concepts/secret-security/about-secret-scanning-for-partners.md rename to content/code-security/concepts/secret-security/secret-scanning-for-partners.md index 00980d4a6a5b..d3ad640305d0 100644 --- a/content/code-security/concepts/secret-security/about-secret-scanning-for-partners.md +++ b/content/code-security/concepts/secret-security/secret-scanning-for-partners.md @@ -1,5 +1,5 @@ --- -title: About secret scanning for partners +title: 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. product: '{% data reusables.gated-features.secret-scanning-partner-alerts %}' versions: @@ -8,6 +8,7 @@ versions: shortTitle: Secret scanning for partners redirect_from: - /code-security/secret-scanning/introduction/about-secret-scanning-for-partners + - /code-security/concepts/secret-security/about-secret-scanning-for-partners contentType: concepts category: - Protect your secrets diff --git a/content/code-security/concepts/secret-security/about-secret-scanning.md b/content/code-security/concepts/secret-security/secret-scanning.md similarity index 95% rename from content/code-security/concepts/secret-security/about-secret-scanning.md rename to content/code-security/concepts/secret-security/secret-scanning.md index dd104b32650d..b049b93310a9 100644 --- a/content/code-security/concepts/secret-security/about-secret-scanning.md +++ b/content/code-security/concepts/secret-security/secret-scanning.md @@ -1,6 +1,6 @@ --- -title: About secret scanning -intro: 'Prevent fraudulent use of your secrets by automatically detecting exposed credentials before they can be exploited.' +title: Secret scanning +intro: Prevent fraudulent use of your secrets by automatically detecting exposed credentials before they can be exploited. redirect_from: - /github/administering-a-repository/about-token-scanning - /articles/about-token-scanning @@ -9,6 +9,7 @@ redirect_from: - /code-security/secret-security/about-secret-scanning - /code-security/secret-scanning/about-secret-scanning - /code-security/secret-scanning/introduction/about-secret-scanning + - /code-security/concepts/secret-security/about-secret-scanning versions: fpt: '*' ghes: '*' diff --git a/content/code-security/concepts/secret-security/about-secret-security-with-github.md b/content/code-security/concepts/secret-security/secret-security-with-github.md similarity index 93% rename from content/code-security/concepts/secret-security/about-secret-security-with-github.md rename to content/code-security/concepts/secret-security/secret-security-with-github.md index 1f2de595eb1c..f16977803a39 100644 --- a/content/code-security/concepts/secret-security/about-secret-security-with-github.md +++ b/content/code-security/concepts/secret-security/secret-security-with-github.md @@ -1,6 +1,6 @@ --- -title: About secret security with GitHub -shortTitle: Secret protection tools +title: Secret security with GitHub +shortTitle: Secret security with GitHub 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 %} @@ -10,6 +10,9 @@ versions: 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 + - /code-security/concepts/secret-security/about-secret-security-with-github + - /code-security/concepts/secret-security/github-secret-protection-tools + - /code-security/concepts/secret-security/secret-protection-tools category: - Protect your secrets --- diff --git a/content/code-security/concepts/secret-security/github-secret-types.md b/content/code-security/concepts/secret-security/secret-types.md similarity index 92% rename from content/code-security/concepts/secret-security/github-secret-types.md rename to content/code-security/concepts/secret-security/secret-types.md index 93ffc74ef2ae..dbc824299ef5 100644 --- a/content/code-security/concepts/secret-security/github-secret-types.md +++ b/content/code-security/concepts/secret-security/secret-types.md @@ -1,5 +1,6 @@ --- title: GitHub secret types +shortTitle: Secret types intro: Learn about the different types of secrets used by {% data variables.product.github %}. versions: fpt: '*' @@ -8,6 +9,8 @@ versions: contentType: concepts category: - Protect your secrets +redirect_from: + - /code-security/concepts/secret-security/github-secret-types --- {% data variables.product.github %} secrets are used to securely store sensitive information like API keys, tokens, and passwords in repositories. diff --git a/content/code-security/concepts/secret-security/about-validity-checks.md b/content/code-security/concepts/secret-security/validity-checks.md similarity index 94% rename from content/code-security/concepts/secret-security/about-validity-checks.md rename to content/code-security/concepts/secret-security/validity-checks.md index 9e3b973cf09a..2829f6668acf 100644 --- a/content/code-security/concepts/secret-security/about-validity-checks.md +++ b/content/code-security/concepts/secret-security/validity-checks.md @@ -1,7 +1,7 @@ --- -title: About validity checks +title: Validity checks shortTitle: Validity checks -intro: 'Validity checks and extended metadata checks help you prioritize remediation of exposed credentials that pose immediate security risks.' +intro: Validity checks and extended metadata checks help you prioritize remediation of exposed credentials that pose immediate security risks. product: | {% data reusables.gated-features.secret-scanning %}{% ifversion secret-risk-assessment %} @@ -13,6 +13,8 @@ versions: ghes: '>=3.20' category: - Protect your secrets +redirect_from: + - /code-security/concepts/secret-security/about-validity-checks --- ## About validity checks diff --git a/content/code-security/concepts/security-at-scale/auditing-security-alerts.md b/content/code-security/concepts/security-at-scale/audit-security-alerts.md similarity index 99% rename from content/code-security/concepts/security-at-scale/auditing-security-alerts.md rename to content/code-security/concepts/security-at-scale/audit-security-alerts.md index 93610df6f76c..746fbe0a1eda 100644 --- a/content/code-security/concepts/security-at-scale/auditing-security-alerts.md +++ b/content/code-security/concepts/security-at-scale/audit-security-alerts.md @@ -8,6 +8,7 @@ versions: shortTitle: Audit security alerts redirect_from: - /code-security/getting-started/auditing-security-alerts + - /code-security/concepts/security-at-scale/auditing-security-alerts contentType: concepts category: - Secure at scale diff --git a/content/code-security/concepts/security-at-scale/delegated-alert-dismissal.md b/content/code-security/concepts/security-at-scale/delegated-alert-dismissal.md index a1c6e1aa071c..1f70b2d27888 100644 --- a/content/code-security/concepts/security-at-scale/delegated-alert-dismissal.md +++ b/content/code-security/concepts/security-at-scale/delegated-alert-dismissal.md @@ -1,5 +1,6 @@ --- title: Delegated alert dismissal +shortTitle: Delegated alert dismissal intro: 'Increase your governance over security alerts with delegated alert dismissal.' versions: feature: security-delegated-alert-dismissal diff --git a/content/code-security/concepts/security-at-scale/index.md b/content/code-security/concepts/security-at-scale/index.md index 1e716c92df02..d830ecd86134 100644 --- a/content/code-security/concepts/security-at-scale/index.md +++ b/content/code-security/concepts/security-at-scale/index.md @@ -8,16 +8,17 @@ versions: ghec: '*' contentType: concepts children: - - /best-practices-for-selecting-pilot-repositories - - /about-enabling-security-features-at-scale - - /about-security-overview + - /select-pilot-repositories + - /organization-security + - /security-overview - /about-security-campaigns - - /auditing-security-alerts + - /audit-security-alerts - /delegated-alert-dismissal - - /about-supply-chain-security-for-your-enterprise + - /supply-chain-security 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/security-at-scale/about-enabling-security-features-at-scale.md b/content/code-security/concepts/security-at-scale/organization-security.md similarity index 97% rename from content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md rename to content/code-security/concepts/security-at-scale/organization-security.md index 6741362694c7..0578881f1546 100644 --- a/content/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale.md +++ b/content/code-security/concepts/security-at-scale/organization-security.md @@ -1,5 +1,5 @@ --- -title: About enabling security features at scale +title: Enabling security features at scale 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: @@ -12,6 +12,7 @@ redirect_from: - /admin/managing-code-security/securing-your-enterprise/about-security-configurations - /code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/choosing-a-security-configuration-for-your-repositories - /code-security/concepts/security-at-scale/choosing-a-security-configuration-for-your-repositories + - /code-security/concepts/security-at-scale/about-enabling-security-features-at-scale contentType: concepts category: - Secure at scale diff --git a/content/code-security/concepts/security-at-scale/about-security-overview.md b/content/code-security/concepts/security-at-scale/security-overview.md similarity index 99% rename from content/code-security/concepts/security-at-scale/about-security-overview.md rename to content/code-security/concepts/security-at-scale/security-overview.md index c51ecacd5228..79c8f2062c55 100644 --- a/content/code-security/concepts/security-at-scale/about-security-overview.md +++ b/content/code-security/concepts/security-at-scale/security-overview.md @@ -1,5 +1,5 @@ --- -title: About security overview +title: 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: | @@ -11,6 +11,7 @@ redirect_from: - /code-security/security-overview/about-the-security-overview - /code-security/security-overview/about-security-overview - /code-security/security-overview + - /code-security/concepts/security-at-scale/about-security-overview versions: fpt: '*' ghes: '*' diff --git a/content/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories.md b/content/code-security/concepts/security-at-scale/select-pilot-repositories.md similarity index 85% rename from content/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories.md rename to content/code-security/concepts/security-at-scale/select-pilot-repositories.md index cf27db6cf9cc..c020d3971f65 100644 --- a/content/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories.md +++ b/content/code-security/concepts/security-at-scale/select-pilot-repositories.md @@ -1,7 +1,7 @@ --- title: Best practices for selecting pilot repositories shortTitle: Select pilot repositories -intro: 'The right pilot repositories demonstrate value quickly and prepare your organization for broader enablement of {% data variables.product.prodname_GH_secret_protection %}.' +intro: The right pilot repositories demonstrate value quickly and prepare your organization for broader enablement of {% data variables.product.prodname_GH_secret_protection %}. versions: fpt: '*' ghec: '*' @@ -9,6 +9,8 @@ versions: contentType: concepts category: - Secure at scale +redirect_from: + - /code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories --- Before enabling {% data variables.product.prodname_GH_secret_protection %} organization-wide, run a pilot to validate the solution with a small set of repositories. A pilot helps you refine your rollout strategy, identify workflow adjustments, and demonstrate security value to stakeholders. This article will help you choose the best repositories for your pilot. @@ -83,3 +85,15 @@ Take these steps to set your pilot up for success. * Confirm repository owners agree to participate. Unwilling teams generate negative feedback that doesn't reflect actual product issues. * Identify champions within each pilot team. Champions answer questions and keep feedback flowing. * Document baseline metrics like commit frequency and contributor count. These baselines help you measure pilot impact. + +## Further reading + +* [Identify repositories for secret protection](https://support.github.com/product-guides/github-advanced-security-secret-protection/get-started/identify-repositories-for-secret-protection) in the GitHub Advanced Security product guides + +{% ifversion secret-risk-assessment %} + +## Next steps + +Now that you've selected your pilot repositories, review pricing and configure {% data variables.product.prodname_GH_secret_protection %}. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets). + +{% endif %} diff --git a/content/code-security/concepts/security-at-scale/about-supply-chain-security-for-your-enterprise.md b/content/code-security/concepts/security-at-scale/supply-chain-security.md similarity index 85% rename from content/code-security/concepts/security-at-scale/about-supply-chain-security-for-your-enterprise.md rename to content/code-security/concepts/security-at-scale/supply-chain-security.md index ac3d9cf7b8a1..b48796c6232d 100644 --- a/content/code-security/concepts/security-at-scale/about-supply-chain-security-for-your-enterprise.md +++ b/content/code-security/concepts/security-at-scale/supply-chain-security.md @@ -1,6 +1,6 @@ --- -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. +title: Supply chain security for your enterprise +intro: You can enable enterprise-level features that help your developers understand and update the dependencies their code relies on. shortTitle: Supply chain security permissions: '' versions: @@ -8,6 +8,7 @@ versions: 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 + - /code-security/concepts/security-at-scale/about-supply-chain-security-for-your-enterprise contentType: concepts category: - Secure your dependencies diff --git a/content/code-security/concepts/supply-chain-security/about-metrics-for-dependabot-alerts.md b/content/code-security/concepts/supply-chain-security/dependabot-alert-metrics.md similarity index 97% rename from content/code-security/concepts/supply-chain-security/about-metrics-for-dependabot-alerts.md rename to content/code-security/concepts/supply-chain-security/dependabot-alert-metrics.md index 1cc8bcd8bcb2..ea2cac60ee54 100644 --- a/content/code-security/concepts/supply-chain-security/about-metrics-for-dependabot-alerts.md +++ b/content/code-security/concepts/supply-chain-security/dependabot-alert-metrics.md @@ -1,5 +1,5 @@ --- -title: About metrics for Dependabot alerts +title: Metrics for Dependabot alerts intro: Use metrics to track and prioritize {% data variables.product.prodname_dependabot_alerts %} across your organization. versions: feature: dependabot-metrics @@ -9,6 +9,8 @@ shortTitle: Dependabot alert metrics contentType: concepts category: - Secure at scale +redirect_from: + - /code-security/concepts/supply-chain-security/about-metrics-for-dependabot-alerts --- Metrics for {% data variables.product.prodname_dependabot_alerts %} help you understand the security posture of your organization's dependencies and track progress in resolving vulnerabilities. You can use these metrics to prioritize remediation efforts and focus on the most critical security issues. diff --git a/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md b/content/code-security/concepts/supply-chain-security/dependabot-alerts.md similarity index 98% rename from content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md rename to content/code-security/concepts/supply-chain-security/dependabot-alerts.md index a1d56cc18a12..7bbedb59776f 100644 --- a/content/code-security/concepts/supply-chain-security/about-dependabot-alerts.md +++ b/content/code-security/concepts/supply-chain-security/dependabot-alerts.md @@ -1,5 +1,5 @@ --- -title: About Dependabot alerts +title: 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: @@ -9,6 +9,7 @@ redirect_from: - /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 + - /code-security/concepts/supply-chain-security/about-dependabot-alerts versions: fpt: '*' ghes: '*' diff --git a/content/code-security/concepts/supply-chain-security/about-dependabot-auto-triage-rules.md b/content/code-security/concepts/supply-chain-security/dependabot-auto-triage-rules.md similarity index 95% rename from content/code-security/concepts/supply-chain-security/about-dependabot-auto-triage-rules.md rename to content/code-security/concepts/supply-chain-security/dependabot-auto-triage-rules.md index ab1bc1f703af..75c391ba76c1 100644 --- a/content/code-security/concepts/supply-chain-security/about-dependabot-auto-triage-rules.md +++ b/content/code-security/concepts/supply-chain-security/dependabot-auto-triage-rules.md @@ -1,6 +1,6 @@ --- -title: About Dependabot auto-triage rules -intro: 'Control how {% data variables.product.prodname_dependabot %} handles security alerts, including filtering, ignoring, snoozing, or triggering security updates.' +title: Dependabot auto-triage rules +intro: Control how {% data variables.product.prodname_dependabot %} handles security alerts, including filtering, ignoring, snoozing, or triggering security updates. product: '{% data reusables.gated-features.dependabot-auto-triage-rules %}' versions: fpt: '*' @@ -12,6 +12,7 @@ redirect_from: - /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 + - /code-security/concepts/supply-chain-security/about-dependabot-auto-triage-rules contentType: concepts category: - Secure your dependencies diff --git a/content/code-security/concepts/supply-chain-security/about-dependabot-on-github-actions-runners.md b/content/code-security/concepts/supply-chain-security/dependabot-on-actions.md similarity index 98% rename from content/code-security/concepts/supply-chain-security/about-dependabot-on-github-actions-runners.md rename to content/code-security/concepts/supply-chain-security/dependabot-on-actions.md index 8cd93d2d0bb0..2cc7eea81183 100644 --- a/content/code-security/concepts/supply-chain-security/about-dependabot-on-github-actions-runners.md +++ b/content/code-security/concepts/supply-chain-security/dependabot-on-actions.md @@ -1,5 +1,5 @@ --- -title: About Dependabot on GitHub Actions runners +title: 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: Dependabot on Actions product: '{% data reusables.gated-features.dependabot-on-actions %}' @@ -7,6 +7,7 @@ versions: feature: dependabot-on-actions-opt-in redirect_from: - /code-security/dependabot/working-with-dependabot/about-dependabot-on-github-actions-runners + - /code-security/concepts/supply-chain-security/about-dependabot-on-github-actions-runners contentType: concepts category: - Secure your dependencies diff --git a/content/code-security/concepts/supply-chain-security/about-dependabot-pull-requests.md b/content/code-security/concepts/supply-chain-security/dependabot-pull-requests.md similarity index 94% rename from content/code-security/concepts/supply-chain-security/about-dependabot-pull-requests.md rename to content/code-security/concepts/supply-chain-security/dependabot-pull-requests.md index 9d179e26bcd1..63359c9d84a6 100644 --- a/content/code-security/concepts/supply-chain-security/about-dependabot-pull-requests.md +++ b/content/code-security/concepts/supply-chain-security/dependabot-pull-requests.md @@ -1,6 +1,6 @@ --- -title: About Dependabot pull requests -intro: 'Understand the frequency and customization options of pull requests for version and security updates.' +title: Dependabot pull requests +intro: Understand the frequency and customization options of pull requests for version and security updates. shortTitle: Dependabot pull requests versions: fpt: '*' @@ -9,6 +9,8 @@ versions: contentType: concepts category: - Secure your dependencies +redirect_from: + - /code-security/concepts/supply-chain-security/about-dependabot-pull-requests --- ## Pull requests for security updates diff --git a/content/code-security/concepts/supply-chain-security/about-dependabot-security-updates.md b/content/code-security/concepts/supply-chain-security/dependabot-security-updates.md similarity index 98% rename from content/code-security/concepts/supply-chain-security/about-dependabot-security-updates.md rename to content/code-security/concepts/supply-chain-security/dependabot-security-updates.md index 3cd529c26378..3a4feebef8f8 100644 --- a/content/code-security/concepts/supply-chain-security/about-dependabot-security-updates.md +++ b/content/code-security/concepts/supply-chain-security/dependabot-security-updates.md @@ -1,5 +1,5 @@ --- -title: About Dependabot security updates +title: Dependabot security updates intro: '{% data variables.product.prodname_dependabot %} can fix vulnerable dependencies for you by raising pull requests with security updates.' product: '{% data reusables.gated-features.dependabot-security-updates %}' shortTitle: Dependabot security updates @@ -9,6 +9,7 @@ redirect_from: - /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 + - /code-security/concepts/supply-chain-security/about-dependabot-security-updates versions: fpt: '*' ghec: '*' diff --git a/content/code-security/concepts/supply-chain-security/about-dependabot-version-updates.md b/content/code-security/concepts/supply-chain-security/dependabot-version-updates.md similarity index 98% rename from content/code-security/concepts/supply-chain-security/about-dependabot-version-updates.md rename to content/code-security/concepts/supply-chain-security/dependabot-version-updates.md index fdead21540be..ac8bc42a72d8 100644 --- a/content/code-security/concepts/supply-chain-security/about-dependabot-version-updates.md +++ b/content/code-security/concepts/supply-chain-security/dependabot-version-updates.md @@ -1,5 +1,5 @@ --- -title: About Dependabot version updates +title: Dependabot version updates 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: @@ -14,6 +14,7 @@ redirect_from: - /code-security/dependabot/dependabot-version-updates - /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically - /administering-a-repository/keeping-your-dependencies-updated-automatically + - /code-security/concepts/supply-chain-security/about-dependabot-version-updates versions: fpt: '*' ghec: '*' diff --git a/content/code-security/concepts/supply-chain-security/about-the-dependency-graph.md b/content/code-security/concepts/supply-chain-security/dependency-graph.md similarity index 98% rename from content/code-security/concepts/supply-chain-security/about-the-dependency-graph.md rename to content/code-security/concepts/supply-chain-security/dependency-graph.md index f6fd219a430f..6d5cd7fe797c 100644 --- a/content/code-security/concepts/supply-chain-security/about-the-dependency-graph.md +++ b/content/code-security/concepts/supply-chain-security/dependency-graph.md @@ -1,11 +1,12 @@ --- -title: About the dependency graph +title: Dependency graph intro: You can use the dependency graph to identify all your project's dependencies. The dependency graph supports a range of popular package ecosystems. 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 + - /code-security/concepts/supply-chain-security/about-the-dependency-graph versions: fpt: '*' ghes: '*' diff --git a/content/code-security/concepts/supply-chain-security/about-dependency-review.md b/content/code-security/concepts/supply-chain-security/dependency-review.md similarity index 98% rename from content/code-security/concepts/supply-chain-security/about-dependency-review.md rename to content/code-security/concepts/supply-chain-security/dependency-review.md index 3251f389fc82..3ef3a61e8faf 100644 --- a/content/code-security/concepts/supply-chain-security/about-dependency-review.md +++ b/content/code-security/concepts/supply-chain-security/dependency-review.md @@ -1,5 +1,5 @@ --- -title: About dependency review +title: 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. product: '{% data reusables.gated-features.dependency-review %}' shortTitle: Dependency review @@ -10,6 +10,7 @@ versions: redirect_from: - /code-security/supply-chain-security/about-dependency-review - /code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review + - /code-security/concepts/supply-chain-security/about-dependency-review contentType: concepts category: - Secure your dependencies diff --git a/content/code-security/concepts/supply-chain-security/immutable-releases.md b/content/code-security/concepts/supply-chain-security/immutable-releases.md index 08757f152b7f..5fc0abf1e3ca 100644 --- a/content/code-security/concepts/supply-chain-security/immutable-releases.md +++ b/content/code-security/concepts/supply-chain-security/immutable-releases.md @@ -1,5 +1,6 @@ --- title: Immutable releases +shortTitle: Immutable releases intro: Learn about immutable releases and how they can help you maintain the integrity of your software supply chain. versions: feature: immutable-releases diff --git a/content/code-security/concepts/supply-chain-security/index.md b/content/code-security/concepts/supply-chain-security/index.md index 53cdc266d80a..2454753502f9 100644 --- a/content/code-security/concepts/supply-chain-security/index.md +++ b/content/code-security/concepts/supply-chain-security/index.md @@ -9,22 +9,23 @@ contentType: concepts redirect_from: - /code-security/supply-chain-security/understanding-your-software-supply-chain children: - - about-supply-chain-security + - supply-chain-security - best-practices-for-maintaining-dependencies - - about-the-dependency-graph + - dependency-graph - dependency-graph-data - - about-dependency-review - - about-dependabot-alerts - - dependabot-malware-alerts - - about-metrics-for-dependabot-alerts - - about-dependabot-security-updates - - about-dependabot-version-updates - - about-dependabot-pull-requests + - dependency-review + - dependabot-alerts + - malware-alerts + - dependabot-alert-metrics + - dependabot-security-updates + - dependabot-version-updates + - dependabot-pull-requests - multi-ecosystem-updates - about-the-dependabot-yml-file - - about-dependabot-auto-triage-rules - - about-dependabot-on-github-actions-runners + - dependabot-auto-triage-rules + - dependabot-on-actions - dependabot-job-logs - immutable-releases - linked-artifacts --- + diff --git a/content/code-security/concepts/supply-chain-security/dependabot-malware-alerts.md b/content/code-security/concepts/supply-chain-security/malware-alerts.md similarity index 97% rename from content/code-security/concepts/supply-chain-security/dependabot-malware-alerts.md rename to content/code-security/concepts/supply-chain-security/malware-alerts.md index 7beb0be0f074..e9cb330bed08 100644 --- a/content/code-security/concepts/supply-chain-security/dependabot-malware-alerts.md +++ b/content/code-security/concepts/supply-chain-security/malware-alerts.md @@ -1,5 +1,6 @@ --- title: Dependabot malware alerts +shortTitle: Malware alerts intro: '{% data variables.product.prodname_dependabot_malware_alerts %} help you identify malware in your dependencies to protect your project and its users.' product: '{% data reusables.gated-features.dependabot-malware-alerts %}' versions: @@ -7,6 +8,8 @@ versions: contentType: concepts category: - Secure your dependencies +redirect_from: + - /code-security/concepts/supply-chain-security/dependabot-malware-alerts --- Software often relies on packages from various sources, creating dependency relationships that can threaten your project's security. For example, bad actors can use malicious packages to execute malware attacks, gaining access to your code, data, users, and contributors. diff --git a/content/code-security/concepts/supply-chain-security/about-supply-chain-security.md b/content/code-security/concepts/supply-chain-security/supply-chain-security.md similarity index 99% rename from content/code-security/concepts/supply-chain-security/about-supply-chain-security.md rename to content/code-security/concepts/supply-chain-security/supply-chain-security.md index 8aef6795a6e1..4856861ca01a 100644 --- a/content/code-security/concepts/supply-chain-security/about-supply-chain-security.md +++ b/content/code-security/concepts/supply-chain-security/supply-chain-security.md @@ -1,10 +1,11 @@ --- -title: About supply chain security +title: 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 features +shortTitle: Supply chain security 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 + - /code-security/concepts/supply-chain-security/about-supply-chain-security versions: fpt: '*' ghes: '*' diff --git a/content/code-security/concepts/vulnerability-reporting-and-management/about-coordinated-disclosure-of-security-vulnerabilities.md b/content/code-security/concepts/vulnerability-reporting-and-management/coordinated-disclosure.md similarity index 98% rename from content/code-security/concepts/vulnerability-reporting-and-management/about-coordinated-disclosure-of-security-vulnerabilities.md rename to content/code-security/concepts/vulnerability-reporting-and-management/coordinated-disclosure.md index d5ff9aa11d09..bb10c2cb7fc5 100644 --- a/content/code-security/concepts/vulnerability-reporting-and-management/about-coordinated-disclosure-of-security-vulnerabilities.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/coordinated-disclosure.md @@ -1,5 +1,5 @@ --- -title: About coordinated disclosure of security vulnerabilities +title: Coordinated disclosure of security vulnerabilities intro: Vulnerability disclosure is a coordinated effort between security reporters and repository maintainers. redirect_from: - /code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities @@ -10,6 +10,7 @@ redirect_from: - /code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/configuring-private-vulnerability-reporting-for-an-organization - /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 + - /code-security/concepts/vulnerability-reporting-and-management/about-coordinated-disclosure-of-security-vulnerabilities versions: fpt: '*' ghec: '*' diff --git a/content/code-security/concepts/vulnerability-reporting-and-management/about-the-github-advisory-database.md b/content/code-security/concepts/vulnerability-reporting-and-management/github-advisory-database.md similarity index 98% rename from content/code-security/concepts/vulnerability-reporting-and-management/about-the-github-advisory-database.md rename to content/code-security/concepts/vulnerability-reporting-and-management/github-advisory-database.md index d5b88d4062e4..3576365801ce 100644 --- a/content/code-security/concepts/vulnerability-reporting-and-management/about-the-github-advisory-database.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/github-advisory-database.md @@ -1,5 +1,5 @@ --- -title: About the GitHub Advisory database +title: GitHub Advisory database intro: 'The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities and malware, grouped in three categories: {% data variables.product.company_short %}-reviewed advisories, unreviewed advisories, and malware advisories.' versions: fpt: '*' @@ -10,6 +10,7 @@ shortTitle: GitHub Advisory database 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 + - /code-security/concepts/vulnerability-reporting-and-management/about-the-github-advisory-database category: - Secure your dependencies --- diff --git a/content/code-security/concepts/vulnerability-reporting-and-management/about-global-security-advisories.md b/content/code-security/concepts/vulnerability-reporting-and-management/global-security-advisories.md similarity index 94% rename from content/code-security/concepts/vulnerability-reporting-and-management/about-global-security-advisories.md rename to content/code-security/concepts/vulnerability-reporting-and-management/global-security-advisories.md index 05651fa27339..486d044c50bb 100644 --- a/content/code-security/concepts/vulnerability-reporting-and-management/about-global-security-advisories.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/global-security-advisories.md @@ -1,5 +1,5 @@ --- -title: About global security advisories +title: Global security advisories shortTitle: Global security advisories intro: Global security advisories are CVEs and {% data variables.product.company_short %}-originated advisories affecting the open source world, located in the {% data variables.product.prodname_advisory_database %}. versions: @@ -10,6 +10,7 @@ contentType: concepts 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 + - /code-security/concepts/vulnerability-reporting-and-management/about-global-security-advisories category: - Secure your dependencies --- @@ -36,4 +37,4 @@ Access advisories in the {% data variables.product.prodname_advisory_database %} ## Further reading * [AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories) -{% endif %} \ No newline at end of file +{% endif %} diff --git a/content/code-security/concepts/vulnerability-reporting-and-management/index.md b/content/code-security/concepts/vulnerability-reporting-and-management/index.md index 27b4a850a208..96e4c138a7c3 100644 --- a/content/code-security/concepts/vulnerability-reporting-and-management/index.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/index.md @@ -1,15 +1,16 @@ --- title: Concepts for vulnerability reporting and management -shortTitle: Vulnerability reporting +shortTitle: Vulnerability reporting and management intro: Learn core concepts relating to vulnerability reporting and management on {% data variables.product.github %}. versions: fpt: '*' ghec: '*' 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 + - /github-advisory-database + - /repository-security-advisories + - /global-security-advisories + - /coordinated-disclosure + - /vulnerability-exposure --- + diff --git a/content/code-security/concepts/vulnerability-reporting-and-management/about-repository-security-advisories.md b/content/code-security/concepts/vulnerability-reporting-and-management/repository-security-advisories.md similarity index 97% rename from content/code-security/concepts/vulnerability-reporting-and-management/about-repository-security-advisories.md rename to content/code-security/concepts/vulnerability-reporting-and-management/repository-security-advisories.md index 6f5c11f89b5a..d9c1c8fae442 100644 --- a/content/code-security/concepts/vulnerability-reporting-and-management/about-repository-security-advisories.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/repository-security-advisories.md @@ -1,5 +1,5 @@ --- -title: About repository security advisories +title: 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: @@ -10,6 +10,7 @@ redirect_from: - /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 + - /code-security/concepts/vulnerability-reporting-and-management/about-repository-security-advisories versions: fpt: '*' ghec: '*' diff --git a/content/code-security/concepts/vulnerability-reporting-and-management/about-your-exposure-to-vulnerabilities-in-your-code-and-in-dependencies.md b/content/code-security/concepts/vulnerability-reporting-and-management/vulnerability-exposure.md similarity index 96% rename from content/code-security/concepts/vulnerability-reporting-and-management/about-your-exposure-to-vulnerabilities-in-your-code-and-in-dependencies.md rename to content/code-security/concepts/vulnerability-reporting-and-management/vulnerability-exposure.md index 350dc9bf42d1..3011a5d34afc 100644 --- a/content/code-security/concepts/vulnerability-reporting-and-management/about-your-exposure-to-vulnerabilities-in-your-code-and-in-dependencies.md +++ b/content/code-security/concepts/vulnerability-reporting-and-management/vulnerability-exposure.md @@ -1,8 +1,7 @@ --- -title: About exposure to vulnerabilities in your code and in dependencies +title: Exposure to vulnerabilities in your code and in dependencies shortTitle: Vulnerability exposure intro: Understand how vulnerabilities in your own code and in third-party dependencies contribute to your organization's overall security exposure, and how to measure and reduce that risk. -allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.ghas-billing %}' versions: feature: dependabot-metrics @@ -10,6 +9,8 @@ contentType: concepts 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 + - /code-security/concepts/vulnerability-reporting-and-management/about-your-exposure-to-vulnerabilities-in-your-code-and-in-dependencies + - /code-security/concepts/vulnerability-reporting-and-management/vulnerability-exposure-in-your-code-and-dependencies category: - Secure your dependencies --- diff --git a/content/code-security/reference/code-scanning/codeql/codeql-build-options-and-steps-for-compiled-languages.md b/content/code-security/reference/code-scanning/codeql/build-options-for-compiled-languages.md similarity index 99% rename from content/code-security/reference/code-scanning/codeql/codeql-build-options-and-steps-for-compiled-languages.md rename to content/code-security/reference/code-scanning/codeql/build-options-for-compiled-languages.md index a312cd4326d8..96a439cc0c87 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-build-options-and-steps-for-compiled-languages.md +++ b/content/code-security/reference/code-scanning/codeql/build-options-for-compiled-languages.md @@ -11,6 +11,8 @@ versions: contentType: reference category: - Find CodeQL CLI commands +redirect_from: + - /code-security/reference/code-scanning/codeql/codeql-build-options-and-steps-for-compiled-languages --- ## Autobuild steps for compiled languages @@ -302,4 +304,4 @@ Code scanning of Swift code uses macOS runners by default. {% ifversion fpt or g You can pass the `archive` and `test` options to `xcodebuild`. However, the standard `xcodebuild` command is recommended as it should be the fastest, and should be all that {% data variables.product.prodname_codeql %} requires for a successful scan. -For Swift analysis, you must always explicitly install dependencies managed via CocoaPods or Carthage before generating the {% data variables.product.prodname_codeql %} database. \ No newline at end of file +For Swift analysis, you must always explicitly install dependencies managed via CocoaPods or Carthage before generating the {% data variables.product.prodname_codeql %} database. diff --git a/content/code-security/reference/code-scanning/codeql/codeql-cli/csv-output.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/csv-output.md index a09c61dfca1b..0f5f5f50313c 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-cli/csv-output.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/csv-output.md @@ -1,5 +1,6 @@ --- title: CodeQL CLI CSV output +shortTitle: CSV output intro: Understand CSV results from the {% data variables.product.prodname_codeql_cli %}. product: '{% data reusables.gated-features.codeql %}' allowTitleToDifferFromFilename: true diff --git a/content/code-security/reference/code-scanning/codeql/codeql-cli/exit-codes.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/exit-codes.md index 87b3b15f7c1c..6edc1712e744 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-cli/exit-codes.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/exit-codes.md @@ -1,5 +1,6 @@ --- title: Exit codes +shortTitle: Exit codes 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: diff --git a/content/code-security/reference/code-scanning/codeql/codeql-cli/extractor-options.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/extractor-options.md index 9efabdd7e007..a85ba1dabc01 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-cli/extractor-options.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/extractor-options.md @@ -1,5 +1,6 @@ --- title: Extractor options +shortTitle: Extractor options intro: Control how the {% data variables.product.prodname_codeql_cli %} builds databases for analysis with extractor options. product: '{% data reusables.gated-features.codeql %}' versions: diff --git a/content/code-security/reference/code-scanning/codeql/codeql-cli/sarif-output.md b/content/code-security/reference/code-scanning/codeql/codeql-cli/sarif-output.md index 2ff0df4dbb15..f82f4567bb0b 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-cli/sarif-output.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-cli/sarif-output.md @@ -1,5 +1,6 @@ --- title: CodeQL CLI SARIF output +shortTitle: SARIF output 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 diff --git a/content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/warning-problem-with-controller-repository.md b/content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/controller-repository-warning.md similarity index 91% rename from content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/warning-problem-with-controller-repository.md rename to content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/controller-repository-warning.md index 8ea1a41541be..6bea3463445e 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/warning-problem-with-controller-repository.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/controller-repository-warning.md @@ -1,11 +1,12 @@ --- title: Problem with controller repository -shortTitle: Troubleshoot controller repository +shortTitle: Controller repository warning versions: feature: codeql-vs-code-mrva intro: If you see this warning, update your controller repository to a private repository. allowTitleToDifferFromFilename: true redirect_from: + - /code-security/reference/code-scanning/codeql/codeql-for-vs-code/warning-problem-with-controller-repository - /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 - /code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-codeql-for-vs-code/warning-problem-with-controller-repository diff --git a/content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/index.md b/content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/index.md index 1c551b1fe858..6424cefba9de 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/index.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-for-vs-code/index.md @@ -9,7 +9,7 @@ versions: contentType: reference children: - /telemetry-in-codeql-for-visual-studio-code - - /warning-problem-with-controller-repository + - /controller-repository-warning 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 diff --git a/content/code-security/reference/code-scanning/codeql/codeql-queries/about-built-in-queries.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/built-in-queries.md similarity index 89% rename from content/code-security/reference/code-scanning/codeql/codeql-queries/about-built-in-queries.md rename to content/code-security/reference/code-scanning/codeql/codeql-queries/built-in-queries.md index 1e38ce821e49..c46843119ba3 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-queries/about-built-in-queries.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/built-in-queries.md @@ -1,6 +1,6 @@ --- title: About built-in CodeQL queries -shortTitle: About built-in queries +shortTitle: Built-in queries allowTitleToDifferFromFilename: true intro: Learn about the CodeQL queries that code scanning uses to analyze code. product: '{% data reusables.gated-features.code-scanning %}' @@ -10,6 +10,7 @@ versions: ghes: '*' contentType: reference redirect_from: + - /code-security/reference/code-scanning/codeql/codeql-queries/about-built-in-queries - /code-security/code-scanning/reference/code-ql-built-in-queries/about-built-in-queries category: - Find CodeQL CLI commands diff --git a/content/code-security/reference/code-scanning/codeql/codeql-queries/index.md b/content/code-security/reference/code-scanning/codeql/codeql-queries/index.md index b793c794f39f..7bc4a64020a0 100644 --- a/content/code-security/reference/code-scanning/codeql/codeql-queries/index.md +++ b/content/code-security/reference/code-scanning/codeql/codeql-queries/index.md @@ -8,7 +8,7 @@ versions: ghec: '*' ghes: '*' children: - - /about-built-in-queries + - /built-in-queries - /actions-built-in-queries - /c-cpp-built-in-queries - /csharp-built-in-queries diff --git a/content/code-security/reference/code-scanning/codeql/recommended-hardware-resources-for-running-codeql.md b/content/code-security/reference/code-scanning/codeql/hardware-resources-for-codeql.md similarity index 95% rename from content/code-security/reference/code-scanning/codeql/recommended-hardware-resources-for-running-codeql.md rename to content/code-security/reference/code-scanning/codeql/hardware-resources-for-codeql.md index dd6d829b9e00..45d914817dc0 100644 --- a/content/code-security/reference/code-scanning/codeql/recommended-hardware-resources-for-running-codeql.md +++ b/content/code-security/reference/code-scanning/codeql/hardware-resources-for-codeql.md @@ -6,6 +6,7 @@ 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 + - /code-security/reference/code-scanning/codeql/recommended-hardware-resources-for-running-codeql versions: fpt: '*' ghes: '*' diff --git a/content/code-security/reference/code-scanning/codeql/index.md b/content/code-security/reference/code-scanning/codeql/index.md index 29c8c834cfc3..890023be1ab4 100644 --- a/content/code-security/reference/code-scanning/codeql/index.md +++ b/content/code-security/reference/code-scanning/codeql/index.md @@ -8,10 +8,11 @@ versions: ghec: '*' contentType: reference children: - - /recommended-hardware-resources-for-running-codeql - - /codeql-build-options-and-steps-for-compiled-languages + - /hardware-resources-for-codeql + - /build-options-for-compiled-languages - /codeql-queries - /codeql-cli - /codeql-cli-manual - /codeql-for-vs-code --- + diff --git a/content/code-security/reference/code-scanning/sarif-files/index.md b/content/code-security/reference/code-scanning/sarif-files/index.md index 7f2b8ce3e570..f146582f7de1 100644 --- a/content/code-security/reference/code-scanning/sarif-files/index.md +++ b/content/code-security/reference/code-scanning/sarif-files/index.md @@ -8,6 +8,7 @@ versions: ghec: '*' contentType: reference children: - - /sarif-support-for-code-scanning + - /sarif-support - /troubleshoot-sarif-uploads --- + diff --git a/content/code-security/reference/code-scanning/sarif-files/sarif-support-for-code-scanning.md b/content/code-security/reference/code-scanning/sarif-files/sarif-support.md similarity index 99% rename from content/code-security/reference/code-scanning/sarif-files/sarif-support-for-code-scanning.md rename to content/code-security/reference/code-scanning/sarif-files/sarif-support.md index 441b0385a4f7..03d53ff67c06 100644 --- a/content/code-security/reference/code-scanning/sarif-files/sarif-support-for-code-scanning.md +++ b/content/code-security/reference/code-scanning/sarif-files/sarif-support.md @@ -11,6 +11,7 @@ redirect_from: - /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 - /code-security/reference/code-scanning/sarif-support-for-code-scanning + - /code-security/reference/code-scanning/sarif-files/sarif-support-for-code-scanning versions: fpt: '*' ghes: '*' diff --git a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/enabling-default-setup-takes-too-long.md b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/default-setup-timeout.md similarity index 92% rename from content/code-security/reference/code-scanning/troubleshoot-analysis-errors/enabling-default-setup-takes-too-long.md rename to content/code-security/reference/code-scanning/troubleshoot-analysis-errors/default-setup-timeout.md index 60a11ea1060b..34aa265eae69 100644 --- a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/enabling-default-setup-takes-too-long.md +++ b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/default-setup-timeout.md @@ -1,5 +1,6 @@ --- title: Enabling default setup takes too long +shortTitle: Default setup timeout intro: If you think that enabling default setup has stalled, you can restart the process. allowTitleToDifferFromFilename: true versions: @@ -7,6 +8,7 @@ versions: ghes: '*' ghec: '*' redirect_from: + - /code-security/reference/code-scanning/troubleshoot-analysis-errors/enabling-default-setup-takes-too-long - /code-security/code-scanning/troubleshooting-code-scanning/enabling-default-setup-takes-too-long - /code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/enabling-default-setup-takes-too-long contentType: reference diff --git a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/extraction-errors-in-the-database.md b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/extraction-errors-in-the-database.md index bb08765c4ea9..007417ae6b85 100644 --- a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/extraction-errors-in-the-database.md +++ b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/extraction-errors-in-the-database.md @@ -1,5 +1,6 @@ --- title: Extraction errors in the database +shortTitle: Extraction errors intro: You can check whether or not extraction errors affect the health of the {% data variables.product.prodname_codeql %} database created. allowTitleToDifferFromFilename: true versions: diff --git a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/index.md b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/index.md index 9428383746fb..2763885a27ff 100644 --- a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/index.md +++ b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/index.md @@ -11,10 +11,10 @@ children: - /alerts-in-generated-code - /automatic-build-failed - /c-sharp-compiler-unexpectedly-failing - - /cannot-enable-codeql-in-a-private-repository + - /private-repository-enablement - /analysis-takes-too-long - /fewer-lines-scanned-than-expected - - /enabling-default-setup-takes-too-long + - /default-setup-timeout - /advanced-security-must-be-enabled - /out-of-disk-or-memory - /resource-not-accessible diff --git a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/cannot-enable-codeql-in-a-private-repository.md b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/private-repository-enablement.md similarity index 95% rename from content/code-security/reference/code-scanning/troubleshoot-analysis-errors/cannot-enable-codeql-in-a-private-repository.md rename to content/code-security/reference/code-scanning/troubleshoot-analysis-errors/private-repository-enablement.md index e11e958d7e08..bf00010bad0d 100644 --- a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/cannot-enable-codeql-in-a-private-repository.md +++ b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/private-repository-enablement.md @@ -1,5 +1,6 @@ --- title: Cannot enable CodeQL in a private repository +shortTitle: Private repository enablement 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 versions: @@ -7,6 +8,7 @@ versions: ghes: '*' ghec: '*' redirect_from: + - /code-security/reference/code-scanning/troubleshoot-analysis-errors/cannot-enable-codeql-in-a-private-repository - /code-security/code-scanning/troubleshooting-code-scanning/cannot-enable-codeql-in-a-private-repository - /code-security/how-tos/scan-code-for-vulnerabilities/troubleshooting/troubleshooting-analysis-errors/cannot-enable-codeql-in-a-private-repository contentType: reference diff --git a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/two-codeql-workflows.md b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/two-codeql-workflows.md index 067b90a1c475..d2170d18c456 100644 --- a/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/two-codeql-workflows.md +++ b/content/code-security/reference/code-scanning/troubleshoot-analysis-errors/two-codeql-workflows.md @@ -1,5 +1,6 @@ --- title: Two CodeQL workflows +shortTitle: 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. versions: diff --git a/content/code-security/reference/permissions/index.md b/content/code-security/reference/permissions/index.md index 642485a6b1da..948d1dea47c5 100644 --- a/content/code-security/reference/permissions/index.md +++ b/content/code-security/reference/permissions/index.md @@ -7,6 +7,7 @@ versions: ghec: '*' contentType: reference children: - - /permission-levels-for-repository-security-advisories - - /security-overview-permissions ---- \ No newline at end of file + - /repository-security-advisory + - /security-overview +--- + diff --git a/content/code-security/reference/permissions/permission-levels-for-repository-security-advisories.md b/content/code-security/reference/permissions/repository-security-advisory.md similarity index 96% rename from content/code-security/reference/permissions/permission-levels-for-repository-security-advisories.md rename to content/code-security/reference/permissions/repository-security-advisory.md index c5e49dff8e0c..b98e3846a4c0 100644 --- a/content/code-security/reference/permissions/permission-levels-for-repository-security-advisories.md +++ b/content/code-security/reference/permissions/repository-security-advisory.md @@ -1,8 +1,10 @@ --- title: Repository security advisories +shortTitle: Repository security advisory intro: The actions you can take in a repository security advisory depend on whether you have admin or write permissions to the security advisory. allowTitleToDifferFromFilename: true redirect_from: + - /code-security/reference/permissions/permission-levels-for-repository-security-advisories - /articles/permission-levels-for-maintainer-security-advisories - /github/managing-security-vulnerabilities/permission-levels-for-maintainer-security-advisories - /github/managing-security-vulnerabilities/permission-levels-for-security-advisories @@ -11,6 +13,7 @@ redirect_from: - /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 - /code-security/reference/permission-levels-for-repository-security-advisories + - /code-security/reference/permissions/security-advisory-permissions versions: fpt: '*' ghec: '*' diff --git a/content/code-security/reference/permissions/security-overview-permissions.md b/content/code-security/reference/permissions/security-overview.md similarity index 97% rename from content/code-security/reference/permissions/security-overview-permissions.md rename to content/code-security/reference/permissions/security-overview.md index 5cdd5153984c..970ef6fe83d6 100644 --- a/content/code-security/reference/permissions/security-overview-permissions.md +++ b/content/code-security/reference/permissions/security-overview.md @@ -9,6 +9,8 @@ versions: contentType: reference category: - Secure at scale +redirect_from: + - /code-security/reference/permissions/security-overview-permissions --- The actions you can take in the security overview depend on your permissions for the repositories in your organization or enterprise. diff --git a/content/code-security/reference/secret-security/index.md b/content/code-security/reference/secret-security/index.md index cdbce42ddd7f..bc3c8586e5d3 100644 --- a/content/code-security/reference/secret-security/index.md +++ b/content/code-security/reference/secret-security/index.md @@ -7,10 +7,11 @@ versions: ghec: '*' contentType: reference children: - - /understanding-github-secret-types + - /secret-types - /supported-secret-scanning-patterns - - /secret-scanning-detection-scope + - /secret-scanning-scope - /custom-patterns - /risk-report-csv-contents - - /secret-scanning-pattern-configuration-data + - /secret-pattern-data --- + diff --git a/content/code-security/reference/secret-security/secret-scanning-pattern-configuration-data.md b/content/code-security/reference/secret-security/secret-pattern-data.md similarity index 92% rename from content/code-security/reference/secret-security/secret-scanning-pattern-configuration-data.md rename to content/code-security/reference/secret-security/secret-pattern-data.md index 7a558df0ef3c..4ea9a5bfe7e4 100644 --- a/content/code-security/reference/secret-security/secret-scanning-pattern-configuration-data.md +++ b/content/code-security/reference/secret-security/secret-pattern-data.md @@ -10,6 +10,8 @@ versions: contentType: reference category: - Protect your secrets +redirect_from: + - /code-security/reference/secret-security/secret-scanning-pattern-configuration-data --- When configuring push protection, you can view performance data for each secret pattern to make informed enablement decisions. Use metrics like alert volume and false positive rates to balance security with developer experience. See [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/configuring-global-security-settings-for-your-organization#specifying-patterns-to-include-in-push-protection){% ifversion security-configuration-enterprise-level %} or [AUTOTITLE](/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/configuring-additional-secret-scanning-settings-for-your-enterprise#specifying-patterns-to-include-in-push-protection-for-your-enterprise){% endif %}. diff --git a/content/code-security/reference/secret-security/secret-scanning-detection-scope.md b/content/code-security/reference/secret-security/secret-scanning-scope.md similarity index 98% rename from content/code-security/reference/secret-security/secret-scanning-detection-scope.md rename to content/code-security/reference/secret-security/secret-scanning-scope.md index 0e52cce8d984..9ff5cc7e0bde 100644 --- a/content/code-security/reference/secret-security/secret-scanning-detection-scope.md +++ b/content/code-security/reference/secret-security/secret-scanning-scope.md @@ -12,6 +12,7 @@ redirect_from: - /code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection/troubleshooting-secret-scanning - /code-security/secret-scanning/troubleshooting-secret-scanning-and-push-protection - /code-security/how-tos/secure-your-secrets/troubleshooting-secret-scanning + - /code-security/reference/secret-security/secret-scanning-detection-scope contentType: reference category: - Protect your secrets diff --git a/content/code-security/reference/secret-security/understanding-github-secret-types.md b/content/code-security/reference/secret-security/secret-types.md similarity index 99% rename from content/code-security/reference/secret-security/understanding-github-secret-types.md rename to content/code-security/reference/secret-security/secret-types.md index e494de833ff5..234ca69f521b 100644 --- a/content/code-security/reference/secret-security/understanding-github-secret-types.md +++ b/content/code-security/reference/secret-security/secret-types.md @@ -5,9 +5,10 @@ versions: fpt: '*' ghes: '*' ghec: '*' -shortTitle: Understand secret types +shortTitle: Secret types redirect_from: - /code-security/getting-started/understanding-github-secret-types + - /code-security/reference/secret-security/understanding-github-secret-types contentType: reference category: - Protect your secrets diff --git a/content/code-security/reference/security-at-scale/security-configuration-enforcement.md b/content/code-security/reference/security-at-scale/configuration-enforcement.md similarity index 91% rename from content/code-security/reference/security-at-scale/security-configuration-enforcement.md rename to content/code-security/reference/security-at-scale/configuration-enforcement.md index 84eb02ec729a..19b15400c191 100644 --- a/content/code-security/reference/security-at-scale/security-configuration-enforcement.md +++ b/content/code-security/reference/security-at-scale/configuration-enforcement.md @@ -1,5 +1,6 @@ --- title: Security configuration enforcement +shortTitle: Configuration enforcement intro: Understand the complexities of enforcing {% data variables.product.prodname_security_configurations %}. versions: fpt: '*' @@ -8,6 +9,8 @@ versions: contentType: reference category: - Secure at scale +redirect_from: + - /code-security/reference/security-at-scale/security-configuration-enforcement --- {% data variables.product.prodname_security_configurations_caps %} can be enforced, meaning repository owners cannot change the enablement status of features that are enabled or disabled by the configuration. diff --git a/content/code-security/reference/security-at-scale/security-configuration-statuses.md b/content/code-security/reference/security-at-scale/configuration-statuses.md similarity index 95% rename from content/code-security/reference/security-at-scale/security-configuration-statuses.md rename to content/code-security/reference/security-at-scale/configuration-statuses.md index aecf6444f1f1..be0035f9b304 100644 --- a/content/code-security/reference/security-at-scale/security-configuration-statuses.md +++ b/content/code-security/reference/security-at-scale/configuration-statuses.md @@ -1,7 +1,7 @@ --- title: Security configuration statuses shortTitle: Configuration statuses -intro: 'Each repository that has a {% data variables.product.prodname_security_configuration %} applied to it has a configuration status that reflects the current state of the relationship between the repository and the configuration.' +intro: Each repository that has a {% data variables.product.prodname_security_configuration %} applied to it has a configuration status that reflects the current state of the relationship between the repository and the configuration. versions: fpt: '*' ghec: '*' @@ -9,6 +9,8 @@ versions: contentType: reference category: - Secure at scale +redirect_from: + - /code-security/reference/security-at-scale/security-configuration-statuses --- A repository's configuration status tells you the current state of its relationship with the applied {% data variables.product.prodname_security_configuration %}. That relationship can change over time—for example, when a repository admin overrides a setting, an admin enables enforcement, or an attachment fails. For more about how configurations and repositories interact, see [AUTOTITLE](/code-security/concepts/security-at-scale/about-enabling-security-features-at-scale). diff --git a/content/code-security/reference/security-at-scale/index.md b/content/code-security/reference/security-at-scale/index.md index d6b7d2bc92e9..8a7e4eb2d642 100644 --- a/content/code-security/reference/security-at-scale/index.md +++ b/content/code-security/reference/security-at-scale/index.md @@ -8,9 +8,10 @@ versions: ghec: '*' contentType: reference children: - - /security-overview-dashboard-metrics - - /available-filters-for-security-overview - - /security-configuration-enforcement - - /security-configuration-statuses + - /overview-dashboard-metrics + - /overview-dashboard-filters + - /configuration-enforcement + - /configuration-statuses - /troubleshoot-security-configurations --- + diff --git a/content/code-security/reference/security-at-scale/available-filters-for-security-overview.md b/content/code-security/reference/security-at-scale/overview-dashboard-filters.md similarity index 99% rename from content/code-security/reference/security-at-scale/available-filters-for-security-overview.md rename to content/code-security/reference/security-at-scale/overview-dashboard-filters.md index 6d7504b08259..a47e614b8121 100644 --- a/content/code-security/reference/security-at-scale/available-filters-for-security-overview.md +++ b/content/code-security/reference/security-at-scale/overview-dashboard-filters.md @@ -1,6 +1,6 @@ --- title: Available filters for security overview -shortTitle: Security overview filters +shortTitle: Overview dashboard filters intro: Reference for all available filters you can use to narrow security overview data. permissions: '{% data reusables.permissions.security-overview %}' product: '{% data reusables.gated-features.security-overview-fpt-both %}' @@ -13,6 +13,7 @@ contentType: reference redirect_from: - /code-security/reference/security-alert-management/available-filters-for-security-overview - /code-security/reference/security-alert-management + - /code-security/reference/security-at-scale/available-filters-for-security-overview category: - Secure at scale --- diff --git a/content/code-security/reference/security-at-scale/security-overview-dashboard-metrics.md b/content/code-security/reference/security-at-scale/overview-dashboard-metrics.md similarity index 96% rename from content/code-security/reference/security-at-scale/security-overview-dashboard-metrics.md rename to content/code-security/reference/security-at-scale/overview-dashboard-metrics.md index f54b4e668caf..17ed4d2ff7a2 100644 --- a/content/code-security/reference/security-at-scale/security-overview-dashboard-metrics.md +++ b/content/code-security/reference/security-at-scale/overview-dashboard-metrics.md @@ -1,5 +1,6 @@ --- title: Security overview dashboard metrics +shortTitle: Overview dashboard metrics intro: Detailed explanations of metrics, calculations, and data visualizations on the overview page of your security overview. versions: fpt: '*' @@ -8,6 +9,9 @@ versions: contentType: reference category: - Secure at scale +redirect_from: + - /code-security/reference/security-at-scale/security-overview-dashboard-metrics + - /code-security/reference/security-at-scale/dashboard-metrics --- ## Dashboard metrics diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md index 27d13fce320a..00b422fd303e 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md @@ -1,6 +1,6 @@ --- title: A repository is using advanced setup for code scanning -shortTitle: Active advanced setup +shortTitle: A repository is using 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: @@ -11,6 +11,7 @@ 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 - /code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning + - /code-security/reference/security-at-scale/troubleshoot-security-configurations/active-advanced-setup contentType: reference category: - Troubleshoot security tools diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/diagnosing-security-configuration-issues.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/configuration-issue-diagnosis.md similarity index 95% rename from content/code-security/reference/security-at-scale/troubleshoot-security-configurations/diagnosing-security-configuration-issues.md rename to content/code-security/reference/security-at-scale/troubleshoot-security-configurations/configuration-issue-diagnosis.md index 7dfb7aeca0cc..f363b9d02d44 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/diagnosing-security-configuration-issues.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/configuration-issue-diagnosis.md @@ -1,6 +1,6 @@ --- title: Diagnosing security configuration issues -shortTitle: Diagnose configuration issues +shortTitle: Configuration issue diagnosis intro: Identify repositories where the security configuration could not be attached, or where the configuration relationship has changed, and follow guidance to remediate the problem. permissions: '{% data reusables.permissions.security-org-enable %}' versions: @@ -11,6 +11,7 @@ redirect_from: - /code-security/securing-your-organization/managing-the-security-of-your-organization/finding-repositories-with-attachment-failures - /code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures - /code-security/reference/security-at-scale/troubleshoot-security-configurations/finding-repositories-with-attachment-failures + - /code-security/reference/security-at-scale/troubleshoot-security-configurations/diagnosing-security-configuration-issues contentType: reference category: - Troubleshoot security tools diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/index.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/index.md index 0a52d2d26841..3d74fdeb93a4 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/index.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/index.md @@ -10,8 +10,8 @@ children: - /a-repository-is-using-advanced-setup-for-code-scanning - /feature-disappears - /unexpected-default-setup - - /diagnosing-security-configuration-issues - - /not-enough-github-advanced-security-licenses + - /configuration-issue-diagnosis + - /not-enough-ghas-licenses redirect_from: - /code-security/securing-your-organization/troubleshooting-security-configurations - /code-security/how-tos/secure-at-scale/troubleshoot-security-configurations diff --git a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-ghas-licenses.md similarity index 94% rename from content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md rename to content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-ghas-licenses.md index c14a5cebbbf5..9cb47b794d51 100644 --- a/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses.md +++ b/content/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-ghas-licenses.md @@ -10,6 +10,7 @@ versions: redirect_from: - /code-security/securing-your-organization/troubleshooting-security-configurations/not-enough-github-advanced-security-licenses - /code-security/how-tos/secure-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses + - /code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-github-advanced-security-licenses contentType: reference category: - Troubleshoot security tools diff --git a/content/code-security/reference/supply-chain-security/automatic-dependency-submission.md b/content/code-security/reference/supply-chain-security/automatic-dependency-submission.md index 8977c0e8aa34..1db2ed291bd6 100644 --- a/content/code-security/reference/supply-chain-security/automatic-dependency-submission.md +++ b/content/code-security/reference/supply-chain-security/automatic-dependency-submission.md @@ -1,5 +1,6 @@ --- title: Automatic dependency submission +shortTitle: Automatic dependency submission intro: Network access requirements, troubleshooting, and ecosystem-specific behavior for automatic dependency submission. versions: feature: maven-transitive-dependencies diff --git a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-errors.md b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-errors.md index b51ea24a6456..7525155bcd26 100644 --- a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-errors.md +++ b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-errors.md @@ -1,7 +1,7 @@ --- title: Dependabot errors intro: '{% data variables.product.prodname_dependabot %} automatically maintains your dependencies, keeping your code secure and current. This reference helps you diagnose and resolve issues so automated updates can continue.' -shortTitle: Troubleshoot Dependabot errors +shortTitle: Dependabot errors redirect_from: - /github/managing-security-vulnerabilities/troubleshooting-github-dependabot-errors - /github/managing-security-vulnerabilities/troubleshooting-dependabot-errors diff --git a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/troubleshooting-dependabot-on-github-actions.md b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-on-actions.md similarity index 95% rename from content/code-security/reference/supply-chain-security/troubleshoot-dependabot/troubleshooting-dependabot-on-github-actions.md rename to content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-on-actions.md index 43c282413d3d..84eb9ec771e3 100644 --- a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/troubleshooting-dependabot-on-github-actions.md +++ b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-on-actions.md @@ -5,11 +5,13 @@ versions: fpt: '*' ghec: '*' ghes: '*' -shortTitle: Troubleshoot Dependabot on Actions +shortTitle: 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 - /code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-dependabot-on-github-actions + - /code-security/reference/supply-chain-security/troubleshoot-dependabot/troubleshooting-dependabot-on-github-actions + - /code-security/reference/supply-chain-security/troubleshoot-dependabot/dependabot-on-actions-issues contentType: reference category: - Troubleshoot security tools diff --git a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/troubleshooting-the-dependency-graph.md b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependency-graph-errors.md similarity index 98% rename from content/code-security/reference/supply-chain-security/troubleshoot-dependabot/troubleshooting-the-dependency-graph.md rename to content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependency-graph-errors.md index 52bb7528aff3..484000fa4e3c 100644 --- a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/troubleshooting-the-dependency-graph.md +++ b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/dependency-graph-errors.md @@ -2,7 +2,7 @@ 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. product: '{% data reusables.gated-features.dependency-graph %}' -shortTitle: Troubleshoot dependency graph +shortTitle: Dependency graph errors versions: fpt: '*' ghes: '*' @@ -10,6 +10,7 @@ versions: redirect_from: - /code-security/supply-chain-security/understanding-your-software-supply-chain/troubleshooting-the-dependency-graph - /code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-dependency-graph + - /code-security/reference/supply-chain-security/troubleshoot-dependabot/troubleshooting-the-dependency-graph contentType: reference category: - Troubleshoot security tools diff --git a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/index.md b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/index.md index 095be6d5994b..2410956a2a96 100644 --- a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/index.md +++ b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/index.md @@ -7,11 +7,12 @@ versions: ghec: '*' contentType: reference children: - - /troubleshooting-the-dependency-graph + - /dependency-graph-errors - /dependabot-updates-stopped - - /troubleshooting-dependabot-on-github-actions - - /vulnerable-dependency-detection + - /dependabot-on-actions + - /vulnerability-detection - /dependabot-errors redirect_from: - /code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security --- + diff --git a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerable-dependency-detection.md b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerability-detection.md similarity index 98% rename from content/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerable-dependency-detection.md rename to content/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerability-detection.md index b3d3be07dc20..ac8c39bbcfcd 100644 --- a/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerable-dependency-detection.md +++ b/content/code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerability-detection.md @@ -1,7 +1,7 @@ --- title: Vulnerable dependency detection 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 +shortTitle: 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 @@ -9,6 +9,7 @@ redirect_from: - /code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies - /code-security/dependabot/troubleshooting-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies - /code-security/how-tos/secure-your-supply-chain/troubleshoot-dependency-security/troubleshooting-the-detection-of-vulnerable-dependencies + - /code-security/reference/supply-chain-security/troubleshoot-dependabot/vulnerable-dependency-detection versions: fpt: '*' ghes: '*' diff --git a/content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md b/content/code-security/tutorials/customize-code-scanning/analyze-code.md similarity index 99% rename from content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md rename to content/code-security/tutorials/customize-code-scanning/analyze-code.md index 9393481d1c1f..13fbb5f7c7c7 100644 --- a/content/code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries.md +++ b/content/code-security/tutorials/customize-code-scanning/analyze-code.md @@ -2,7 +2,7 @@ title: Analyzing your code with CodeQL queries 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 +shortTitle: Analyze code versions: fpt: '*' ghes: '*' @@ -11,6 +11,7 @@ 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 + - /code-security/tutorials/customize-code-scanning/analyzing-your-code-with-codeql-queries contentType: tutorials category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md b/content/code-security/tutorials/customize-code-scanning/create-and-work-with-codeql-packs.md similarity index 97% rename from content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md rename to content/code-security/tutorials/customize-code-scanning/create-and-work-with-codeql-packs.md index 69493eee5545..5ce4035d7111 100644 --- a/content/code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs.md +++ b/content/code-security/tutorials/customize-code-scanning/create-and-work-with-codeql-packs.md @@ -1,5 +1,6 @@ --- title: Creating and working with CodeQL packs +shortTitle: Create and work 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. product: '{% data reusables.gated-features.codeql %}' versions: @@ -10,6 +11,8 @@ 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 + - /code-security/tutorials/customize-code-scanning/creating-and-working-with-codeql-packs + - /code-security/tutorials/customize-code-scanning/create-codeql-packs contentType: tutorials category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md b/content/code-security/tutorials/customize-code-scanning/create-query-suites.md similarity index 99% rename from content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md rename to content/code-security/tutorials/customize-code-scanning/create-query-suites.md index 76da3d2cbb33..c280b9558990 100644 --- a/content/code-security/tutorials/customize-code-scanning/creating-codeql-query-suites.md +++ b/content/code-security/tutorials/customize-code-scanning/create-query-suites.md @@ -1,5 +1,6 @@ --- title: Creating CodeQL query suites +shortTitle: Create query suites 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: @@ -10,6 +11,7 @@ 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 + - /code-security/tutorials/customize-code-scanning/creating-codeql-query-suites contentType: tutorials category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md b/content/code-security/tutorials/customize-code-scanning/customize-analysis.md similarity index 98% rename from content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md rename to content/code-security/tutorials/customize-code-scanning/customize-analysis.md index 86dec2d9d851..0e0717391bfd 100644 --- a/content/code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs.md +++ b/content/code-security/tutorials/customize-code-scanning/customize-analysis.md @@ -1,7 +1,7 @@ --- 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. -shortTitle: Customizing analysis +shortTitle: Customize analysis product: '{% data reusables.gated-features.codeql %}' versions: fpt: '*' @@ -11,6 +11,7 @@ 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 + - /code-security/tutorials/customize-code-scanning/customizing-analysis-with-codeql-packs contentType: tutorials category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/tutorials/customize-code-scanning/evaluating-default-setup-for-code-scanning.md b/content/code-security/tutorials/customize-code-scanning/evaluate-default-setup.md similarity index 97% rename from content/code-security/tutorials/customize-code-scanning/evaluating-default-setup-for-code-scanning.md rename to content/code-security/tutorials/customize-code-scanning/evaluate-default-setup.md index aa007c75bb71..ac3d88e6d049 100644 --- a/content/code-security/tutorials/customize-code-scanning/evaluating-default-setup-for-code-scanning.md +++ b/content/code-security/tutorials/customize-code-scanning/evaluate-default-setup.md @@ -9,6 +9,7 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/enabling-code-scanning/evaluating-default-setup-for-code-scanning + - /code-security/tutorials/customize-code-scanning/evaluating-default-setup-for-code-scanning contentType: tutorials category: - Find and fix code vulnerabilities diff --git a/content/code-security/tutorials/customize-code-scanning/index.md b/content/code-security/tutorials/customize-code-scanning/index.md index f6f513bee040..343f4be518e6 100644 --- a/content/code-security/tutorials/customize-code-scanning/index.md +++ b/content/code-security/tutorials/customize-code-scanning/index.md @@ -9,13 +9,13 @@ contentType: tutorials redirect_from: - /code-security/how-tos/scan-code-for-vulnerabilities/customize-code-scanning children: - - /evaluating-default-setup-for-code-scanning - - /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 - - /creating-and-working-with-codeql-packs + - /evaluate-default-setup + - /prepare-code-for-analysis + - /analyze-code + - /upload-results + - /run-in-a-container + - /customize-analysis + - /create-query-suites + - /create-and-work-with-codeql-packs --- diff --git a/content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md b/content/code-security/tutorials/customize-code-scanning/prepare-code-for-analysis.md similarity index 99% rename from content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md rename to content/code-security/tutorials/customize-code-scanning/prepare-code-for-analysis.md index 17662a2f6003..daa397261e49 100644 --- a/content/code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis.md +++ b/content/code-security/tutorials/customize-code-scanning/prepare-code-for-analysis.md @@ -1,7 +1,7 @@ --- 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. -shortTitle: Preparing code for analysis +shortTitle: Prepare code for analysis permissions: '{% data reusables.permissions.repo-checkout %}' product: '{% data reusables.gated-features.codeql %}' versions: @@ -16,6 +16,7 @@ redirect_from: - /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 + - /code-security/tutorials/customize-code-scanning/preparing-your-code-for-codeql-analysis contentType: tutorials category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md b/content/code-security/tutorials/customize-code-scanning/run-in-a-container.md similarity index 95% rename from content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md rename to content/code-security/tutorials/customize-code-scanning/run-in-a-container.md index c2e71c649ec8..25c657f35d95 100644 --- a/content/code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container.md +++ b/content/code-security/tutorials/customize-code-scanning/run-in-a-container.md @@ -1,6 +1,6 @@ --- title: Running CodeQL code scanning in a container -shortTitle: '{% data variables.product.prodname_code_scanning_caps %} in a container' +shortTitle: Run 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. product: '{% data reusables.gated-features.code-scanning %}' redirect_from: @@ -10,6 +10,8 @@ redirect_from: - /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 + - /code-security/tutorials/customize-code-scanning/running-codeql-code-scanning-in-a-container + - /code-security/tutorials/customize-code-scanning/run-code-scanning-in-a-container versions: fpt: '*' ghes: '*' diff --git a/content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md b/content/code-security/tutorials/customize-code-scanning/upload-results.md similarity index 98% rename from content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md rename to content/code-security/tutorials/customize-code-scanning/upload-results.md index 515617dd16fe..6c9bf5d1eae6 100644 --- a/content/code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github.md +++ b/content/code-security/tutorials/customize-code-scanning/upload-results.md @@ -1,6 +1,6 @@ --- title: Uploading CodeQL analysis results to GitHub -shortTitle: Uploading results to GitHub +shortTitle: Upload results 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 %}' @@ -10,6 +10,7 @@ versions: ghec: '*' redirect_from: - /code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github + - /code-security/tutorials/customize-code-scanning/uploading-codeql-analysis-results-to-github contentType: tutorials category: - Customize vulnerability detection with CodeQL diff --git a/content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md index 13c1c63965d8..7578094a894f 100644 --- a/content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-accounts.md @@ -1,6 +1,6 @@ --- title: Best practices for securing accounts -shortTitle: Securing accounts +shortTitle: Secure accounts allowTitleToDifferFromFilename: true intro: Guidance on how to protect accounts with access to your software supply chain. versions: diff --git a/content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md index d38e4dc64f4d..52f622f00ca7 100644 --- a/content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-builds.md @@ -1,6 +1,6 @@ --- title: Best practices for securing your build system -shortTitle: Securing builds +shortTitle: Secure builds allowTitleToDifferFromFilename: true intro: Guidance on how to protect the end of your supply chain—the systems you use to build and distribute artifacts. versions: diff --git a/content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md index c4c73663f121..5ad781114172 100644 --- a/content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md +++ b/content/code-security/tutorials/implement-supply-chain-best-practices/securing-code.md @@ -1,6 +1,6 @@ --- title: Best practices for securing code in your supply chain -shortTitle: Securing code +shortTitle: Secure code allowTitleToDifferFromFilename: true intro: Guidance on how to protect the center of your supply chain—the code you write and the code you depend on. versions: diff --git a/content/code-security/tutorials/index.md b/content/code-security/tutorials/index.md index 0285d5ebedfb..316e84466a65 100644 --- a/content/code-security/tutorials/index.md +++ b/content/code-security/tutorials/index.md @@ -21,3 +21,4 @@ children: - /improve-code-quality - /fix-reported-vulnerabilities --- + diff --git a/content/code-security/tutorials/remediate-leaked-secrets/calculating-the-cost-savings-of-push-protection.md b/content/code-security/tutorials/remediate-leaked-secrets/calculate-cost-savings.md similarity index 98% rename from content/code-security/tutorials/remediate-leaked-secrets/calculating-the-cost-savings-of-push-protection.md rename to content/code-security/tutorials/remediate-leaked-secrets/calculate-cost-savings.md index 17b18a958ada..3d0e5549ffdd 100644 --- a/content/code-security/tutorials/remediate-leaked-secrets/calculating-the-cost-savings-of-push-protection.md +++ b/content/code-security/tutorials/remediate-leaked-secrets/calculate-cost-savings.md @@ -10,6 +10,7 @@ contentType: tutorials redirect_from: - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/calculating-the-cost-savings-of-push-protection - /code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/calculating-the-cost-savings-of-push-protection + - /code-security/tutorials/remediate-leaked-secrets/calculating-the-cost-savings-of-push-protection category: - Protect your secrets --- diff --git a/content/code-security/tutorials/remediate-leaked-secrets/index.md b/content/code-security/tutorials/remediate-leaked-secrets/index.md index 0e0fd177015c..9ace9760e786 100644 --- a/content/code-security/tutorials/remediate-leaked-secrets/index.md +++ b/content/code-security/tutorials/remediate-leaked-secrets/index.md @@ -7,8 +7,9 @@ versions: ghec: '*' contentType: tutorials children: - - /calculating-the-cost-savings-of-push-protection + - /calculate-cost-savings - /assessing-ghsp-impact - /evaluating-alerts - /remediating-a-leaked-secret --- + diff --git a/content/code-security/tutorials/secret-protection-adoption-path.md b/content/code-security/tutorials/secret-protection-adoption-path.md index b3a671cdb4d6..66e724766837 100644 --- a/content/code-security/tutorials/secret-protection-adoption-path.md +++ b/content/code-security/tutorials/secret-protection-adoption-path.md @@ -19,25 +19,25 @@ journeyTracks: guides: - href: '/code-security/concepts/secret-security/secret-leakage-risks' - href: '/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/assess-your-secret-risk' - - href: '/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results' + - href: '/code-security/tutorials/secure-your-organization/interpret-secret-risk-assessment' - href: '/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/viewing-your-security-risk-assessment-reports' - id: 'evaluate' title: 'Phase 2: Evaluate GitHub Secret Protection' description: 'Determine if GHSP meets your needs and build a business case. Review detection capabilities, push protection features, and validity checking. Use the pricing calculator to estimate costs and calculate potential cost savings from preventing manual remediation.' timeCommitment: '2-4 hours' guides: - - href: '/code-security/concepts/secret-security/about-secret-scanning' - - href: '/code-security/concepts/secret-security/about-push-protection' + - href: '/code-security/concepts/secret-security/secret-scanning' + - href: '/code-security/concepts/secret-security/push-protection' - href: '/code-security/reference/secret-security/supported-secret-scanning-patterns' - href: '/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/estimating-the-price-of-secret-protection' - - href: '/code-security/tutorials/remediate-leaked-secrets/calculating-the-cost-savings-of-push-protection' + - href: '/code-security/tutorials/remediate-leaked-secrets/calculate-cost-savings' - href: '/code-security/tutorials/trialing-github-advanced-security/trial-advanced-security' - id: 'pilot' title: 'Phase 3: Pilot GitHub Secret Protection' description: 'Run a pilot to validate GHSP with a small set of repositories before organization-wide enablement. Select 5-10 repositories with active development and known secret exposure. If you estimated pricing in Phase 2, you''ll confirm costs as part of the enablement flow. A successful pilot demonstrates security value quickly, identifies workflow adjustments, and gathers feedback to refine your rollout strategy.' timeCommitment: '2-4 weeks' guides: - - href: '/code-security/concepts/security-at-scale/best-practices-for-selecting-pilot-repositories' + - href: '/code-security/concepts/security-at-scale/select-pilot-repositories' - href: '/code-security/how-tos/secure-at-scale/configure-organization-security/configure-specific-tools/protect-your-secrets' - href: '/code-security/how-tos/secure-your-secrets/prevent-future-leaks/enabling-push-protection-for-your-repository' - href: '/code-security/tutorials/remediate-leaked-secrets/remediating-a-leaked-secret' @@ -48,7 +48,7 @@ journeyTracks: guides: - href: '/code-security/tutorials/remediate-leaked-secrets/assessing-ghsp-impact' - href: '/code-security/concepts/secret-security/push-protection-metrics' - - href: '/code-security/tutorials/secure-your-organization/organizing-remediation-efforts-for-leaked-secrets' + - href: '/code-security/tutorials/secure-your-organization/organize-leak-remediation' - href: '/code-security/tutorials/remediate-leaked-secrets/evaluating-alerts' - id: 'scale' title: 'Phase 5: Scale, customize, and automate' diff --git a/content/code-security/tutorials/secure-your-dependencies/automating-dependabot-with-github-actions.md b/content/code-security/tutorials/secure-your-dependencies/automate-dependabot-with-actions.md similarity index 98% rename from content/code-security/tutorials/secure-your-dependencies/automating-dependabot-with-github-actions.md rename to content/code-security/tutorials/secure-your-dependencies/automate-dependabot-with-actions.md index 399450ed3011..a11d1e3ece1c 100644 --- a/content/code-security/tutorials/secure-your-dependencies/automating-dependabot-with-github-actions.md +++ b/content/code-security/tutorials/secure-your-dependencies/automate-dependabot-with-actions.md @@ -7,10 +7,12 @@ versions: ghec: '*' ghes: '*' contentType: tutorials -shortTitle: Use Dependabot with Actions +shortTitle: Automate 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 + - /code-security/tutorials/secure-your-dependencies/automating-dependabot-with-github-actions + - /code-security/tutorials/secure-your-dependencies/use-dependabot-with-actions category: - Secure your dependencies --- diff --git a/content/code-security/tutorials/secure-your-dependencies/customizing-your-dependency-review-action-configuration.md b/content/code-security/tutorials/secure-your-dependencies/customize-dependency-review-action.md similarity index 98% rename from content/code-security/tutorials/secure-your-dependencies/customizing-your-dependency-review-action-configuration.md rename to content/code-security/tutorials/secure-your-dependencies/customize-dependency-review-action.md index 4f51326c71e6..049abe9ebf17 100644 --- a/content/code-security/tutorials/secure-your-dependencies/customizing-your-dependency-review-action-configuration.md +++ b/content/code-security/tutorials/secure-your-dependencies/customize-dependency-review-action.md @@ -10,6 +10,7 @@ versions: contentType: tutorials redirect_from: - /code-security/supply-chain-security/understanding-your-software-supply-chain/customizing-your-dependency-review-action-configuration + - /code-security/tutorials/secure-your-dependencies/customizing-your-dependency-review-action-configuration category: - Secure your dependencies --- diff --git a/content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide.md b/content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart.md similarity index 99% rename from content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide.md rename to content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart.md index a4c5f34e62c3..71f295a1364c 100644 --- a/content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide.md +++ b/content/code-security/tutorials/secure-your-dependencies/dependabot-quickstart.md @@ -10,6 +10,7 @@ contentType: tutorials shortTitle: Dependabot quickstart redirect_from: - /code-security/getting-started/dependabot-quickstart-guide + - /code-security/tutorials/secure-your-dependencies/dependabot-quickstart-guide category: - Secure your dependencies --- diff --git a/content/code-security/tutorials/secure-your-dependencies/index.md b/content/code-security/tutorials/secure-your-dependencies/index.md index 6de1520562b6..cb1e972b5fc8 100644 --- a/content/code-security/tutorials/secure-your-dependencies/index.md +++ b/content/code-security/tutorials/secure-your-dependencies/index.md @@ -8,11 +8,11 @@ versions: ghec: '*' contentType: tutorials children: - - /dependabot-quickstart-guide - - /automating-dependabot-with-github-actions + - /dependabot-quickstart + - /automate-dependabot-with-actions - /optimizing-pr-creation-version-updates - /setting-dependabot-to-run-on-self-hosted-runners-using-arc - /customizing-dependabot-prs - - /customizing-your-dependency-review-action-configuration + - /customize-dependency-review-action --- diff --git a/content/code-security/tutorials/secure-your-organization/index.md b/content/code-security/tutorials/secure-your-organization/index.md index 6d15e6fe39f1..d018e867803a 100644 --- a/content/code-security/tutorials/secure-your-organization/index.md +++ b/content/code-security/tutorials/secure-your-organization/index.md @@ -10,13 +10,14 @@ contentType: tutorials redirect_from: - /code-security/getting-started/quickstart-for-securing-your-organization children: - - /best-practices-for-preventing-data-leaks-in-your-organization + - /prevent-data-leaks - /best-practice-fix-alerts-at-scale - /prioritize-alerts-in-production-code - - /interpreting-secret-risk-assessment-results - - /interpreting-code-security-risk-assessment-results - - /organizing-remediation-efforts-for-leaked-secrets + - /interpret-secret-risk-assessment + - /interpret-code-security-risk-assessment + - /organize-leak-remediation - /protect-against-threats - - /preparing-for-security-incidents - - /responding-to-security-incidents + - /prepare-for-a-security-incident + - /respond-to-a-security-incident --- + diff --git a/content/code-security/tutorials/secure-your-organization/interpreting-code-security-risk-assessment-results.md b/content/code-security/tutorials/secure-your-organization/interpret-code-security-risk-assessment.md similarity index 97% rename from content/code-security/tutorials/secure-your-organization/interpreting-code-security-risk-assessment-results.md rename to content/code-security/tutorials/secure-your-organization/interpret-code-security-risk-assessment.md index 2f2e4280ca8c..6c1426d2a0ee 100644 --- a/content/code-security/tutorials/secure-your-organization/interpreting-code-security-risk-assessment-results.md +++ b/content/code-security/tutorials/secure-your-organization/interpret-code-security-risk-assessment.md @@ -8,6 +8,8 @@ versions: contentType: tutorials category: - Secure at scale +redirect_from: + - /code-security/tutorials/secure-your-organization/interpreting-code-security-risk-assessment-results --- ## Introduction @@ -87,4 +89,4 @@ Also look for the following indicators, which may require broader intervention b To start remediating vulnerabilities with {% data variables.copilot.copilot_autofix_short %}, enable {% data variables.product.prodname_GH_code_security_always %} for your organization. You have two options: * To enable {% data variables.product.prodname_GH_code_security_always %} for an individual repository, click **Enable** next to a repository in the "Repositories scanned" table. -* To enable {% data variables.product.prodname_GH_code_security_always %} across your organization, click **Enable {% data variables.product.UI_code_security_scanning %}** at the top of the page. Here, you can choose whether to enable it for all repositories or selected repositories, then review the estimated cost before confirming. \ No newline at end of file +* To enable {% data variables.product.prodname_GH_code_security_always %} across your organization, click **Enable {% data variables.product.UI_code_security_scanning %}** at the top of the page. Here, you can choose whether to enable it for all repositories or selected repositories, then review the estimated cost before confirming. diff --git a/content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md b/content/code-security/tutorials/secure-your-organization/interpret-secret-risk-assessment.md similarity index 97% rename from content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md rename to content/code-security/tutorials/secure-your-organization/interpret-secret-risk-assessment.md index 49069d16d00d..8bbaa694e6ad 100644 --- a/content/code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results.md +++ b/content/code-security/tutorials/secure-your-organization/interpret-secret-risk-assessment.md @@ -9,6 +9,7 @@ versions: contentType: tutorials redirect_from: - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/interpreting-secret-risk-assessment-results + - /code-security/tutorials/secure-your-organization/interpreting-secret-risk-assessment-results category: - Secure at scale --- diff --git a/content/code-security/tutorials/secure-your-organization/organizing-remediation-efforts-for-leaked-secrets.md b/content/code-security/tutorials/secure-your-organization/organize-leak-remediation.md similarity index 98% rename from content/code-security/tutorials/secure-your-organization/organizing-remediation-efforts-for-leaked-secrets.md rename to content/code-security/tutorials/secure-your-organization/organize-leak-remediation.md index 50a70028fa31..4c8efc05d1e5 100644 --- a/content/code-security/tutorials/secure-your-organization/organizing-remediation-efforts-for-leaked-secrets.md +++ b/content/code-security/tutorials/secure-your-organization/organize-leak-remediation.md @@ -9,6 +9,7 @@ versions: contentType: tutorials redirect_from: - /code-security/securing-your-organization/understanding-your-organizations-exposure-to-leaked-secrets/organizing-remediation-efforts-for-leaked-secrets + - /code-security/tutorials/secure-your-organization/organizing-remediation-efforts-for-leaked-secrets category: - Plan your security strategy --- diff --git a/content/code-security/tutorials/secure-your-organization/preparing-for-security-incidents.md b/content/code-security/tutorials/secure-your-organization/prepare-for-a-security-incident.md similarity index 98% rename from content/code-security/tutorials/secure-your-organization/preparing-for-security-incidents.md rename to content/code-security/tutorials/secure-your-organization/prepare-for-a-security-incident.md index b8bc02aaa668..ab4abd92cdc4 100644 --- a/content/code-security/tutorials/secure-your-organization/preparing-for-security-incidents.md +++ b/content/code-security/tutorials/secure-your-organization/prepare-for-a-security-incident.md @@ -1,7 +1,8 @@ --- title: Preparing for a security incident shortTitle: Prepare for a security incident -allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/tutorials/secure-your-organization/preparing-for-security-incidents intro: Ensure you have the tools and processes in place to respond effectively to a security incident. versions: fpt: '*' diff --git a/content/code-security/tutorials/secure-your-organization/best-practices-for-preventing-data-leaks-in-your-organization.md b/content/code-security/tutorials/secure-your-organization/prevent-data-leaks.md similarity index 99% rename from content/code-security/tutorials/secure-your-organization/best-practices-for-preventing-data-leaks-in-your-organization.md rename to content/code-security/tutorials/secure-your-organization/prevent-data-leaks.md index b185138dc6bd..e68316a64926 100644 --- a/content/code-security/tutorials/secure-your-organization/best-practices-for-preventing-data-leaks-in-your-organization.md +++ b/content/code-security/tutorials/secure-your-organization/prevent-data-leaks.md @@ -8,6 +8,7 @@ versions: shortTitle: Prevent data leaks redirect_from: - /code-security/getting-started/best-practices-for-preventing-data-leaks-in-your-organization + - /code-security/tutorials/secure-your-organization/best-practices-for-preventing-data-leaks-in-your-organization contentType: tutorials category: - Plan your security strategy diff --git a/content/code-security/tutorials/secure-your-organization/responding-to-security-incidents.md b/content/code-security/tutorials/secure-your-organization/respond-to-a-security-incident.md similarity index 99% rename from content/code-security/tutorials/secure-your-organization/responding-to-security-incidents.md rename to content/code-security/tutorials/secure-your-organization/respond-to-a-security-incident.md index 524380d13996..03dd9640244f 100644 --- a/content/code-security/tutorials/secure-your-organization/responding-to-security-incidents.md +++ b/content/code-security/tutorials/secure-your-organization/respond-to-a-security-incident.md @@ -1,7 +1,8 @@ --- title: Responding to a security incident shortTitle: Respond to a security incident -allowTitleToDifferFromFilename: true +redirect_from: + - /code-security/tutorials/secure-your-organization/responding-to-security-incidents intro: Respond strategically to a security incident affecting organizations or repositories in your {% data variables.product.github %} enterprise. versions: fpt: '*' diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 54e51d55f9b8..1c66eae4de0f 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "0d4e436c347b444cd71b4eb1bd73948fd51c3402" + "sha": "a92b91c983de83f06eb8f2a5e9d84cd29bb70111" } \ No newline at end of file diff --git a/src/graphql/data/fpt/changelog.json b/src/graphql/data/fpt/changelog.json index d676ac6403fb..5f397e8df6f5 100644 --- a/src/graphql/data/fpt/changelog.json +++ b/src/graphql/data/fpt/changelog.json @@ -1,4 +1,19 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "

Input field AddLabelsToLabelableInput.labelIds changed type from '[ID!]!to[ID!]'

", + "

Field displayTitle was added to object type WorkflowRun

", + "

Field runAttempt was added to object type WorkflowRun

" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2026-06-05" + }, { "schemaChanges": [ { diff --git a/src/graphql/data/fpt/schema-actions.json b/src/graphql/data/fpt/schema-actions.json index e8ee276c2121..2a7e17586ad3 100644 --- a/src/graphql/data/fpt/schema-actions.json +++ b/src/graphql/data/fpt/schema-actions.json @@ -255,6 +255,13 @@ } ] }, + { + "name": "displayTitle", + "description": "

The human-readable title of the workflow run.

", + "type": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + }, { "name": "event", "description": "

The event that triggered the workflow run.

", @@ -328,6 +335,13 @@ "id": "uri", "href": "/graphql/reference/other#scalar-uri" }, + { + "name": "runAttempt", + "description": "

The attempt number of this workflow run.

", + "type": "Int!", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + }, { "name": "runNumber", "description": "

A number that uniquely identifies this workflow run in its parent workflow.

", diff --git a/src/graphql/data/fpt/schema-issues.json b/src/graphql/data/fpt/schema-issues.json index 3966d95a7513..f13d56474316 100644 --- a/src/graphql/data/fpt/schema-issues.json +++ b/src/graphql/data/fpt/schema-issues.json @@ -10249,7 +10249,7 @@ { "name": "labelIds", "description": "

The ids of the labels to add.

", - "type": "[ID!]!", + "type": "[ID!]", "id": "id", "href": "/graphql/reference/other#scalar-id", "isDeprecated": false @@ -11893,7 +11893,7 @@ }, { "name": "issueField", - "description": "

The field value to update.

", + "description": "

The field value to update. May include an optional rationale or be flagged\nwith suggest: true to be stored as a pending suggestion instead of being\napplied directly.

", "type": "IssueFieldCreateOrUpdateInput!", "id": "issuefieldcreateorupdateinput", "href": "/graphql/reference/issues#input-object-issuefieldcreateorupdateinput" diff --git a/src/graphql/data/fpt/schema.docs.graphql b/src/graphql/data/fpt/schema.docs.graphql index f53a0353e7f4..3d45b8d28f91 100644 --- a/src/graphql/data/fpt/schema.docs.graphql +++ b/src/graphql/data/fpt/schema.docs.graphql @@ -652,7 +652,7 @@ input AddLabelsToLabelableInput { """ The ids of the labels to add. """ - labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"]) + labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"]) """ The id of the labelable object to add labels to. @@ -58970,7 +58970,7 @@ input SetIssueFieldValueInput { clientMutationId: String """ - The issue fields to set on the issue + The issue fields to set on the issue. """ issueFields: [IssueFieldCreateOrUpdateInput!]! @@ -67922,7 +67922,9 @@ input UpdateIssueFieldValueInput { clientMutationId: String """ - The field value to update. + The field value to update. May include an optional `rationale` or be flagged + with `suggest: true` to be stored as a pending suggestion instead of being + applied directly. """ issueField: IssueFieldCreateOrUpdateInput! @@ -72377,6 +72379,11 @@ type WorkflowRun implements Node & UniformResourceLocatable @docsCategory(name: last: Int ): DeploymentReviewConnection! + """ + The human-readable title of the workflow run. + """ + displayTitle: String + """ The event that triggered the workflow run """ @@ -72422,6 +72429,11 @@ type WorkflowRun implements Node & UniformResourceLocatable @docsCategory(name: """ resourcePath: URI! + """ + The attempt number of this workflow run. + """ + runAttempt: Int! + """ A number that uniquely identifies this workflow run in its parent workflow. """ diff --git a/src/graphql/data/ghec/schema-actions.json b/src/graphql/data/ghec/schema-actions.json index e8ee276c2121..2a7e17586ad3 100644 --- a/src/graphql/data/ghec/schema-actions.json +++ b/src/graphql/data/ghec/schema-actions.json @@ -255,6 +255,13 @@ } ] }, + { + "name": "displayTitle", + "description": "

The human-readable title of the workflow run.

", + "type": "String", + "id": "string", + "href": "/graphql/reference/other#scalar-string" + }, { "name": "event", "description": "

The event that triggered the workflow run.

", @@ -328,6 +335,13 @@ "id": "uri", "href": "/graphql/reference/other#scalar-uri" }, + { + "name": "runAttempt", + "description": "

The attempt number of this workflow run.

", + "type": "Int!", + "id": "int", + "href": "/graphql/reference/other#scalar-int" + }, { "name": "runNumber", "description": "

A number that uniquely identifies this workflow run in its parent workflow.

", diff --git a/src/graphql/data/ghec/schema-issues.json b/src/graphql/data/ghec/schema-issues.json index 3966d95a7513..f13d56474316 100644 --- a/src/graphql/data/ghec/schema-issues.json +++ b/src/graphql/data/ghec/schema-issues.json @@ -10249,7 +10249,7 @@ { "name": "labelIds", "description": "

The ids of the labels to add.

", - "type": "[ID!]!", + "type": "[ID!]", "id": "id", "href": "/graphql/reference/other#scalar-id", "isDeprecated": false @@ -11893,7 +11893,7 @@ }, { "name": "issueField", - "description": "

The field value to update.

", + "description": "

The field value to update. May include an optional rationale or be flagged\nwith suggest: true to be stored as a pending suggestion instead of being\napplied directly.

", "type": "IssueFieldCreateOrUpdateInput!", "id": "issuefieldcreateorupdateinput", "href": "/graphql/reference/issues#input-object-issuefieldcreateorupdateinput" diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index f53a0353e7f4..3d45b8d28f91 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -652,7 +652,7 @@ input AddLabelsToLabelableInput { """ The ids of the labels to add. """ - labelIds: [ID!]! @possibleTypes(concreteTypes: ["Label"]) + labelIds: [ID!] @possibleTypes(concreteTypes: ["Label"]) """ The id of the labelable object to add labels to. @@ -58970,7 +58970,7 @@ input SetIssueFieldValueInput { clientMutationId: String """ - The issue fields to set on the issue + The issue fields to set on the issue. """ issueFields: [IssueFieldCreateOrUpdateInput!]! @@ -67922,7 +67922,9 @@ input UpdateIssueFieldValueInput { clientMutationId: String """ - The field value to update. + The field value to update. May include an optional `rationale` or be flagged + with `suggest: true` to be stored as a pending suggestion instead of being + applied directly. """ issueField: IssueFieldCreateOrUpdateInput! @@ -72377,6 +72379,11 @@ type WorkflowRun implements Node & UniformResourceLocatable @docsCategory(name: last: Int ): DeploymentReviewConnection! + """ + The human-readable title of the workflow run. + """ + displayTitle: String + """ The event that triggered the workflow run """ @@ -72422,6 +72429,11 @@ type WorkflowRun implements Node & UniformResourceLocatable @docsCategory(name: """ resourcePath: URI! + """ + The attempt number of this workflow run. + """ + runAttempt: Int! + """ A number that uniquely identifies this workflow run in its parent workflow. """ diff --git a/src/rest/data/fpt-2022-11-28/billing.json b/src/rest/data/fpt-2022-11-28/billing.json index 39c07f56e1f6..a6375275a2d3 100644 --- a/src/rest/data/fpt-2022-11-28/billing.json +++ b/src/rest/data/fpt-2022-11-28/billing.json @@ -61,7 +61,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 10 budgets.

", + "descriptionHTML": "

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 10 budgets.

", "codeExamples": [ { "request": { @@ -562,7 +562,7 @@ "description": "

A single product or SKU that will be covered in the budget

" } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Creates a new budget for an organization. The authenticated user must be an\norganization admin or billing manager.

", + "descriptionHTML": "

Creates a new budget for an organization. The authenticated user must be an\norganization admin or billing manager.

", "codeExamples": [ { "request": { @@ -883,7 +883,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets a budget by ID. The authenticated user must be an organization admin or billing manager.

", + "descriptionHTML": "

Gets a budget by ID. The authenticated user must be an organization admin or billing manager.

", "codeExamples": [ { "request": { @@ -1123,7 +1123,7 @@ "description": "

A single product or SKU that will be covered in the budget

" } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.

", + "descriptionHTML": "

Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.

", "codeExamples": [ { "request": { @@ -1323,7 +1323,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.

", + "descriptionHTML": "

Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2026-03-10/billing.json b/src/rest/data/fpt-2026-03-10/billing.json index 39c07f56e1f6..a6375275a2d3 100644 --- a/src/rest/data/fpt-2026-03-10/billing.json +++ b/src/rest/data/fpt-2026-03-10/billing.json @@ -61,7 +61,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 10 budgets.

", + "descriptionHTML": "

Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager.\nEach page returns up to 10 budgets.

", "codeExamples": [ { "request": { @@ -562,7 +562,7 @@ "description": "

A single product or SKU that will be covered in the budget

" } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Creates a new budget for an organization. The authenticated user must be an\norganization admin or billing manager.

", + "descriptionHTML": "

Creates a new budget for an organization. The authenticated user must be an\norganization admin or billing manager.

", "codeExamples": [ { "request": { @@ -883,7 +883,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets a budget by ID. The authenticated user must be an organization admin or billing manager.

", + "descriptionHTML": "

Gets a budget by ID. The authenticated user must be an organization admin or billing manager.

", "codeExamples": [ { "request": { @@ -1123,7 +1123,7 @@ "description": "

A single product or SKU that will be covered in the budget

" } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.

", + "descriptionHTML": "

Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager.

", "codeExamples": [ { "request": { @@ -1323,7 +1323,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.

", + "descriptionHTML": "

Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/billing.json b/src/rest/data/ghec-2022-11-28/billing.json index 88bddaad0a02..b11b77bdfb4d 100644 --- a/src/rest/data/ghec-2022-11-28/billing.json +++ b/src/rest/data/ghec-2022-11-28/billing.json @@ -246,7 +246,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager.\nEach page returns up to 10 budgets.

", + "descriptionHTML": "

Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager.\nEach page returns up to 10 budgets.

", "codeExamples": [ { "request": { @@ -748,7 +748,7 @@ "description": "

A single product or SKU that will be covered in the budget

" } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

", + "descriptionHTML": "

Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

", "codeExamples": [ { "request": { @@ -932,7 +932,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.

", + "descriptionHTML": "

Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.

", "codeExamples": [ { "request": { @@ -1168,7 +1168,7 @@ "description": "

A single product or SKU that will be covered in the budget

" } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

", + "descriptionHTML": "

Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

", "codeExamples": [ { "request": { @@ -1367,7 +1367,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Deletes a budget by ID. The authenticated user must be an enterprise admin.

", + "descriptionHTML": "

Deletes a budget by ID. The authenticated user must be an enterprise admin.

", "codeExamples": [ { "request": { @@ -3316,7 +3316,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", + "descriptionHTML": "

Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", "codeExamples": [ { "request": { @@ -3531,7 +3531,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all usage report exports for an enterprise. The authenticated user must be an enterprise admin or billing manager.

", + "descriptionHTML": "

Lists all usage report exports for an enterprise. The authenticated user must be an enterprise admin or billing manager.

", "codeExamples": [ { "request": { @@ -3743,7 +3743,7 @@ "default": false } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Initiates the generation of a usage report export for an enterprise. The report will be processed asynchronously\nand can be downloaded once completed. The authenticated user must be an enterprise admin or billing manager.

", + "descriptionHTML": "

Initiates the generation of a usage report export for an enterprise. The report will be processed asynchronously\nand can be downloaded once completed. The authenticated user must be an enterprise admin or billing manager.

", "codeExamples": [ { "request": { @@ -3910,7 +3910,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the status and details of a usage report export by ID. The authenticated user must be an enterprise admin or billing manager.

", + "descriptionHTML": "

Gets the status and details of a usage report export by ID. The authenticated user must be an enterprise admin or billing manager.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/billing.json b/src/rest/data/ghec-2026-03-10/billing.json index 88bddaad0a02..b11b77bdfb4d 100644 --- a/src/rest/data/ghec-2026-03-10/billing.json +++ b/src/rest/data/ghec-2026-03-10/billing.json @@ -246,7 +246,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager.\nEach page returns up to 10 budgets.

", + "descriptionHTML": "

Gets all budgets for an enterprise. The authenticated user must be an enterprise admin or billing manager.\nEach page returns up to 10 budgets.

", "codeExamples": [ { "request": { @@ -748,7 +748,7 @@ "description": "

A single product or SKU that will be covered in the budget

" } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

", + "descriptionHTML": "

Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

", "codeExamples": [ { "request": { @@ -932,7 +932,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.

", + "descriptionHTML": "

Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.

", "codeExamples": [ { "request": { @@ -1168,7 +1168,7 @@ "description": "

A single product or SKU that will be covered in the budget

" } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

", + "descriptionHTML": "

Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.

", "codeExamples": [ { "request": { @@ -1367,7 +1367,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Deletes a budget by ID. The authenticated user must be an enterprise admin.

", + "descriptionHTML": "

Deletes a budget by ID. The authenticated user must be an enterprise admin.

", "codeExamples": [ { "request": { @@ -3316,7 +3316,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", + "descriptionHTML": "

Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.

\n

Note: Only data from the past 24 months is accessible via this endpoint.

", "codeExamples": [ { "request": { @@ -3531,7 +3531,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all usage report exports for an enterprise. The authenticated user must be an enterprise admin or billing manager.

", + "descriptionHTML": "

Lists all usage report exports for an enterprise. The authenticated user must be an enterprise admin or billing manager.

", "codeExamples": [ { "request": { @@ -3743,7 +3743,7 @@ "default": false } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Initiates the generation of a usage report export for an enterprise. The report will be processed asynchronously\nand can be downloaded once completed. The authenticated user must be an enterprise admin or billing manager.

", + "descriptionHTML": "

Initiates the generation of a usage report export for an enterprise. The report will be processed asynchronously\nand can be downloaded once completed. The authenticated user must be an enterprise admin or billing manager.

", "codeExamples": [ { "request": { @@ -3910,7 +3910,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the status and details of a usage report export by ID. The authenticated user must be an enterprise admin or billing manager.

", + "descriptionHTML": "

Gets the status and details of a usage report export by ID. The authenticated user must be an enterprise admin or billing manager.

", "codeExamples": [ { "request": { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 69e07510774e..72a8b7689dd0 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -50,5 +50,5 @@ ] } }, - "sha": "0d4e436c347b444cd71b4eb1bd73948fd51c3402" + "sha": "a92b91c983de83f06eb8f2a5e9d84cd29bb70111" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 617b5b5ed6e8..8f1dfccf4cc9 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "0d4e436c347b444cd71b4eb1bd73948fd51c3402" + "sha": "a92b91c983de83f06eb8f2a5e9d84cd29bb70111" } \ No newline at end of file diff --git a/src/workflows/find-past-built-pr.ts b/src/workflows/find-past-built-pr.ts index c2dbdebb1108..9906e9a8983a 100644 --- a/src/workflows/find-past-built-pr.ts +++ b/src/workflows/find-past-built-pr.ts @@ -1,39 +1,145 @@ -import { setOutput } from '@actions/core' +import type { Octokit } from '@octokit/rest' import github from './github' import { getActionContext } from './action-context' import { octoSecondaryRatelimitRetry } from './secondary-ratelimit-retry' -async function main() { - const sha = await getBuiltSHA() - console.log({ sha }) +// Marker used to dedupe the "gone to production" comment across reruns and +// across the previous workflow that posted it as github-actions[bot]. +export const GONE_TO_PRODUCTION_MARKER = '' - const actionContext = getActionContext() - const { owner, repo } = actionContext +// The merge queue can batch multiple PRs into a single deploy. We walk back +// from the deployed HEAD commit through `main`'s (linear, squash-merged) +// ancestry to find every PR in the batch. This is bounded by the deployed SHA, +// so it can only ever include already-deployed PRs, never a later batch. +// +// Default to the merge queue's max batch size. Over-reaching into a previous, +// already-notified batch is harmless: those PRs are genuinely in production and +// the marker dedupe skips any that already have the comment. +const BATCH_MAX_COMMITS = parseInt(process.env.DEPLOY_BATCH_MAX_COMMITS || '5', 10) - const octokit = github() - let number = '' +export const COMMENT_BODY = `${GONE_TO_PRODUCTION_MARKER} +🚀 **This pull request has gone into production!** + +This pull request's merge commit is included in the latest production deployment of https://docs.github.com/_build. + +If you don't see updates when expected, try adding a random query string to the URL like \`?bla=1234\` and see if that helps. +If that shows the expected content, it would indicate that the CDN is "overly caching" the page still. It will eventually update, but it can take a while. +` + +// GitHub appends "(#1234)" to the title of a squash-merge commit. Grab the last +// such reference on the title line, which is the merged PR number. +export function extractPrNumber(commitMessage: string): number | null { + const title = commitMessage.split('\n')[0] + const matches = [...title.matchAll(/\(#(\d+)\)/g)] + if (matches.length === 0) { + return null + } + const last = matches[matches.length - 1] + return parseInt(last[1], 10) +} + +// Returns the PR numbers in the deploy batch, newest first, deduplicated. +export async function findBatchPrNumbers( + octokit: Octokit, + owner: string, + repo: string, + sha: string, + maxCommits: number = BATCH_MAX_COMMITS, +): Promise { + const { data: commits } = await octoSecondaryRatelimitRetry(() => + octokit.rest.repos.listCommits({ owner, repo, sha, per_page: maxCommits }), + ) + + const numbers: number[] = [] + for (const commit of commits) { + const number = extractPrNumber(commit.commit.message) + if (number !== null && !numbers.includes(number)) { + numbers.push(number) + } + } + return numbers +} + +export type CommentResult = 'created' | 'exists' | 'locked' + +// Posts the production comment on a single PR, unless it is locked or already +// has the comment (detected by the marker, regardless of which account authored +// it). Idempotent: safe to call on every rerun. +export async function ensureProductionComment( + octokit: Octokit, + owner: string, + repo: string, + prNumber: number, +): Promise { + const { data: issue } = await octoSecondaryRatelimitRetry(() => + octokit.rest.issues.get({ owner, repo, issue_number: prNumber }), + ) + if (issue.locked) { + console.log(`Skipping locked PR #${prNumber}`) + return 'locked' + } - const q = `${sha} repo:"${owner}/${repo}"` - const { data } = await octoSecondaryRatelimitRetry(() => - octokit.rest.search.issuesAndPullRequests({ q }), + const comments = await octoSecondaryRatelimitRetry(() => + octokit.paginate(octokit.rest.issues.listComments, { + owner, + repo, + issue_number: prNumber, + per_page: 100, + }), ) - for (const issue of data.items) { - console.log('ID:', issue.id) - console.log('Number:', issue.number) - console.log('URL:', issue.html_url) - number = String(issue.number) - if (number) { - // We've found the issue (pull request), but before we accept - // this `number`, check that the issue isn't locked. - if (issue.locked) { - number = '' - } - break + if (comments.some((comment) => comment.body?.includes(GONE_TO_PRODUCTION_MARKER))) { + console.log(`PR #${prNumber} already has the production comment; skipping`) + return 'exists' + } + + const { data: created } = await octoSecondaryRatelimitRetry(() => + octokit.rest.issues.createComment({ + owner, + repo, + issue_number: prNumber, + body: COMMENT_BODY, + }), + ) + console.log(`Commented on PR #${prNumber}: ${created.html_url}`) + return 'created' +} + +// Comments on each PR independently so one failure doesn't drop the rest of the +// batch. Collects failures and throws at the end so the workflow's failure +// alerting still fires. +export async function commentOnDeployBatch( + octokit: Octokit, + owner: string, + repo: string, + prNumbers: number[], +): Promise { + const errors: Error[] = [] + for (const prNumber of prNumbers) { + try { + await ensureProductionComment(octokit, owner, repo, prNumber) + } catch (error) { + console.error(`Failed to comment on PR #${prNumber}:`, error) + errors.push(error instanceof Error ? error : new Error(String(error))) } } - setOutput('number', number) + if (errors.length > 0) { + throw new Error(`Failed to comment on ${errors.length} PR(s) in the deploy batch`) + } +} + +async function main() { + const sha = await getBuiltSHA() + console.log({ sha }) + + const { owner, repo } = getActionContext() + const octokit = github() + + const prNumbers = await findBatchPrNumbers(octokit, owner, repo, sha) + console.log(`Found ${prNumbers.length} PR(s) in the deploy batch:`, prNumbers) + + await commentOnDeployBatch(octokit, owner, repo, prNumbers) } async function getBuiltSHA() { @@ -49,4 +155,10 @@ async function getBuiltSHA() { return sha } -main() +const isEntryPoint = + import.meta.url === `file://${process.argv[1]}` || + process.argv[1]?.endsWith('find-past-built-pr.ts') + +if (isEntryPoint) { + main() +} diff --git a/src/workflows/tests/find-past-built-pr.ts b/src/workflows/tests/find-past-built-pr.ts new file mode 100644 index 000000000000..eee60c2312ce --- /dev/null +++ b/src/workflows/tests/find-past-built-pr.ts @@ -0,0 +1,158 @@ +import { describe, expect, test, vi } from 'vitest' +import type { Octokit } from '@octokit/rest' + +import { + extractPrNumber, + findBatchPrNumbers, + ensureProductionComment, + commentOnDeployBatch, + GONE_TO_PRODUCTION_MARKER, +} from '../find-past-built-pr' + +type FakeComment = { body?: string; user?: { login: string } } + +interface FakeOptions { + commitMessages?: string[] + comments?: Record + locked?: Record + failCreateOn?: number[] +} + +// Builds a minimal Octokit stand-in exposing only the methods the script uses. +function makeFakeOctokit(options: FakeOptions = {}) { + const { commitMessages = [], comments = {}, locked = {}, failCreateOn = [] } = options + + const createComment = vi.fn(async ({ issue_number }: { issue_number: number; body?: string }) => { + if (failCreateOn.includes(issue_number)) { + throw new Error(`boom on #${issue_number}`) + } + return { data: { html_url: `https://example.com/pr/${issue_number}#comment` } } + }) + + const listComments = vi.fn() + + const listCommits = vi.fn(async () => ({ + data: commitMessages.map((message) => ({ commit: { message } })), + })) + + const fake = { + rest: { + repos: { listCommits }, + issues: { + get: vi.fn(async ({ issue_number }: { issue_number: number }) => ({ + data: { locked: Boolean(locked[issue_number]) }, + })), + listComments, + createComment, + }, + }, + // The real octokit.paginate pulls every page; our fakes are single-page, so + // resolve straight to the configured comment list. + paginate: vi.fn(async (_method: unknown, params: { issue_number: number }) => { + return comments[params.issue_number] || [] + }), + } + + return { + octokit: fake as unknown as Octokit, + createComment, + listComments, + listCommits, + } +} + +describe('extractPrNumber', () => { + test('reads the PR number appended to a squash-merge title', () => { + expect(extractPrNumber('Fix the thing (#61554)')).toBe(61554) + }) + + test('uses only the title line, ignoring the body', () => { + expect(extractPrNumber('Fix the thing (#100)\n\nFixes #200 and (#300)')).toBe(100) + }) + + test('takes the last reference when the title has several', () => { + expect(extractPrNumber('Revert "Thing (#10)" (#42)')).toBe(42) + }) + + test('returns null when there is no PR reference', () => { + expect(extractPrNumber('Direct push to main')).toBeNull() + }) +}) + +describe('findBatchPrNumbers', () => { + test('returns deduped PR numbers from the deployed SHA ancestry', async () => { + const { octokit } = makeFakeOctokit({ + commitMessages: ['Head PR (#5)', 'Middle PR (#4)', 'First PR (#3)', 'No PR here'], + }) + const numbers = await findBatchPrNumbers(octokit, 'github', 'docs-internal', 'abc123') + expect(numbers).toEqual([5, 4, 3]) + }) + + test('caps the lookback at the configured batch size', async () => { + const { octokit, listCommits } = makeFakeOctokit({ commitMessages: ['Head PR (#9)'] }) + await findBatchPrNumbers(octokit, 'github', 'docs-internal', 'abc123', 5) + expect(listCommits).toHaveBeenCalledWith( + expect.objectContaining({ sha: 'abc123', per_page: 5 }), + ) + }) +}) + +describe('ensureProductionComment', () => { + test('creates the comment when none exists', async () => { + const { octokit, createComment } = makeFakeOctokit({ comments: { 7: [] } }) + const result = await ensureProductionComment(octokit, 'github', 'docs-internal', 7) + expect(result).toBe('created') + expect(createComment).toHaveBeenCalledTimes(1) + expect(createComment.mock.calls[0][0].body).toContain(GONE_TO_PRODUCTION_MARKER) + }) + + test('skips when a marker comment already exists, regardless of author', async () => { + const { octokit, createComment } = makeFakeOctokit({ + comments: { + 7: [{ body: `${GONE_TO_PRODUCTION_MARKER}\nalready here`, user: { login: 'docs-bot' } }], + }, + }) + const result = await ensureProductionComment(octokit, 'github', 'docs-internal', 7) + expect(result).toBe('exists') + expect(createComment).not.toHaveBeenCalled() + }) + + test('respects an existing comment authored by github-actions[bot]', async () => { + const { octokit, createComment } = makeFakeOctokit({ + comments: { + 7: [{ body: `${GONE_TO_PRODUCTION_MARKER}\nold`, user: { login: 'github-actions[bot]' } }], + }, + }) + const result = await ensureProductionComment(octokit, 'github', 'docs-internal', 7) + expect(result).toBe('exists') + expect(createComment).not.toHaveBeenCalled() + }) + + test('skips locked PRs without listing comments', async () => { + const { octokit, createComment, listComments } = makeFakeOctokit({ locked: { 7: true } }) + const result = await ensureProductionComment(octokit, 'github', 'docs-internal', 7) + expect(result).toBe('locked') + expect(listComments).not.toHaveBeenCalled() + expect(createComment).not.toHaveBeenCalled() + }) +}) + +describe('commentOnDeployBatch', () => { + test('comments on every PR in the batch', async () => { + const { octokit, createComment } = makeFakeOctokit({ comments: { 3: [], 4: [], 5: [] } }) + await commentOnDeployBatch(octokit, 'github', 'docs-internal', [5, 4, 3]) + expect(createComment).toHaveBeenCalledTimes(3) + }) + + test('one PR failure does not block the others, but the batch throws', async () => { + const { octokit, createComment } = makeFakeOctokit({ + comments: { 3: [], 4: [], 5: [] }, + failCreateOn: [4], + }) + await expect( + commentOnDeployBatch(octokit, 'github', 'docs-internal', [5, 4, 3]), + ).rejects.toThrow(/Failed to comment on 1 PR/) + // #5 and #3 still get their comments despite #4 failing. + expect(createComment).toHaveBeenCalledTimes(3) + }) +})