update-internal-links dump .yml files correctly (#35553)

This commit is contained in:
Peter Bengtsson 2023-03-15 17:57:01 -04:00 коммит произвёл GitHub
Родитель 3fecfa1be1
Коммит c0bbd4d0b3
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 417 добавлений и 231 удалений

Просмотреть файл

@ -1,58 +1,85 @@
getting_started:
title: 'Get started with {% data variables.product.prodname_actions %}'
description: 'Discover the possibilities of {% data variables.product.prodname_actions %} by creating your first workflow.'
title: Get started with {% data variables.product.prodname_actions %}
description: >-
Discover the possibilities of {% data variables.product.prodname_actions %}
by creating your first workflow.
guides:
- /actions/learn-github-actions/introduction-to-github-actions
- /actions/learn-github-actions/understanding-github-actions
- /actions/learn-github-actions/finding-and-customizing-actions
- /actions/learn-github-actions/essential-features-of-github-actions
- /actions/learn-github-actions/managing-complex-workflows
- /actions/learn-github-actions/reusing-workflows
- /actions/using-workflows/about-workflows
- /actions/using-workflows/reusing-workflows
- /actions/security-guides/security-hardening-for-github-actions
featured_track: true
adopting_github_actions_for_your_enterprise_ghec:
title: 'Adopt GitHub Actions for your enterprise'
description: 'Learn how to plan and implement a rollout of {% data variables.product.prodname_actions %} in your enterprise.'
title: Adopt GitHub Actions for your enterprise
description: >-
Learn how to plan and implement a rollout of {% data
variables.product.prodname_actions %} in your enterprise.
versions:
ghec: '*'
guides:
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
- /actions/learn-github-actions/understanding-github-actions
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud
- /actions/security-guides/security-hardening-for-github-actions
- /billing/managing-billing-for-github-actions/about-billing-for-github-actions
- >-
/billing/managing-billing-for-github-actions/about-billing-for-github-actions
adopting_github_actions_for_your_enterprise_ghes_and_ghae:
title: 'Adopt GitHub Actions for your enterprise'
description: 'Learn how to plan and implement a rollout of {% data variables.product.prodname_actions %} in your enterprise.'
title: Adopt GitHub Actions for your enterprise
description: >-
Learn how to plan and implement a rollout of {% data
variables.product.prodname_actions %} in your enterprise.
versions:
ghes: '*'
ghae: '*'
guides:
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
- /actions/learn-github-actions/understanding-github-actions
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise
- /actions/security-guides/security-hardening-for-github-actions
- /billing/managing-billing-for-github-actions/about-billing-for-github-actions
- >-
/billing/managing-billing-for-github-actions/about-billing-for-github-actions
hosting_your_own_runners:
title: 'Host your own runners'
description: 'You can create self-hosted runners to run workflows in a highly customizable environment.'
title: Host your own runners
description: >-
You can create self-hosted runners to run workflows in a highly customizable
environment.
guides:
- /actions/hosting-your-own-runners/about-self-hosted-runners
- /actions/hosting-your-own-runners/adding-self-hosted-runners
- /actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service
- /actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners
- >-
/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service
- >-
/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners
- /actions/hosting-your-own-runners/using-labels-with-self-hosted-runners
- /actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow
- /actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups
- /actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners
- >-
/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups
- >-
/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners
create_actions:
title: 'Create an action'
description: 'Do you have an idea for a new action? Have you built something custom for your project? Learn how to build shareable actions and publish them to GitHub Marketplace.'
title: Create an action
description: >-
Do you have an idea for a new action? Have you built something custom for
your project? Learn how to build shareable actions and publish them to
GitHub Marketplace.
guides:
- /actions/creating-actions/about-custom-actions
- /actions/creating-actions/creating-a-docker-container-action

Просмотреть файл

@ -1,6 +1,8 @@
get_started_with_github_ae:
title: 'Get started with {% data variables.product.prodname_ghe_managed %}'
description: 'Learn about {% data variables.product.prodname_ghe_managed %} and complete the initial configuration of a new enterprise.'
title: Get started with {% data variables.product.prodname_ghe_managed %}
description: >-
Learn about {% data variables.product.prodname_ghe_managed %} and complete
the initial configuration of a new enterprise.
featured_track: true
versions:
ghae: '*'
@ -8,132 +10,194 @@ get_started_with_github_ae:
- /admin/overview/about-github-ae
- /admin/overview/about-data-residency
- /admin/configuration/configuring-your-enterprise/deploying-github-ae
- /admin/configuration/initializing-github-ae
- /admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list
- /admin/github-actions/getting-started-with-github-actions-for-github-ae
- /admin/configuration/configuring-your-enterprise/initializing-github-ae
- >-
/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-ae
deploy_an_instance:
title: 'Deploy an instance'
description: 'Install {% data variables.product.prodname_ghe_server %} on your platform of choice and configure SAML authentication.'
title: Deploy an instance
description: >-
Install {% data variables.product.prodname_ghe_server %} on your platform of
choice and configure SAML authentication.
featured_track: true
versions:
ghes: '*'
guides:
- /admin/overview/system-overview
- /admin/installation
- /admin/configuration/accessing-the-management-console
- /admin/configuration/configuring-a-hostname
- /admin/authentication/using-saml
- /admin/configuration/site-admin-dashboard
- >-
/admin/configuration/administering-your-instance-from-the-management-console
- /admin/configuration/configuring-network-settings/configuring-a-hostname
- /admin/identity-and-access-management/using-saml-for-enterprise-iam
- /admin/configuration/configuring-your-enterprise/site-admin-dashboard
upgrade_your_instance:
title: 'Upgrade your instance'
description: 'Test upgrades in staging, notify users of maintenance, and upgrade your instance for the latest features and security updates.'
title: Upgrade your instance
description: >-
Test upgrades in staging, notify users of maintenance, and upgrade your
instance for the latest features and security updates.
versions:
ghes: '*'
guides:
- /admin/enterprise-management/enabling-automatic-update-checks
- /admin/installation/setting-up-a-staging-instance
- /admin/enterprise-management/upgrade-requirements
- /admin/user-management/customizing-user-messages-for-your-enterprise
- /admin/configuration/enabling-and-scheduling-maintenance-mode
- /admin/enterprise-management/upgrading-github-enterprise-server
- >-
/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks
- >-
/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance
- >-
/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements
- >-
/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise
- >-
/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode
- >-
/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server
adopting_github_actions_for_your_enterprise_ghec:
title: 'Adopt GitHub Actions for your enterprise'
description: 'Learn how to plan and implement a rollout of {% data variables.product.prodname_actions %} in your enterprise.'
title: Adopt GitHub Actions for your enterprise
description: >-
Learn how to plan and implement a rollout of {% data
variables.product.prodname_actions %} in your enterprise.
versions:
ghec: '*'
guides:
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
- /actions/learn-github-actions/understanding-github-actions
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud
- /actions/security-guides/security-hardening-for-github-actions
- /billing/managing-billing-for-github-actions/about-billing-for-github-actions
- >-
/billing/managing-billing-for-github-actions/about-billing-for-github-actions
adopting_github_actions_for_your_enterprise_ghes_and_ghae:
title: 'Adopt GitHub Actions for your enterprise'
description: 'Learn how to plan and implement a rollout of {% data variables.product.prodname_actions %} in your enterprise.'
title: Adopt GitHub Actions for your enterprise
description: >-
Learn how to plan and implement a rollout of {% data
variables.product.prodname_actions %} in your enterprise.
versions:
ghes: '*'
ghae: '*'
guides:
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises
- /actions/learn-github-actions/understanding-github-actions
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server
- /admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-cloud
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise
- /actions/security-guides/security-hardening-for-github-actions
- /billing/managing-billing-for-github-actions/about-billing-for-github-actions
- >-
/billing/managing-billing-for-github-actions/about-billing-for-github-actions
increase_fault_tolerance:
title: 'Increase the fault tolerance of your instance'
description: "Back up your developers' code and configure high availability (HA) to ensure the reliability of {% data variables.product.prodname_ghe_server %} in your environment."
title: Increase the fault tolerance of your instance
description: >-
Back up your developers' code and configure high availability (HA) to ensure
the reliability of {% data variables.product.prodname_ghe_server %} in your
environment.
versions:
ghes: '*'
guides:
- /admin/configuration/accessing-the-administrative-shell-ssh
- /admin/configuration/configuring-backups-on-your-appliance
- /admin/enterprise-management/about-high-availability-configuration
- /admin/enterprise-management/creating-a-high-availability-replica
- /admin/configuration/using-github-enterprise-server-with-a-load-balancer
- >-
/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh
- >-
/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance
- >-
/admin/enterprise-management/configuring-high-availability/about-high-availability-configuration
- >-
/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica
- >-
/admin/configuration/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer
improve_security_of_your_instance:
title: 'Improve the security of your instance'
description: "Review network configuration and security features, and harden the instance running {% data variables.product.prodname_ghe_server %} to protect your enterprise's data."
title: Improve the security of your instance
description: >-
Review network configuration and security features, and harden the instance
running {% data variables.product.prodname_ghe_server %} to protect your
enterprise's data.
versions:
ghes: '*'
guides:
- /admin/configuration/enabling-private-mode
- /admin/guides/installation/configuring-tls
- /admin/configuration/troubleshooting-ssl-errors
- /admin/configuration/enabling-subdomain-isolation
- /admin/configuration/accessing-the-administrative-shell-ssh
- /admin/configuration/network-ports
- /admin/configuration/configuring-built-in-firewall-rules
- /admin/user-management/best-practices-for-user-security
- /admin/user-management/promoting-or-demoting-a-site-administrator
- /admin/configuration/configuring-your-enterprise/enabling-private-mode
- /admin/configuration/configuring-network-settings/configuring-tls
- >-
/admin/configuration/configuring-your-enterprise/troubleshooting-tls-errors
- >-
/admin/configuration/configuring-network-settings/enabling-subdomain-isolation
- >-
/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh
- /admin/configuration/configuring-network-settings/network-ports
- >-
/admin/configuration/configuring-network-settings/configuring-built-in-firewall-rules
- >-
/admin/user-management/managing-users-in-your-enterprise/best-practices-for-user-security
- >-
/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator
configure_github_actions:
title: 'Configure {% data variables.product.prodname_actions %}'
description: 'Allow your developers to create, automate, customize, and execute powerful software development workflows for {% data variables.location.product_location %} with {% data variables.product.prodname_actions %}.'
title: Configure {% data variables.product.prodname_actions %}
description: >-
Allow your developers to create, automate, customize, and execute powerful
software development workflows for {% data
variables.location.product_location %} with {% data
variables.product.prodname_actions %}.
versions:
ghes: '*'
guides:
- /admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server
- /admin/github-actions/enforcing-github-actions-policies-for-your-enterprise
- /admin/github-actions/enabling-automatic-access-to-githubcom-actions-using-github-connect
- /admin/github-actions/high-availability-for-github-actions
- /admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled
- /admin/github-actions/using-a-staging-environment
- >-
/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server
- >-
/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise
- >-
/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect
- >-
/admin/github-actions/advanced-configuration-and-troubleshooting/high-availability-for-github-actions
- >-
/admin/github-actions/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled
- >-
/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment
configure_github_advanced_security:
title: 'Configure {% data variables.product.prodname_GH_advanced_security %}'
description: "Improve the quality and security of your developers' code with {% data variables.product.prodname_GH_advanced_security %}."
title: Configure {% data variables.product.prodname_GH_advanced_security %}
description: >-
Improve the quality and security of your developers' code with {% data
variables.product.prodname_GH_advanced_security %}.
versions:
ghes: '*'
guides:
- /admin/advanced-security/about-licensing-for-github-advanced-security
- /admin/advanced-security/enabling-github-advanced-security-for-your-enterprise
- /admin/advanced-security/configuring-code-scanning-for-your-appliance
- /admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance
- /admin/advanced-security/configuring-secret-scanning-for-your-appliance
- /admin/policies/enforcing-policies-for-advanced-security-in-your-enterprise
- >-
/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security
- >-
/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise
- >-
/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance
- >-
/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-dependency-review-for-your-appliance
- >-
/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-secret-scanning-for-your-appliance
- >-
/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise
get_started_with_your_enterprise_account:
title: 'Get started with your enterprise account'
description: 'Get started with your enterprise account to centrally manage multiple organizations on {% data variables.product.product_name %}.'
title: Get started with your enterprise account
description: >-
Get started with your enterprise account to centrally manage multiple
organizations on {% data variables.product.product_name %}.
versions:
ghes: '*'
ghec: '*'
guides:
- /admin/overview/about-enterprise-accounts
- /billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise
- /admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise
- /admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise
- /admin/authentication/managing-identity-and-access-for-your-enterprise/configuring-saml-single-sign-on-for-your-enterprise
- /admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies
- >-
/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise
- >-
/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise
- >-
/admin/user-management/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise
- >-
/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise
- >-
/admin/policies/enforcing-policies-for-your-enterprise/about-enterprise-policies

Просмотреть файл

@ -1,134 +1,224 @@
# Feature available only on dotcom
security_advisories:
title: 'Fix and disclose a security vulnerability'
description: 'Using repository security advisories to privately fix a reported vulnerability and get a CVE.'
title: Fix and disclose a security vulnerability
description: >-
Using repository security advisories to privately fix a reported
vulnerability and get a CVE.
featured_track: '{% ifversion fpt or ghec %}true{% else %}false{% endif %}'
guides:
- /code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities
- /code-security/security-advisories/global-security-advisories/about-the-github-advisory-database
- /code-security/security-advisories/global-security-advisories/about-global-security-advisories
- /code-security/security-advisories/repository-security-advisories/about-repository-security-advisories
- /code-security/security-advisories/guidance-on-reporting-and-writing/best-practices-for-writing-repository-security-advisories
- /code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability
- /code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities
- /code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository
- /code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization
- /code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory
- /code-security/security-advisories/repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory
- /code-security/security-advisories/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability
- /code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory
- /code-security/security-advisories/repository-security-advisories/editing-a-repository-security-advisory
- /code-security/security-advisories/repository-security-advisories/withdrawing-a-repository-security-advisory
- /code-security/security-advisories/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory
# Feature available on dotcom and GHES 3.3+, so articles available on GHAE and earlier GHES hidden to hide the learning track
- >-
/code-security/security-advisories/guidance-on-reporting-and-writing/about-coordinated-disclosure-of-security-vulnerabilities
- >-
/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database
- >-
/code-security/security-advisories/global-security-advisories/about-global-security-advisories
- >-
/code-security/security-advisories/repository-security-advisories/about-repository-security-advisories
- >-
/code-security/security-advisories/guidance-on-reporting-and-writing/best-practices-for-writing-repository-security-advisories
- >-
/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability
- >-
/code-security/security-advisories/guidance-on-reporting-and-writing/managing-privately-reported-security-vulnerabilities
- >-
/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository
- >-
/code-security/security-advisories/repository-security-advisories/configuring-private-vulnerability-reporting-for-an-organization
- >-
/code-security/security-advisories/repository-security-advisories/creating-a-repository-security-advisory
- >-
/code-security/security-advisories/repository-security-advisories/adding-a-collaborator-to-a-repository-security-advisory
- >-
/code-security/security-advisories/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability
- >-
/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory
- >-
/code-security/security-advisories/repository-security-advisories/editing-a-repository-security-advisory
- >-
/code-security/security-advisories/repository-security-advisories/withdrawing-a-repository-security-advisory
- >-
/code-security/security-advisories/repository-security-advisories/removing-a-collaborator-from-a-repository-security-advisory
dependabot_alerts:
title: 'Get notifications for insecure dependencies'
description: 'Set up Dependabot to alert you to new vulnerabilities{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} in your dependencies.'
title: Get notifications for insecure dependencies
description: >-
Set up Dependabot to alert you to new vulnerabilities{% ifversion
GH-advisory-db-supports-malware %} or malware{% endif %} in your
dependencies.
guides:
- /code-security/dependabot/dependabot-alerts/about-dependabot-alerts
- '{% ifversion fpt or ghec or ghes %}/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository{% endif %}'
- /code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts
- /code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts
- /code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- /code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies
- /code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors
# Feature available on dotcom and GHES 3.3+, so articles available on GHAE and earlier GHES hidden to hide the learning track
- >-
{% ifversion fpt or ghec or ghes
%}/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository{%
endif %}
- >-
/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts
- >-
/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts
- >-
/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- >-
/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies
- >-
/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors
dependabot_security_updates:
title: 'Get pull requests to update your vulnerable dependencies'
description: 'Set up Dependabot to create pull requests when new vulnerabilities are reported.'
title: Get pull requests to update your vulnerable dependencies
description: >-
Set up Dependabot to create pull requests when new vulnerabilities are
reported.
guides:
- /code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates
- /code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates
- '{% ifversion fpt or ghec or ghes %}/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-notifications-for-vulnerable-dependencies{% endif %}'
- '{% ifversion fpt or ghec or ghes %}/github/administering-a-repository/managing-repository-settings/managing-security-and-analysis-settings-for-your-repository{% endif %}'
- /code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- '{% ifversion fpt or ghec or ghes %}/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/troubleshooting-the-detection-of-vulnerable-dependencies{% endif %}'
# Feature available only on dotcom and GHES 3.3+
- >-
/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates
- >-
/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates
- >-
{% ifversion fpt or ghec or ghes
%}/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts{%
endif %}
- >-
{% ifversion fpt or ghec or ghes
%}/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository{%
endif %}
- >-
/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- >-
{% ifversion fpt or ghec or ghes
%}/code-security/dependabot/working-with-dependabot/troubleshooting-the-detection-of-vulnerable-dependencies{%
endif %}
dependency_version_updates:
title: 'Keep your dependencies up-to-date'
description: 'Use Dependabot to check for new releases and create pull requests to update your dependencies.'
title: Keep your dependencies up-to-date
description: >-
Use Dependabot to check for new releases and create pull requests to update
your dependencies.
guides:
- /code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates
- /code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates
- /code-security/dependabot/dependabot-version-updates/customizing-dependency-updates
- /code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
- /code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
- /code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions
- /code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates
- /code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot
- /code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- /code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors
# Feature available in GHEC, GHES 3.0 up, and GHAE. Feature limited on FPT.
- >-
/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates
- >-
/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates
- >-
/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates
- >-
/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
- >-
/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
- >-
/code-security/dependabot/working-with-dependabot/automating-dependabot-with-github-actions
- >-
/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates
- >-
/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot
- >-
/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates
- >-
/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors
secret_scanning:
title: 'Scan for secrets'
description: 'Set up secret scanning to guard against accidental check-ins of tokens, passwords, and other secrets to your repository.'
title: Scan for secrets
description: >-
Set up secret scanning to guard against accidental check-ins of tokens,
passwords, and other secrets to your repository.
guides:
- '/code-security/secret-scanning/about-secret-scanning'
- '/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories'
- '{% ifversion not fpt %}/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning{% endif %}'
- '/code-security/secret-scanning/managing-alerts-from-secret-scanning'
- '/code-security/secret-scanning/secret-scanning-patterns'
- '{% ifversion secret-scanning-push-protection %}/code-security/secret-scanning/protecting-pushes-with-secret-scanning{% endif %}'
- '{% ifversion secret-scanning-push-protection %}/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection{% endif %}'
- '/code-security/secret-scanning/troubleshooting-secret-scanning'
# Security overview feature available in GHEC and GHES 3.2+, so other articles hidden to hide the learning path in other versions
- /code-security/secret-scanning/about-secret-scanning
- >-
/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories
- >-
{% ifversion not fpt
%}/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning{%
endif %}
- /code-security/secret-scanning/managing-alerts-from-secret-scanning
- /code-security/secret-scanning/secret-scanning-patterns
- >-
{% ifversion secret-scanning-push-protection
%}/code-security/secret-scanning/protecting-pushes-with-secret-scanning{%
endif %}
- >-
{% ifversion secret-scanning-push-protection
%}/code-security/secret-scanning/pushing-a-branch-blocked-by-push-protection{%
endif %}
- /code-security/secret-scanning/troubleshooting-secret-scanning
security_alerts:
title: 'Explore and manage security alerts'
description: 'Learn where to find and resolve security alerts.'
title: Explore and manage security alerts
description: Learn where to find and resolve security alerts.
guides:
- '{% ifversion ghec or ghes %}/code-security/security-overview/about-the-security-overview {% endif %}'
- '{% ifversion ghec or ghes %}/code-security/security-overview/viewing-the-security-overview {% endif %}'
- '{% ifversion ghec or ghes %}/code-security/secret-scanning/managing-alerts-from-secret-scanning {% endif %}'
- '{% ifversion ghec or ghes %}/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository{% endif %}'
- '{% ifversion ghec or ghes %}/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests{% endif %}'
- '{% ifversion ghec or ghes %}/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/viewing-and-updating-vulnerable-dependencies-in-your-repository{% endif %}'
- '{% ifversion ghec or ghes %}/code-security/getting-started/auditing-security-alerts {% endif %}'
# Feature available in all versions from GHES 2.22 up
- >-
{% ifversion ghec or ghes
%}/code-security/security-overview/about-the-security-overview {% endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/security-overview/viewing-the-security-overview {% endif
%}
- >-
{% ifversion ghec or ghes
%}/code-security/secret-scanning/managing-alerts-from-secret-scanning {%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/managing-code-scanning-alerts-for-your-repository{%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/triaging-code-scanning-alerts-in-pull-requests{%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts{%
endif %}
- >-
{% ifversion ghec or ghes
%}/code-security/getting-started/auditing-security-alerts {% endif %}
code_security_actions:
title: 'Run code scanning with GitHub Actions'
description: 'Check your default branch and every pull request to keep vulnerabilities and errors out of your repository.'
title: Run code scanning with GitHub Actions
description: >-
Check your default branch and every pull request to keep vulnerabilities and
errors out of your repository.
featured_track: '{% ifversion ghae or ghes %}true{% else %}false{% endif %}'
guides:
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/setting-up-code-scanning-for-a-repository
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container
- /code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow
# Feature available in all versions from GHES 2.22 up
- >-
/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning
- >-
/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning-for-a-repository
- >-
/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/customizing-code-scanning
- >-
/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages
- >-
/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/running-codeql-code-scanning-in-a-container
- >-
/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/troubleshooting-the-codeql-workflow
code_security_integration:
title: 'Integrate with code scanning'
description: 'Upload code analysis results from third-party systems to GitHub using SARIF.'
title: Integrate with code scanning
description: Upload code analysis results from third-party systems to GitHub using SARIF.
guides:
- /code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning
- /code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github
- /code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning
- /rest/reference/code-scanning
# Feature available in all versions from GHES 2.22 up
- >-
/code-security/code-scanning/integrating-with-code-scanning/about-integration-with-code-scanning
- >-
/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github
- >-
/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning
- /rest/code-scanning
code_security_ci:
title: 'Run CodeQL code scanning in your CI'
description: 'Set up CodeQL within your existing CI and upload results to GitHub code scanning.'
title: Run CodeQL code scanning in your CI
description: >-
Set up CodeQL within your existing CI and upload results to GitHub code
scanning.
guides:
- /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system
- /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system
- /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system
- /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli
- /code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system
# Feature available in all versions
- >-
/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/about-codeql-code-scanning-in-your-ci-system
- >-
/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system
- >-
/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system
- >-
/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli
- >-
/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/troubleshooting-codeql-runner-in-your-ci-system
end_to_end_supply_chain:
title: 'End-to-end supply chain'
description: 'How to think about securing your user accounts, your code, and your build process.'
title: End-to-end supply chain
description: >-
How to think about securing your user accounts, your code, and your build
process.
guides:
- /code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview
- /code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts
- >-
/code-security/supply-chain-security/end-to-end-supply-chain/end-to-end-supply-chain-overview
- >-
/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts
- /code-security/supply-chain-security/end-to-end-supply-chain/securing-code
- /code-security/supply-chain-security/end-to-end-supply-chain/securing-builds
- >-
/code-security/supply-chain-security/end-to-end-supply-chain/securing-builds

Просмотреть файл

@ -14,6 +14,7 @@ import path from 'path'
import { program } from 'commander'
import chalk from 'chalk'
import yaml from 'js-yaml'
import { updateInternalLinks } from '../lib/update-internal-links.js'
import frontmatter from '../lib/read-frontmatter.js'
@ -130,13 +131,17 @@ async function main(files, opts) {
}
}
if (!opts.dryRun) {
// Remember the `content` and `newContent` is the "meat" of the
// Markdown page. To save it you need the frontmatter data too.
fs.writeFileSync(
file,
frontmatter.stringify(newContent, newData, { lineWidth: 10000 }),
'utf-8'
)
if (file.endsWith('.yml')) {
fs.writeFileSync(file, yaml.dump(newData), 'utf-8')
} else {
// Remember the `content` and `newContent` is the "meat" of the
// Markdown page. To save it you need the frontmatter data too.
fs.writeFileSync(
file,
frontmatter.stringify(newContent, newData, { lineWidth: 10000 }),
'utf-8'
)
}
}
}
if (warnings.length) {