From 43b64585a65f44be5f56d872100da327d42c1546 Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Fri, 13 Mar 2026 13:15:01 -0400 Subject: [PATCH 1/4] Linter to enforce contentType (EDI-fied docs only) (#60197) Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .../moving-your-work-to-an-organization.md | 1 + content/account-and-profile/index.md | 1 + content/actions/concepts/billing-and-usage.md | 5 +- content/actions/concepts/index.md | 1 + content/actions/concepts/metrics.md | 3 +- .../runners/actions-runner-controller.md | 3 +- .../concepts/runners/github-hosted-runners.md | 1 + content/actions/concepts/runners/index.md | 1 + .../concepts/runners/larger-runners.md | 3 +- .../concepts/runners/private-networking.md | 1 + .../actions/concepts/runners/runner-groups.md | 3 +- .../concepts/runners/runner-scale-sets.md | 3 +- .../concepts/runners/support-for-arc.md | 3 +- .../security/artifact-attestations.md | 3 +- .../concepts/security/compromised-runners.md | 3 +- .../actions/concepts/security/github_token.md | 1 + content/actions/concepts/security/index.md | 2 + .../kubernetes-admissions-controller.md | 1 + .../concepts/security/openid-connect.md | 2 +- .../concepts/security/script-injections.md | 1 + content/actions/concepts/security/secrets.md | 1 + .../concepts/workflows-and-actions/index.md | 2 + .../notifications-for-workflow-runs.md | 1 + .../reusing-workflow-configurations.md | 1 + .../actions/get-started/actions-vs-apps.md | 2 +- .../get-started/continuous-deployment.md | 2 +- .../get-started/continuous-integration.md | 2 +- content/actions/get-started/index.md | 2 + .../get-started/understand-github-actions.md | 2 +- content/actions/how-tos/administer/index.md | 4 +- .../how-tos/administer/view-metrics.md | 3 +- .../create-a-cli-action.md | 3 +- .../create-and-publish-actions/index.md | 4 +- .../manage-custom-actions.md | 2 +- .../publish-in-github-marketplace.md | 3 +- .../release-and-maintain-actions.md | 1 + .../set-exit-codes.md | 3 +- ...nd-tags-to-manage-your-actions-releases.md | 3 +- .../configure-custom-protection-rules.md | 3 +- .../control-deployments.md | 2 +- .../create-custom-protection-rules.md | 3 +- .../configure-and-manage-deployments/index.md | 2 + .../manage-environments.md | 1 + .../review-deployments.md | 1 + .../view-deployment-history.md | 1 + .../amazon-elastic-container-service.md | 1 + .../azure-kubernetes-service.md | 1 + .../azure-static-web-app.md | 1 + .../docker-to-azure-app-service.md | 1 + .../google-kubernetes-engine.md | 2 +- .../deploy-to-third-party-platforms/index.md | 2 + .../java-to-azure-app-service.md | 1 + .../net-to-azure-app-service.md | 1 + .../nodejs-to-azure-app-service.md | 1 + .../php-to-azure-app-service.md | 1 + .../python-to-azure-app-service.md | 1 + .../sign-xcode-applications.md | 3 +- content/actions/how-tos/deploy/index.md | 2 + content/actions/how-tos/get-support.md | 2 +- content/actions/how-tos/index.md | 2 + .../connect-to-a-private-network/index.md | 3 +- .../customize-runners.md | 2 +- .../github-hosted-runners/index.md | 1 + .../use-github-hosted-runners.md | 3 +- .../view-current-jobs.md | 3 +- .../actions/how-tos/manage-runners/index.md | 1 + .../larger-runners/control-access.md | 2 +- .../manage-runners/larger-runners/index.md | 1 + .../larger-runners/manage-larger-runners.md | 5 +- .../larger-runners/use-custom-images.md | 4 +- .../larger-runners/use-larger-runners.md | 3 +- .../self-hosted-runners/add-runners.md | 3 +- .../self-hosted-runners/apply-labels.md | 1 + .../configure-the-application.md | 1 + .../customize-containers.md | 1 + .../self-hosted-runners/index.md | 1 + .../self-hosted-runners/manage-access.md | 5 +- .../monitor-and-troubleshoot.md | 1 + .../self-hosted-runners/remove-runners.md | 3 +- .../self-hosted-runners/run-scripts.md | 3 +- .../self-hosted-runners/use-in-a-workflow.md | 3 +- .../approve-runs-from-forks.md | 1 + .../cancel-a-workflow-run.md | 3 +- .../delete-a-workflow-run.md | 3 +- .../disable-and-enable-workflows.md | 3 +- .../download-workflow-artifacts.md | 3 +- .../how-tos/manage-workflow-runs/index.md | 2 + .../manage-workflow-runs/manage-caches.md | 3 +- .../manually-run-a-workflow.md | 3 +- .../re-run-workflows-and-jobs.md | 3 +- .../remove-workflow-artifacts.md | 3 +- .../skip-workflow-runs.md | 1 + .../monitor-workflows/add-a-status-badge.md | 1 + .../monitor-workflows/enable-debug-logging.md | 3 +- .../how-tos/monitor-workflows/index.md | 3 +- .../use-the-visualization-graph.md | 1 + .../use-workflow-run-logs.md | 3 +- .../view-job-execution-time.md | 3 +- .../view-workflow-run-history.md | 1 + .../create-workflow-templates.md | 2 +- .../how-tos/reuse-automations/index.md | 3 +- .../reuse-automations/reuse-workflows.md | 1 + .../share-across-private-repositories.md | 1 + .../share-with-your-enterprise.md | 2 +- .../share-with-your-organization.md | 1 + .../actions/how-tos/secure-your-work/index.md | 3 +- .../security-harden-deployments/index.md | 2 + .../oidc-in-aws.md | 2 +- .../oidc-in-azure.md | 2 +- .../oidc-in-cloud-providers.md | 2 +- .../oidc-in-google-cloud-platform.md | 2 +- .../oidc-in-hashicorp-vault.md | 2 +- .../oidc-in-jfrog.md | 2 +- .../oidc-in-octopus-deploy.md | 2 +- .../oidc-in-pypi.md | 2 +- .../enforce-artifact-attestations.md | 1 + .../increase-security-rating.md | 1 + .../use-artifact-attestations/index.md | 2 + .../manage-attestations.md | 1 + .../use-artifact-attestations.md | 1 + .../verify-attestations-offline.md | 1 + .../actions/how-tos/troubleshoot-workflows.md | 3 +- .../choose-what-workflows-do/add-scripts.md | 3 +- .../deploy-to-environment.md | 1 + .../choose-what-workflows-do/index.md | 4 +- .../pass-job-outputs.md | 1 + .../run-job-variations.md | 1 + .../set-default-values-for-jobs.md | 3 +- .../choose-what-workflows-do/use-jobs.md | 1 + .../choose-what-workflows-do/use-secrets.md | 3 +- .../choose-what-workflows-do/use-variables.md | 1 + .../control-jobs-with-conditions.md | 1 + .../control-workflow-concurrency.md | 1 + .../choose-when-workflows-run/index.md | 2 + .../trigger-a-workflow.md | 2 +- .../choose-the-runner-for-a-job.md | 1 + .../choose-where-workflows-run/index.md | 2 + .../run-jobs-in-a-container.md | 1 + .../actions/how-tos/write-workflows/index.md | 1 + .../write-workflows/use-workflow-templates.md | 2 +- .../custom-transformers.md | 2 +- .../github-actions-importer/index.md | 2 + content/actions/reference/index.md | 2 + content/actions/reference/limits.md | 3 +- .../runners/github-hosted-runners.md | 3 +- content/actions/reference/runners/index.md | 2 + .../reference/runners/larger-runners.md | 3 +- .../reference/runners/self-hosted-runners.md | 2 +- content/actions/reference/security/index.md | 2 + content/actions/reference/security/oidc.md | 7 +- content/actions/reference/security/secrets.md | 3 +- .../actions/reference/security/secure-use.md | 3 +- .../workflows-and-actions/contexts.md | 3 +- .../dependency-caching.md | 2 +- .../deployments-and-environments.md | 3 +- .../events-that-trigger-workflows.md | 3 +- .../workflows-and-actions/expressions.md | 3 +- .../reference/workflows-and-actions/index.md | 2 + .../reusing-workflow-configurations.md | 1 + .../workflows-and-actions/variables.md | 3 +- .../workflow-cancellation.md | 3 +- .../workflow-commands.md | 1 + .../workflows-and-actions/workflow-syntax.md | 1 + .../authenticate-with-github_token.md | 3 +- .../tutorials/build-and-test-code/go.md | 1 + .../tutorials/build-and-test-code/index.md | 3 +- .../build-and-test-code/java-with-ant.md | 1 + .../build-and-test-code/java-with-gradle.md | 1 + .../build-and-test-code/java-with-maven.md | 1 + .../tutorials/build-and-test-code/net.md | 1 + .../tutorials/build-and-test-code/nodejs.md | 1 + .../build-and-test-code/powershell.md | 1 + .../tutorials/build-and-test-code/python.md | 1 + .../tutorials/build-and-test-code/ruby.md | 1 + .../tutorials/build-and-test-code/rust.md | 1 + .../tutorials/build-and-test-code/swift.md | 1 + .../build-and-test-code/xamarin-apps.md | 1 + .../actions/tutorials/create-actions/index.md | 2 + content/actions/tutorials/index.md | 2 + .../tutorials/manage-your-work/index.md | 4 +- .../automated-migrations/index.md | 6 +- .../use-github-actions-importer.md | 2 +- .../migrate-to-github-actions/index.md | 3 +- .../manual-migrations/index.md | 4 +- .../tutorials/publish-packages/index.md | 3 +- .../authenticate-to-the-api.md | 2 +- .../deploy-runner-scale-sets.md | 2 +- .../use-actions-runner-controller/index.md | 17 +- .../quickstart.md | 2 +- .../troubleshoot.md | 2 +- .../use-arc-in-a-workflow.md | 2 +- .../use-containerized-services/index.md | 4 +- .../use-docker-service-containers.md | 2 +- .../github-security-features.md | 2 +- .../code-security/getting-started/index.md | 2 + ...ickstart-for-securing-your-organization.md | 2 +- ...quickstart-for-securing-your-repository.md | 2 +- .../remove-linked-artifacts.md | 8 +- .../upload-linked-artifacts.md | 8 +- .../view-linked-artifacts.md | 8 +- content/code-security/index.md | 2 + .../java-package-metadata-dependabot.md | 2 +- ...luating-default-setup-for-code-scanning.md | 2 +- .../concepts/agents/about-agent-skills.md | 3 +- .../coding-agent/about-custom-agents.md | 1 + .../concepts/copilot-usage-metrics/index.md | 2 + .../how-tos/copilot-cli/cli-best-practices.md | 10 +- .../copilot-cli/cli-getting-started.md | 10 +- content/copilot/how-tos/copilot-cli/index.md | 6 +- .../copilot-sdk/sdk-getting-started.md | 6 +- .../coding-agent/create-custom-agents.md | 3 +- .../reference/copilot-billing/index.md | 2 + .../reference/copilot-cli-reference/index.md | 4 +- .../reference/copilot-feature-matrix.md | 3 +- .../reference/copilot-usage-metrics/index.md | 2 + .../custom-agents/bug-fix-teammate.md | 1 + .../custom-agents/cleanup-specialist.md | 1 + .../custom-agents/implementation-planner.md | 1 + .../custom-agents/index.md | 4 +- .../github-actions-helper.md | 3 +- .../custom-instructions/issue-manager.md | 3 +- .../pull-request-assistant.md | 3 +- .../your-first-custom-instructions.md | 3 +- .../concepts/about-building-integrations.md | 3 +- .../concepts/about-integrations.md | 9 +- .../concepts/featured-github-integrations.md | 3 +- .../concepts/github-developer-program.md | 3 +- .../how-tos/slack/customize-notifications.md | 4 +- .../slack/integrate-github-with-slack.md | 9 +- .../how-tos/slack/use-github-in-slack.md | 9 +- .../how-tos/teams/customize-notifications.md | 6 +- .../teams/integrate-github-with-teams.md | 11 +- .../how-tos/teams/use-github-in-teams.md | 13 +- content/integrations/tutorials/index.md | 9 +- .../tutorials/slack/create-issues.md | 4 +- content/integrations/tutorials/slack/index.md | 9 +- .../tutorials/slack/manage-issues.md | 4 +- .../tutorials/teams/create-issues.md | 4 +- content/integrations/tutorials/teams/index.md | 9 +- .../tutorials/teams/manage-issues.md | 4 +- .../concepts/about-notifications.md | 3 +- .../concepts/index.md | 1 + .../get-started/configuring-notifications.md | 3 +- .../get-started/index.md | 4 +- .../how-tos/index.md | 1 + .../managing-github-actions-notifications.md | 1 + .../managing-marketing-emails-from-github.md | 1 + .../managing-organization-notifications.md | 1 + .../managing-security-notifications.md | 1 + .../index.md | 3 +- .../managing-your-subscriptions.md | 3 +- .../viewing-your-subscriptions.md | 3 +- .../index.md | 1 + .../managing-notifications-from-your-inbox.md | 1 + .../triaging-a-single-notification.md | 3 +- .../subscriptions-and-notifications/index.md | 3 +- .../reference/email-notification-headers.md | 3 +- .../reference/inbox-filters.md | 3 +- .../reference/index.md | 1 + ...orkflow-for-triaging-your-notifications.md | 3 +- .../tutorials/index.md | 4 +- .../contributing/content-linter-rules.md | 1 + .../linting-rules/frontmatter-content-type.ts | 163 ++++++++++++++ src/content-linter/lib/linting-rules/index.ts | 2 + src/content-linter/style/github-docs.ts | 6 + .../tests/unit/frontmatter-content-type.ts | 201 ++++++++++++++++++ .../scripts/add-content-type.ts | 5 + .../content/copilot/concepts/index.md | 10 + .../content/copilot/concepts/overview.md | 8 + .../content/copilot/get-started/index.md | 10 + .../content/copilot/get-started/quickstart.md | 8 + .../content/copilot/getting-started/index.md | 10 + .../content/copilot/getting-started/setup.md | 8 + .../fixtures/content/copilot/how-tos/index.md | 10 + .../content/copilot/how-tos/using-copilot.md | 8 + .../fixtures/content/copilot/index.md | 17 ++ .../fixtures/content/copilot/reference/api.md | 8 + .../content/copilot/reference/index.md | 10 + .../copilot/responsible-use/guidelines.md | 8 + .../content/copilot/responsible-use/index.md | 10 + .../content/copilot/tutorials/first-steps.md | 8 + .../content/copilot/tutorials/index.md | 10 + src/fixtures/fixtures/content/index.md | 2 +- 283 files changed, 987 insertions(+), 224 deletions(-) create mode 100644 src/content-linter/lib/linting-rules/frontmatter-content-type.ts create mode 100644 src/content-linter/tests/unit/frontmatter-content-type.ts create mode 100644 src/fixtures/fixtures/content/copilot/concepts/index.md create mode 100644 src/fixtures/fixtures/content/copilot/concepts/overview.md create mode 100644 src/fixtures/fixtures/content/copilot/get-started/index.md create mode 100644 src/fixtures/fixtures/content/copilot/get-started/quickstart.md create mode 100644 src/fixtures/fixtures/content/copilot/getting-started/index.md create mode 100644 src/fixtures/fixtures/content/copilot/getting-started/setup.md create mode 100644 src/fixtures/fixtures/content/copilot/how-tos/index.md create mode 100644 src/fixtures/fixtures/content/copilot/how-tos/using-copilot.md create mode 100644 src/fixtures/fixtures/content/copilot/index.md create mode 100644 src/fixtures/fixtures/content/copilot/reference/api.md create mode 100644 src/fixtures/fixtures/content/copilot/reference/index.md create mode 100644 src/fixtures/fixtures/content/copilot/responsible-use/guidelines.md create mode 100644 src/fixtures/fixtures/content/copilot/responsible-use/index.md create mode 100644 src/fixtures/fixtures/content/copilot/tutorials/first-steps.md create mode 100644 src/fixtures/fixtures/content/copilot/tutorials/index.md diff --git a/content/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization.md b/content/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization.md index ed51252f51b9..ea6a0595d0f7 100644 --- a/content/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization.md +++ b/content/account-and-profile/how-tos/account-management/moving-your-work-to-an-organization.md @@ -8,6 +8,7 @@ versions: shortTitle: Move work to organization category: - Change or close your account +contentType: how-tos --- ## Keeping your username for the organization diff --git a/content/account-and-profile/index.md b/content/account-and-profile/index.md index 91889629fe12..bd00edfbb808 100644 --- a/content/account-and-profile/index.md +++ b/content/account-and-profile/index.md @@ -40,5 +40,6 @@ children: - /how-tos - /tutorials - /reference +contentType: landing --- diff --git a/content/actions/concepts/billing-and-usage.md b/content/actions/concepts/billing-and-usage.md index 1986bd372733..cd8f832aec0a 100644 --- a/content/actions/concepts/billing-and-usage.md +++ b/content/actions/concepts/billing-and-usage.md @@ -1,6 +1,6 @@ --- -title: 'Billing and usage' -intro: 'There are usage limits for {% data variables.product.prodname_actions %} workflows. Usage charges apply to repositories that go beyond the amount of free minutes and storage for a repository.' +title: Billing and usage +intro: There are usage limits for {% data variables.product.prodname_actions %} workflows. Usage charges apply to repositories that go beyond the amount of free minutes and storage for a repository. redirect_from: - /actions/getting-started-with-github-actions/usage-and-billing-information-for-github-actions - /actions/reference/usage-limits-billing-and-administration @@ -13,6 +13,7 @@ versions: ghec: '*' category: - Administer GitHub Actions +contentType: concepts --- ## About billing for {% data variables.product.prodname_actions %} diff --git a/content/actions/concepts/index.md b/content/actions/concepts/index.md index f604ef884611..7a4b6c248c8e 100644 --- a/content/actions/concepts/index.md +++ b/content/actions/concepts/index.md @@ -14,5 +14,6 @@ children: - /billing-and-usage redirect_from: - /actions/concepts/use-cases +contentType: concepts --- diff --git a/content/actions/concepts/metrics.md b/content/actions/concepts/metrics.md index fcd296ea9085..d80c54333903 100644 --- a/content/actions/concepts/metrics.md +++ b/content/actions/concepts/metrics.md @@ -1,7 +1,7 @@ --- title: About GitHub Actions metrics shortTitle: Metrics -intro: 'Learn about the {% data variables.product.prodname_actions %} metrics available for your organizations and repositories.' +intro: Learn about the {% data variables.product.prodname_actions %} metrics available for your organizations and repositories. permissions: Organization owners and users with the "View organization Actions metrics" permission can view organization-level metrics.

Users with the base repository role can view repository-level metrics. versions: feature: actions-metrics @@ -9,6 +9,7 @@ redirect_from: - /actions/concepts/about-github-actions-metrics category: - Administer GitHub Actions +contentType: concepts --- {% data reusables.actions.about-actions-metrics %} diff --git a/content/actions/concepts/runners/actions-runner-controller.md b/content/actions/concepts/runners/actions-runner-controller.md index 5295796b70b4..342afd4d3ee6 100644 --- a/content/actions/concepts/runners/actions-runner-controller.md +++ b/content/actions/concepts/runners/actions-runner-controller.md @@ -1,6 +1,6 @@ --- title: Actions Runner Controller -intro: 'You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows.' +intro: You can host your own runners and customize the environment used to run jobs in your {% data variables.product.prodname_actions %} workflows. versions: fpt: '*' ghec: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/concepts/runners/about-actions-runner-controller category: - Set up runners +contentType: concepts --- ## About {% data variables.product.prodname_actions_runner_controller %} diff --git a/content/actions/concepts/runners/github-hosted-runners.md b/content/actions/concepts/runners/github-hosted-runners.md index 67d4309179ee..e02647bfcd12 100644 --- a/content/actions/concepts/runners/github-hosted-runners.md +++ b/content/actions/concepts/runners/github-hosted-runners.md @@ -20,6 +20,7 @@ versions: ghec: '*' category: - Set up runners +contentType: concepts --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/concepts/runners/index.md b/content/actions/concepts/runners/index.md index c5b41fd86a27..be99f174cce7 100644 --- a/content/actions/concepts/runners/index.md +++ b/content/actions/concepts/runners/index.md @@ -15,5 +15,6 @@ children: - /runner-scale-sets - /actions-runner-controller - /support-for-arc +contentType: concepts --- diff --git a/content/actions/concepts/runners/larger-runners.md b/content/actions/concepts/runners/larger-runners.md index 8eadd4cf9b6f..77cdfb34791d 100644 --- a/content/actions/concepts/runners/larger-runners.md +++ b/content/actions/concepts/runners/larger-runners.md @@ -1,6 +1,6 @@ --- title: Larger runners -intro: 'Learn about the types and uses of {% data variables.product.prodname_dotcom %}-hosted {% data variables.actions.hosted_runners %}.' +intro: Learn about the types and uses of {% data variables.product.prodname_dotcom %}-hosted {% data variables.actions.hosted_runners %}. permissions: '{% data reusables.actions.larger-runner-permissions %}' versions: fpt: '*' @@ -12,6 +12,7 @@ redirect_from: - /actions/concepts/runners/about-larger-runners category: - Set up runners +contentType: concepts --- {% ifversion ghes %} diff --git a/content/actions/concepts/runners/private-networking.md b/content/actions/concepts/runners/private-networking.md index 1a0213199223..c214883bc511 100644 --- a/content/actions/concepts/runners/private-networking.md +++ b/content/actions/concepts/runners/private-networking.md @@ -12,6 +12,7 @@ redirect_from: - /actions/concepts/runners/private-networking-with-github-hosted-runners category: - Set up runners +contentType: concepts --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/concepts/runners/runner-groups.md b/content/actions/concepts/runners/runner-groups.md index be208d77cc4e..e7e02994405a 100644 --- a/content/actions/concepts/runners/runner-groups.md +++ b/content/actions/concepts/runners/runner-groups.md @@ -1,6 +1,6 @@ --- title: Runner groups -intro: 'Learn about what a runner group is, and how to use them to control access to runners at the organization{% ifversion ghec or ghes %} and/or enterprise levels{% else %} level.{% endif %}' +intro: Learn about what a runner group is, and how to use them to control access to runners at the organization{% ifversion ghec or ghes %} and/or enterprise levels{% else %} level.{% endif %} versions: fpt: '*' ghec: '*' @@ -9,6 +9,7 @@ redirect_from: - /actions/concepts/runners/about-runner-groups category: - Set up runners +contentType: concepts --- ## About runner groups diff --git a/content/actions/concepts/runners/runner-scale-sets.md b/content/actions/concepts/runners/runner-scale-sets.md index 970e67fba490..9fd67070431d 100644 --- a/content/actions/concepts/runners/runner-scale-sets.md +++ b/content/actions/concepts/runners/runner-scale-sets.md @@ -1,6 +1,6 @@ --- title: Runner scale sets -intro: 'Learn about what a runner scale set is and how they can interact with the {% data variables.product.prodname_actions_runner_controller %}.' +intro: Learn about what a runner scale set is and how they can interact with the {% data variables.product.prodname_actions_runner_controller %}. layout: inline versions: fpt: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/concepts/runners/about-runner-scale-sets category: - Set up runners +contentType: concepts --- ## About runner scale sets diff --git a/content/actions/concepts/runners/support-for-arc.md b/content/actions/concepts/runners/support-for-arc.md index 3c7523fda58b..1523b2e68c72 100644 --- a/content/actions/concepts/runners/support-for-arc.md +++ b/content/actions/concepts/runners/support-for-arc.md @@ -1,7 +1,7 @@ --- title: Support for Actions Runner Controller shortTitle: Support for ARC -intro: 'What to know before you [contact {% data variables.contact.github_support %}](support/contacting-github-support) for assistance with Actions Runner Controller.' +intro: What to know before you [contact {% data variables.contact.github_support %}](/support/contacting-github-support) for assistance with Actions Runner Controller. versions: fpt: '*' ghec: '*' @@ -12,6 +12,7 @@ redirect_from: - /actions/concepts/runners/support-for-actions-runner-controller category: - Set up runners +contentType: concepts --- ## Overview diff --git a/content/actions/concepts/security/artifact-attestations.md b/content/actions/concepts/security/artifact-attestations.md index 3f6d25383286..c10cf6570cf7 100644 --- a/content/actions/concepts/security/artifact-attestations.md +++ b/content/actions/concepts/security/artifact-attestations.md @@ -1,11 +1,12 @@ --- title: Artifact attestations -intro: 'Understand the usage and security benefits of artifact attestations.' +intro: Understand the usage and security benefits of artifact attestations. versions: fpt: '*' ghec: '*' category: - Secure your workflows +contentType: concepts --- ## Overview diff --git a/content/actions/concepts/security/compromised-runners.md b/content/actions/concepts/security/compromised-runners.md index c06fe7cc388c..4ec941c3de2e 100644 --- a/content/actions/concepts/security/compromised-runners.md +++ b/content/actions/concepts/security/compromised-runners.md @@ -1,6 +1,6 @@ --- title: Compromised runners -intro: 'Understand the security risks associated with compromised {% data variables.product.prodname_actions %} runners.' +intro: Understand the security risks associated with compromised {% data variables.product.prodname_actions %} runners. versions: fpt: '*' ghes: '*' @@ -9,6 +9,7 @@ redirect_from: - /actions/concepts/security/compromised-runner category: - Secure your workflows +contentType: concepts --- ## Potential impact of a compromised runner diff --git a/content/actions/concepts/security/github_token.md b/content/actions/concepts/security/github_token.md index 771cebec89d6..101873ecb605 100644 --- a/content/actions/concepts/security/github_token.md +++ b/content/actions/concepts/security/github_token.md @@ -7,6 +7,7 @@ versions: ghec: '*' category: - Secure your workflows +contentType: concepts --- ## About the `GITHUB_TOKEN` diff --git a/content/actions/concepts/security/index.md b/content/actions/concepts/security/index.md index 7f2f0c723e13..f03e1f11bbf7 100644 --- a/content/actions/concepts/security/index.md +++ b/content/actions/concepts/security/index.md @@ -14,4 +14,6 @@ children: - /script-injections - /compromised-runners - /kubernetes-admissions-controller +contentType: concepts --- + diff --git a/content/actions/concepts/security/kubernetes-admissions-controller.md b/content/actions/concepts/security/kubernetes-admissions-controller.md index d3f1e78233df..470408ecc68b 100644 --- a/content/actions/concepts/security/kubernetes-admissions-controller.md +++ b/content/actions/concepts/security/kubernetes-admissions-controller.md @@ -6,6 +6,7 @@ versions: ghec: '*' category: - Secure your workflows +contentType: concepts --- ## About Kubernetes admission controller diff --git a/content/actions/concepts/security/openid-connect.md b/content/actions/concepts/security/openid-connect.md index 146f4e8f2713..c5bb0d572104 100644 --- a/content/actions/concepts/security/openid-connect.md +++ b/content/actions/concepts/security/openid-connect.md @@ -9,7 +9,7 @@ redirect_from: - /actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect - /actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect - /actions/concepts/security/about-security-hardening-with-openid-connect -contentType: tutorials +contentType: concepts category: - Secure your workflows --- diff --git a/content/actions/concepts/security/script-injections.md b/content/actions/concepts/security/script-injections.md index ad69277721c1..e20c1cc4cb75 100644 --- a/content/actions/concepts/security/script-injections.md +++ b/content/actions/concepts/security/script-injections.md @@ -7,6 +7,7 @@ versions: ghec: '*' category: - Secure your workflows +contentType: concepts --- ## Understanding the risk of script injections diff --git a/content/actions/concepts/security/secrets.md b/content/actions/concepts/security/secrets.md index 4fec45054d62..87a7e7302a4a 100644 --- a/content/actions/concepts/security/secrets.md +++ b/content/actions/concepts/security/secrets.md @@ -10,6 +10,7 @@ redirect_from: - /actions/concepts/security/about-secrets category: - Secure your workflows +contentType: concepts --- ## About secrets diff --git a/content/actions/concepts/workflows-and-actions/index.md b/content/actions/concepts/workflows-and-actions/index.md index 0bdcfc4d7785..8dac435cd8ec 100644 --- a/content/actions/concepts/workflows-and-actions/index.md +++ b/content/actions/concepts/workflows-and-actions/index.md @@ -17,4 +17,6 @@ children: - /workflow-artifacts - /dependency-caching - /notifications-for-workflow-runs +contentType: concepts --- + diff --git a/content/actions/concepts/workflows-and-actions/notifications-for-workflow-runs.md b/content/actions/concepts/workflows-and-actions/notifications-for-workflow-runs.md index d77d4380747b..73bfa68f50d4 100644 --- a/content/actions/concepts/workflows-and-actions/notifications-for-workflow-runs.md +++ b/content/actions/concepts/workflows-and-actions/notifications-for-workflow-runs.md @@ -10,6 +10,7 @@ redirect_from: - /actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/notifications-for-workflow-runs category: - Write workflows +contentType: concepts --- If you enable email or web notifications for {% data variables.product.prodname_actions %}, you'll receive a notification when any workflow runs that you've triggered have completed. The notification will include the workflow run's status (including successful, failed, neutral, and canceled runs). You can also choose to receive a notification only when a workflow run has failed. For more information about enabling or disabling notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications). diff --git a/content/actions/concepts/workflows-and-actions/reusing-workflow-configurations.md b/content/actions/concepts/workflows-and-actions/reusing-workflow-configurations.md index 3b6d68073f53..7e32d16f2348 100644 --- a/content/actions/concepts/workflows-and-actions/reusing-workflow-configurations.md +++ b/content/actions/concepts/workflows-and-actions/reusing-workflow-configurations.md @@ -13,6 +13,7 @@ redirect_from: - /actions/concepts/workflows-and-actions/reusable-workflows category: - Reuse and share automations +contentType: concepts --- ## Reusable workflows diff --git a/content/actions/get-started/actions-vs-apps.md b/content/actions/get-started/actions-vs-apps.md index c84ad92c3a9d..bce5a53d57ca 100644 --- a/content/actions/get-started/actions-vs-apps.md +++ b/content/actions/get-started/actions-vs-apps.md @@ -9,7 +9,7 @@ versions: redirect_from: - /actions/concepts/overview/github-actions-vs-github-apps - /actions/get-started/github-actions-vs-github-apps -contentType: concepts +contentType: get-started category: - Get started with GitHub Actions --- diff --git a/content/actions/get-started/continuous-deployment.md b/content/actions/get-started/continuous-deployment.md index 9f656cd98150..c982f61ad1ab 100644 --- a/content/actions/get-started/continuous-deployment.md +++ b/content/actions/get-started/continuous-deployment.md @@ -13,7 +13,7 @@ redirect_from: - /actions/about-github-actions/about-continuous-deployment-with-github-actions - /actions/concepts/overview/about-continuous-deployment-with-github-actions - /actions/concepts/overview/continuous-deployment -contentType: concepts +contentType: get-started category: - Get started with GitHub Actions --- diff --git a/content/actions/get-started/continuous-integration.md b/content/actions/get-started/continuous-integration.md index 559c6a1093b6..4f9a8d9a6d46 100644 --- a/content/actions/get-started/continuous-integration.md +++ b/content/actions/get-started/continuous-integration.md @@ -16,7 +16,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -contentType: concepts +contentType: get-started category: - Get started with GitHub Actions --- diff --git a/content/actions/get-started/index.md b/content/actions/get-started/index.md index 0355f5fd8549..3b6447c285f0 100644 --- a/content/actions/get-started/index.md +++ b/content/actions/get-started/index.md @@ -15,4 +15,6 @@ children: redirect_from: - /actions/about-github-actions - /actions/concepts/overview +contentType: get-started --- + diff --git a/content/actions/get-started/understand-github-actions.md b/content/actions/get-started/understand-github-actions.md index 89d7dd40caf8..4cce521f7c39 100644 --- a/content/actions/get-started/understand-github-actions.md +++ b/content/actions/get-started/understand-github-actions.md @@ -16,7 +16,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -contentType: concepts +contentType: get-started category: - Get started with GitHub Actions --- diff --git a/content/actions/how-tos/administer/index.md b/content/actions/how-tos/administer/index.md index da57186581ce..a04e739c0305 100644 --- a/content/actions/how-tos/administer/index.md +++ b/content/actions/how-tos/administer/index.md @@ -1,7 +1,7 @@ --- title: Administering GitHub Actions shortTitle: Administer -intro: 'Manage {% data variables.product.prodname_actions %} settings for your organization or enterprise.' +intro: Manage {% data variables.product.prodname_actions %} settings for your organization or enterprise. versions: fpt: '*' ghes: '*' @@ -12,4 +12,6 @@ children: redirect_from: - /actions/administering-github-actions - /actions/how-tos/administering-github-actions +contentType: how-tos --- + diff --git a/content/actions/how-tos/administer/view-metrics.md b/content/actions/how-tos/administer/view-metrics.md index 1d0d689c6e1c..b96bbca6caa1 100644 --- a/content/actions/how-tos/administer/view-metrics.md +++ b/content/actions/how-tos/administer/view-metrics.md @@ -1,7 +1,7 @@ --- title: Viewing GitHub Actions metrics shortTitle: View metrics -intro: 'You can view metrics to monitor where your organization or repositories use {% data variables.product.prodname_actions %} and how they are performing.' +intro: You can view metrics to monitor where your organization or repositories use {% data variables.product.prodname_actions %} and how they are performing. permissions: Organization owners and users with the "View organization Actions metrics" permission can view organization-level metrics.

Users with the base repository role can view repository-level metrics. versions: feature: actions-metrics @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/administering-github-actions/viewing-github-actions-metrics category: - Administer GitHub Actions +contentType: how-tos --- ## Viewing {% data variables.product.prodname_actions %} metrics for your organization diff --git a/content/actions/how-tos/create-and-publish-actions/create-a-cli-action.md b/content/actions/how-tos/create-and-publish-actions/create-a-cli-action.md index 9a2cbe1c1a03..183764390295 100644 --- a/content/actions/how-tos/create-and-publish-actions/create-a-cli-action.md +++ b/content/actions/how-tos/create-and-publish-actions/create-a-cli-action.md @@ -1,7 +1,7 @@ --- title: Creating a third party CLI action shortTitle: Create a CLI action -intro: 'Learn how to develop an action to set up a CLI on {% data variables.product.prodname_actions %} runners.' +intro: Learn how to develop an action to set up a CLI on {% data variables.product.prodname_actions %} runners. redirect_from: - /actions/creating-actions/developing-a-third-party-cli-action - /actions/sharing-automations/creating-actions/developing-a-third-party-cli-action @@ -12,6 +12,7 @@ versions: ghec: '*' category: - Reuse and share automations +contentType: how-tos --- ## Introduction diff --git a/content/actions/how-tos/create-and-publish-actions/index.md b/content/actions/how-tos/create-and-publish-actions/index.md index c0819d5fb877..586fe406579b 100644 --- a/content/actions/how-tos/create-and-publish-actions/index.md +++ b/content/actions/how-tos/create-and-publish-actions/index.md @@ -1,7 +1,7 @@ --- title: Creating and publishing actions shortTitle: Create and publish actions -intro: 'You can create your own actions, use and customize actions shared by the {% data variables.product.prodname_dotcom %} community, or write and share the actions you build.' +intro: You can create your own actions, use and customize actions shared by the {% data variables.product.prodname_dotcom %} community, or write and share the actions you build. versions: fpt: '*' ghes: '*' @@ -17,4 +17,6 @@ children: - /publish-in-github-marketplace - /release-and-maintain-actions - /using-immutable-releases-and-tags-to-manage-your-actions-releases +contentType: how-tos --- + diff --git a/content/actions/how-tos/create-and-publish-actions/manage-custom-actions.md b/content/actions/how-tos/create-and-publish-actions/manage-custom-actions.md index 5887de267b4d..1c512f175aad 100644 --- a/content/actions/how-tos/create-and-publish-actions/manage-custom-actions.md +++ b/content/actions/how-tos/create-and-publish-actions/manage-custom-actions.md @@ -9,7 +9,7 @@ versions: redirect_from: - /actions/how-tos/administering-github-actions/managing-custom-actions - /actions/how-tos/creating-and-publishing-actions/managing-custom-actions -contentType: concepts +contentType: how-tos category: - Reuse and share automations --- diff --git a/content/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md b/content/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md index 20534f67d7cf..d34696277176 100644 --- a/content/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md +++ b/content/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md @@ -1,6 +1,6 @@ --- title: Publishing actions in GitHub Marketplace -intro: 'You can publish actions in {% data variables.product.prodname_marketplace %} and share actions you''ve created with the {% data variables.product.prodname_dotcom %} community.' +intro: You can publish actions in {% data variables.product.prodname_marketplace %} and share actions you've created with the {% data variables.product.prodname_dotcom %} community. redirect_from: - /github/automating-your-workflow-with-github-actions/publishing-actions-in-github-marketplace - /actions/automating-your-workflow-with-github-actions/publishing-actions-in-github-marketplace @@ -15,6 +15,7 @@ versions: shortTitle: Publish in GitHub Marketplace category: - Reuse and share automations +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md b/content/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md index bb9491f7e601..a2b3d67b232a 100644 --- a/content/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md +++ b/content/actions/how-tos/create-and-publish-actions/release-and-maintain-actions.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/creating-and-publishing-actions/releasing-and-maintaining-actions category: - Reuse and share automations +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/create-and-publish-actions/set-exit-codes.md b/content/actions/how-tos/create-and-publish-actions/set-exit-codes.md index 882c9486e5b3..41c26d756308 100644 --- a/content/actions/how-tos/create-and-publish-actions/set-exit-codes.md +++ b/content/actions/how-tos/create-and-publish-actions/set-exit-codes.md @@ -1,7 +1,7 @@ --- title: Setting exit codes for actions shortTitle: Set exit codes -intro: 'You can use exit codes to set the status of an action. {% data variables.product.prodname_dotcom %} displays statuses to indicate passing or failing actions.' +intro: You can use exit codes to set the status of an action. {% data variables.product.prodname_dotcom %} displays statuses to indicate passing or failing actions. redirect_from: - /actions/building-actions/setting-exit-codes-for-actions - /actions/creating-actions/setting-exit-codes-for-actions @@ -14,6 +14,7 @@ versions: ghec: '*' category: - Reuse and share automations +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases.md b/content/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases.md index d8ab5d0bfa1f..88c4891ebb0c 100644 --- a/content/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases.md +++ b/content/actions/how-tos/create-and-publish-actions/using-immutable-releases-and-tags-to-manage-your-actions-releases.md @@ -1,11 +1,12 @@ --- title: Using immutable releases and tags to manage your action's releases shortTitle: Use immutable releases -intro: 'Learn how you can use a combination of immutable releases on {% data variables.product.github %} and Git tags to manage your action''s releases.' +intro: Learn how you can use a combination of immutable releases on {% data variables.product.github %} and Git tags to manage your action's releases. versions: feature: immutable-releases category: - Reuse and share automations +contentType: how-tos --- If you enable immutable releases on your action's repository, you can manage your action's releases as follows: diff --git a/content/actions/how-tos/deploy/configure-and-manage-deployments/configure-custom-protection-rules.md b/content/actions/how-tos/deploy/configure-and-manage-deployments/configure-custom-protection-rules.md index 07ca7fe1bd4b..42df17d53cd1 100644 --- a/content/actions/how-tos/deploy/configure-and-manage-deployments/configure-custom-protection-rules.md +++ b/content/actions/how-tos/deploy/configure-and-manage-deployments/configure-custom-protection-rules.md @@ -1,7 +1,7 @@ --- title: Configuring custom deployment protection rules shortTitle: Configure custom protection rules -intro: 'Use {% data variables.product.prodname_github_apps %} to automate protecting deployments with third-party systems.' +intro: Use {% data variables.product.prodname_github_apps %} to automate protecting deployments with third-party systems. product: '{% data reusables.actions.custom-deployment-protection-rules-availability %}' versions: fpt: '*' @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-deployments/configuring-custom-deployment-protection-rules category: - Deploy to environments +contentType: how-tos --- {% data reusables.actions.custom-deployment-protection-rules-beta-note %} diff --git a/content/actions/how-tos/deploy/configure-and-manage-deployments/control-deployments.md b/content/actions/how-tos/deploy/configure-and-manage-deployments/control-deployments.md index 890877cdc516..9f01109ce90e 100644 --- a/content/actions/how-tos/deploy/configure-and-manage-deployments/control-deployments.md +++ b/content/actions/how-tos/deploy/configure-and-manage-deployments/control-deployments.md @@ -12,7 +12,7 @@ redirect_from: - /actions/use-cases-and-examples/deploying/deploying-with-github-actions - /actions/concepts/use-cases/deploying-with-github-actions - /actions/tutorials/deploying-with-github-actions -contentType: concepts +contentType: how-tos category: - Deploy to environments --- diff --git a/content/actions/how-tos/deploy/configure-and-manage-deployments/create-custom-protection-rules.md b/content/actions/how-tos/deploy/configure-and-manage-deployments/create-custom-protection-rules.md index 37225acbd187..16a26f88b5c0 100644 --- a/content/actions/how-tos/deploy/configure-and-manage-deployments/create-custom-protection-rules.md +++ b/content/actions/how-tos/deploy/configure-and-manage-deployments/create-custom-protection-rules.md @@ -1,7 +1,7 @@ --- title: Creating custom deployment protection rules shortTitle: Create custom protection rules -intro: 'Use {% data variables.product.prodname_github_apps %} to automate protecting deployments with third-party systems.' +intro: Use {% data variables.product.prodname_github_apps %} to automate protecting deployments with third-party systems. product: '{% data reusables.actions.custom-deployment-protection-rules-availability %}' versions: fpt: '*' @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/configure-and-manage-deployments/index.md b/content/actions/how-tos/deploy/configure-and-manage-deployments/index.md index 7652fd531827..01c9d8f7a795 100644 --- a/content/actions/how-tos/deploy/configure-and-manage-deployments/index.md +++ b/content/actions/how-tos/deploy/configure-and-manage-deployments/index.md @@ -18,4 +18,6 @@ children: - /review-deployments - /create-custom-protection-rules - /configure-custom-protection-rules +contentType: how-tos --- + diff --git a/content/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments.md b/content/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments.md index 8c89ed5bbd53..30b0e880a5d8 100644 --- a/content/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments.md +++ b/content/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments.md @@ -21,6 +21,7 @@ versions: ghec: '*' category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments.md b/content/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments.md index 57212581f96c..bd51d9d48e17 100644 --- a/content/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments.md +++ b/content/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-deployments/reviewing-deployments category: - Deploy to environments +contentType: how-tos --- ## Approving or rejecting a job diff --git a/content/actions/how-tos/deploy/configure-and-manage-deployments/view-deployment-history.md b/content/actions/how-tos/deploy/configure-and-manage-deployments/view-deployment-history.md index f511161416f6..12f2c8c463a7 100644 --- a/content/actions/how-tos/deploy/configure-and-manage-deployments/view-deployment-history.md +++ b/content/actions/how-tos/deploy/configure-and-manage-deployments/view-deployment-history.md @@ -14,6 +14,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-deployments/viewing-deployment-history category: - Deploy to environments +contentType: how-tos --- ## Viewing your repository's deployment history diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/amazon-elastic-container-service.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/amazon-elastic-container-service.md index bc042b052600..540b3cd81f2a 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/amazon-elastic-container-service.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/amazon-elastic-container-service.md @@ -15,6 +15,7 @@ versions: ghec: '*' category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-kubernetes-service.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-kubernetes-service.md index b9847788bb33..c853a6d6e655 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-kubernetes-service.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-kubernetes-service.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/deploying-to-third-party-platforms/deploying-to-azure-kubernetes-service category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-static-web-app.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-static-web-app.md index 518b9b15a023..85c2c94f8a08 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-static-web-app.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-static-web-app.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/deploying-to-third-party-platforms/deploying-to-azure-static-web-app category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/docker-to-azure-app-service.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/docker-to-azure-app-service.md index b30b2b44589b..fe9c70581b6c 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/docker-to-azure-app-service.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/docker-to-azure-app-service.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/deploying-to-third-party-platforms/deploying-docker-to-azure-app-service category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/google-kubernetes-engine.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/google-kubernetes-engine.md index 5d0c9828dc8a..b2c14e777cf1 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/google-kubernetes-engine.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/google-kubernetes-engine.md @@ -13,7 +13,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -contentType: tutorials +contentType: how-tos category: - Deploy to environments --- diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/index.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/index.md index 69a9cb38bd29..4298af7f19a6 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/index.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/index.md @@ -25,4 +25,6 @@ children: - /amazon-elastic-container-service - /google-kubernetes-engine - /sign-xcode-applications +contentType: how-tos --- + diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/java-to-azure-app-service.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/java-to-azure-app-service.md index 46f164a43cd3..041616ef73ee 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/java-to-azure-app-service.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/java-to-azure-app-service.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/deploying-to-third-party-platforms/deploying-java-to-azure-app-service category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/net-to-azure-app-service.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/net-to-azure-app-service.md index e66181f85395..47abd296b8f7 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/net-to-azure-app-service.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/net-to-azure-app-service.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/deploying-to-third-party-platforms/deploying-net-to-azure-app-service category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/nodejs-to-azure-app-service.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/nodejs-to-azure-app-service.md index deaa277575d8..0b1b12066196 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/nodejs-to-azure-app-service.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/nodejs-to-azure-app-service.md @@ -16,6 +16,7 @@ versions: ghec: '*' category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/php-to-azure-app-service.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/php-to-azure-app-service.md index 9a23ff237f2e..7b655f351d0a 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/php-to-azure-app-service.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/php-to-azure-app-service.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/deploying-to-third-party-platforms/deploying-php-to-azure-app-service category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/python-to-azure-app-service.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/python-to-azure-app-service.md index 67ecbf96a490..7c8740d5df5d 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/python-to-azure-app-service.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/python-to-azure-app-service.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/deploying-to-third-party-platforms/deploying-python-to-azure-app-service category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/sign-xcode-applications.md b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/sign-xcode-applications.md index 395d756ccb89..e96c57798b74 100644 --- a/content/actions/how-tos/deploy/deploy-to-third-party-platforms/sign-xcode-applications.md +++ b/content/actions/how-tos/deploy/deploy-to-third-party-platforms/sign-xcode-applications.md @@ -1,7 +1,7 @@ --- title: Installing an Apple certificate on macOS runners for Xcode development shortTitle: Sign Xcode applications -intro: 'Learn how to sign Xcode apps within a continuous integration (CI) workflow by installing an Apple code signing certificate on {% data variables.product.prodname_actions %} runners.' +intro: Learn how to sign Xcode apps within a continuous integration (CI) workflow by installing an Apple code signing certificate on {% data variables.product.prodname_actions %} runners. redirect_from: - /actions/guides/installing-an-apple-certificate-on-macos-runners-for-xcode-development - /actions/deployment/installing-an-apple-certificate-on-macos-runners-for-xcode-development @@ -16,6 +16,7 @@ versions: ghec: '*' category: - Deploy to environments +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/deploy/index.md b/content/actions/how-tos/deploy/index.md index aae68814f30d..f8b62a515bc7 100644 --- a/content/actions/how-tos/deploy/index.md +++ b/content/actions/how-tos/deploy/index.md @@ -9,4 +9,6 @@ versions: children: - /configure-and-manage-deployments - /deploy-to-third-party-platforms +contentType: how-tos --- + diff --git a/content/actions/how-tos/get-support.md b/content/actions/how-tos/get-support.md index 236626068ed7..0e12d74f2b42 100644 --- a/content/actions/how-tos/get-support.md +++ b/content/actions/how-tos/get-support.md @@ -11,7 +11,7 @@ redirect_from: - /actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/working-with-support-for-github-actions - /actions/how-tos/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/working-with-support-for-github-actions - /actions/how-tos/getting-help-from-github-support-about-github-actions -contentType: reference +contentType: how-tos category: - Administer GitHub Actions --- diff --git a/content/actions/how-tos/index.md b/content/actions/how-tos/index.md index cc4728a8beba..3e3544714154 100644 --- a/content/actions/how-tos/index.md +++ b/content/actions/how-tos/index.md @@ -20,4 +20,6 @@ children: - /get-support redirect_from: - /actions/monitoring-and-troubleshooting-workflows +contentType: how-tos --- + diff --git a/content/actions/how-tos/manage-runners/github-hosted-runners/connect-to-a-private-network/index.md b/content/actions/how-tos/manage-runners/github-hosted-runners/connect-to-a-private-network/index.md index a7c910ff40f4..e05ae281857b 100644 --- a/content/actions/how-tos/manage-runners/github-hosted-runners/connect-to-a-private-network/index.md +++ b/content/actions/how-tos/manage-runners/github-hosted-runners/connect-to-a-private-network/index.md @@ -1,5 +1,5 @@ --- -title: 'Connecting to a private network with {% data variables.product.company_short %}-hosted runners' +title: Connecting to a private network with {% data variables.product.company_short %}-hosted runners shortTitle: Connect to a private network intro: '{% data reusables.actions.private-networking-intro %}' versions: @@ -12,6 +12,7 @@ children: redirect_from: - /actions/using-github-hosted-runners/connecting-to-a-private-network - /actions/how-tos/using-github-hosted-runners/connecting-to-a-private-network +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/github-hosted-runners/customize-runners.md b/content/actions/how-tos/manage-runners/github-hosted-runners/customize-runners.md index 603a4c8ded5f..10f99f0aff9d 100644 --- a/content/actions/how-tos/manage-runners/github-hosted-runners/customize-runners.md +++ b/content/actions/how-tos/manage-runners/github-hosted-runners/customize-runners.md @@ -12,7 +12,7 @@ redirect_from: - /actions/using-github-hosted-runners/using-github-hosted-runners/customizing-github-hosted-runners - /actions/how-tos/using-github-hosted-runners/using-github-hosted-runners/customizing-github-hosted-runners - /actions/how-tos/using-github-hosted-runners/customizing-github-hosted-runners -contentType: tutorials +contentType: how-tos category: - Set up runners --- diff --git a/content/actions/how-tos/manage-runners/github-hosted-runners/index.md b/content/actions/how-tos/manage-runners/github-hosted-runners/index.md index 2826b36cc8ba..9ff875e63229 100644 --- a/content/actions/how-tos/manage-runners/github-hosted-runners/index.md +++ b/content/actions/how-tos/manage-runners/github-hosted-runners/index.md @@ -14,6 +14,7 @@ children: redirect_from: - /actions/using-github-hosted-runners - /actions/how-tos/using-github-hosted-runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/github-hosted-runners/use-github-hosted-runners.md b/content/actions/how-tos/manage-runners/github-hosted-runners/use-github-hosted-runners.md index 0e23d578de1c..329a1bc0bb62 100644 --- a/content/actions/how-tos/manage-runners/github-hosted-runners/use-github-hosted-runners.md +++ b/content/actions/how-tos/manage-runners/github-hosted-runners/use-github-hosted-runners.md @@ -1,7 +1,7 @@ --- title: Using GitHub-hosted runners shortTitle: Use GitHub-hosted runners -intro: 'You can assign a job to run on a virtual machine hosted by {% data variables.product.github %}.' +intro: You can assign a job to run on a virtual machine hosted by {% data variables.product.github %}. versions: fpt: '*' ghes: '*' @@ -11,6 +11,7 @@ redirect_from: - /actions/using-github-hosted-runners/using-github-hosted-runners category: - Use and manage runners +contentType: how-tos --- {% ifversion ghes %} diff --git a/content/actions/how-tos/manage-runners/github-hosted-runners/view-current-jobs.md b/content/actions/how-tos/manage-runners/github-hosted-runners/view-current-jobs.md index 3c106380fa7d..38eb09a41f94 100644 --- a/content/actions/how-tos/manage-runners/github-hosted-runners/view-current-jobs.md +++ b/content/actions/how-tos/manage-runners/github-hosted-runners/view-current-jobs.md @@ -1,7 +1,7 @@ --- title: Viewing your current jobs shortTitle: View current jobs -intro: 'Monitor how {% data variables.product.prodname_dotcom %}-hosted runners are processing jobs in your organization or enterprise, and identify any related constraints.' +intro: Monitor how {% data variables.product.prodname_dotcom %}-hosted runners are processing jobs in your organization or enterprise, and identify any related constraints. versions: feature: github-runner-dashboard redirect_from: @@ -14,6 +14,7 @@ redirect_from: - /actions/how-tos/using-github-hosted-runners/viewing-your-current-jobs category: - Use and manage runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/index.md b/content/actions/how-tos/manage-runners/index.md index 70cd95c6b8b0..19036b1700b9 100644 --- a/content/actions/how-tos/manage-runners/index.md +++ b/content/actions/how-tos/manage-runners/index.md @@ -10,5 +10,6 @@ children: - /self-hosted-runners - /larger-runners - /use-proxy-servers +contentType: how-tos --- diff --git a/content/actions/how-tos/manage-runners/larger-runners/control-access.md b/content/actions/how-tos/manage-runners/larger-runners/control-access.md index ffc435f67d89..28d4b9a70177 100644 --- a/content/actions/how-tos/manage-runners/larger-runners/control-access.md +++ b/content/actions/how-tos/manage-runners/larger-runners/control-access.md @@ -11,7 +11,7 @@ redirect_from: - /actions/using-github-hosted-runners/using-larger-runners/controlling-access-to-larger-runners - /actions/how-tos/using-github-hosted-runners/using-larger-runners/controlling-access-to-larger-runners - /actions/how-tos/using-larger-runners/controlling-access-to-larger-runners -contentType: tutorials +contentType: how-tos category: - Use and manage runners --- diff --git a/content/actions/how-tos/manage-runners/larger-runners/index.md b/content/actions/how-tos/manage-runners/larger-runners/index.md index 4818c521ec3a..eb15a5098031 100644 --- a/content/actions/how-tos/manage-runners/larger-runners/index.md +++ b/content/actions/how-tos/manage-runners/larger-runners/index.md @@ -14,6 +14,7 @@ redirect_from: - /actions/using-github-hosted-runners/using-larger-runners - /actions/how-tos/using-github-hosted-runners/using-larger-runners - /actions/how-tos/using-larger-runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/larger-runners/manage-larger-runners.md b/content/actions/how-tos/manage-runners/larger-runners/manage-larger-runners.md index 516d028e0de2..a29c6a4cacbe 100644 --- a/content/actions/how-tos/manage-runners/larger-runners/manage-larger-runners.md +++ b/content/actions/how-tos/manage-runners/larger-runners/manage-larger-runners.md @@ -1,9 +1,9 @@ --- title: Managing larger runners shortTitle: Manage larger runners -intro: 'You can configure {% data variables.actions.hosted_runner %}s for your organization or enterprise.' +intro: You can configure {% data variables.actions.hosted_runner %}s for your organization or enterprise. product: '{% data variables.actions.github_hosted_larger_runners %} are only available for organizations and enterprises using the {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plans.
Sign up for {% data variables.product.prodname_actions %} {% octicon "link-external" height:16 %}' -permissions: 'Enterprise or organization owners can manage larger runners.{% ifversion custom-org-roles %} Users with the "Manage organization runners and runner groups" permission can manage larger runners at the organization level.{% endif %}' +permissions: Enterprise or organization owners can manage larger runners.{% ifversion custom-org-roles %} Users with the "Manage organization runners and runner groups" permission can manage larger runners at the organization level.{% endif %} versions: feature: actions-hosted-runners redirect_from: @@ -14,6 +14,7 @@ redirect_from: - /actions/how-tos/using-larger-runners/managing-larger-runners category: - Set up runners +contentType: how-tos --- > [!NOTE] diff --git a/content/actions/how-tos/manage-runners/larger-runners/use-custom-images.md b/content/actions/how-tos/manage-runners/larger-runners/use-custom-images.md index f16977ed057f..fbf048584084 100644 --- a/content/actions/how-tos/manage-runners/larger-runners/use-custom-images.md +++ b/content/actions/how-tos/manage-runners/larger-runners/use-custom-images.md @@ -1,13 +1,13 @@ --- title: Using custom images shortTitle: Use custom images -intro: 'Create, manage, and use custom images for {% data variables.actions.github_hosted_larger_runners %} in your organization or enterprise.' +intro: Create, manage, and use custom images for {% data variables.actions.github_hosted_larger_runners %} in your organization or enterprise. versions: feature: actions-hosted-runners product: '{% data variables.actions.github_hosted_larger_runners %} are only available for organizations and enterprises using the {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plans.
Sign up for {% data variables.product.prodname_actions %} {% octicon "link-external" height:16 %}' - category: - Set up runners +contentType: how-tos --- {% data reusables.actions.custom-images-public-preview-note %} diff --git a/content/actions/how-tos/manage-runners/larger-runners/use-larger-runners.md b/content/actions/how-tos/manage-runners/larger-runners/use-larger-runners.md index 92f0fbd93afa..11390c91f365 100644 --- a/content/actions/how-tos/manage-runners/larger-runners/use-larger-runners.md +++ b/content/actions/how-tos/manage-runners/larger-runners/use-larger-runners.md @@ -1,7 +1,7 @@ --- title: Running jobs on larger runners shortTitle: Use larger runners -intro: 'You can speed up your workflows by configuring them to run on {% data variables.actions.hosted_runner %}s.' +intro: You can speed up your workflows by configuring them to run on {% data variables.actions.hosted_runner %}s. permissions: '{% data reusables.actions.larger-runner-permissions %}' defaultPlatform: linux versions: @@ -14,6 +14,7 @@ redirect_from: - /actions/how-tos/using-larger-runners/running-jobs-on-larger-runners category: - Use and manage runners +contentType: how-tos --- ## Running jobs on your runner diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/add-runners.md b/content/actions/how-tos/manage-runners/self-hosted-runners/add-runners.md index 101350a2922d..1948dee80f21 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/add-runners.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/add-runners.md @@ -1,7 +1,7 @@ --- title: Adding self-hosted runners shortTitle: Add runners -intro: 'You can add a self-hosted runner to a repository, an organization, or an enterprise.' +intro: You can add a self-hosted runner to a repository, an organization, or an enterprise. redirect_from: - /github/automating-your-workflow-with-github-actions/adding-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/adding-self-hosted-runners @@ -15,6 +15,7 @@ versions: ghec: '*' category: - Set up runners +contentType: how-tos --- > [!WARNING] diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/apply-labels.md b/content/actions/how-tos/manage-runners/self-hosted-runners/apply-labels.md index 937423d2666d..bf917f4d7135 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/apply-labels.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/apply-labels.md @@ -13,6 +13,7 @@ versions: ghec: '*' category: - Use and manage runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application.md b/content/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application.md index 7766749f54d5..9b1ee70381fe 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application.md @@ -15,6 +15,7 @@ versions: defaultPlatform: linux category: - Set up runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/customize-containers.md b/content/actions/how-tos/manage-runners/self-hosted-runners/customize-containers.md index eec0e0308213..80039df90b46 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/customize-containers.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/customize-containers.md @@ -11,6 +11,7 @@ versions: feature: container-hooks category: - Use and manage runners +contentType: how-tos --- > [!NOTE] diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/index.md b/content/actions/how-tos/manage-runners/self-hosted-runners/index.md index dfbedbc82492..9eee79db2cab 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/index.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/index.md @@ -22,6 +22,7 @@ redirect_from: - /actions/how-tos/managing-self-hosted-runners - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners - /github/automating-your-workflow-with-github-actions/hosting-your-own-runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/manage-access.md b/content/actions/how-tos/manage-runners/self-hosted-runners/manage-access.md index c896dd07c7b6..a4014197c326 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/manage-access.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/manage-access.md @@ -1,8 +1,8 @@ --- title: Managing access to self-hosted runners using groups shortTitle: Manage access -intro: 'You can use policies to limit access to self-hosted runners that have been added to an organization{% ifversion ghec or ghes %} or enterprise{% endif %}.' -permissions: 'Enterprise accounts, organizations owned by enterprise accounts, and organizations using {% data variables.product.prodname_team %} or {% data variables.product.prodname_free_user %} plans can create and manage additional runner groups using self-hosted runners.

{% ifversion custom-org-roles %}Users with the "Manage organization runners and runner groups" permission can manage runner groups at the organization level.{% endif %}' +intro: You can use policies to limit access to self-hosted runners that have been added to an organization{% ifversion ghec or ghes %} or enterprise{% endif %}. +permissions: Enterprise accounts, organizations owned by enterprise accounts, and organizations using {% data variables.product.prodname_team %} or {% data variables.product.prodname_free_user %} plans can create and manage additional runner groups using self-hosted runners.

{% ifversion custom-org-roles %}Users with the "Manage organization runners and runner groups" permission can manage runner groups at the organization level.{% endif %} redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners - /actions/hosting-your-own-runners/managing-access-to-self-hosted-runners @@ -16,6 +16,7 @@ versions: ghec: '*' category: - Use and manage runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot.md b/content/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot.md index 8f57d570e066..ebb80d22a37f 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot.md @@ -17,6 +17,7 @@ versions: defaultPlatform: linux category: - Use and manage runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/remove-runners.md b/content/actions/how-tos/manage-runners/self-hosted-runners/remove-runners.md index f95ff5190e31..7874bc592eca 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/remove-runners.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/remove-runners.md @@ -1,7 +1,7 @@ --- title: Removing self-hosted runners shortTitle: Remove runners -intro: 'You can permanently remove a self-hosted runner from a repository{% ifversion fpt %} or organization{% elsif ghec or ghes %}, an organization, or an enterprise{% endif %}.' +intro: You can permanently remove a self-hosted runner from a repository{% ifversion fpt %} or organization{% elsif ghec or ghes %}, an organization, or an enterprise{% endif %}. redirect_from: - /github/automating-your-workflow-with-github-actions/removing-self-hosted-runners - /actions/automating-your-workflow-with-github-actions/removing-self-hosted-runners @@ -15,6 +15,7 @@ versions: ghec: '*' category: - Use and manage runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/run-scripts.md b/content/actions/how-tos/manage-runners/self-hosted-runners/run-scripts.md index 04df2c9ccb48..2e9f8dc917be 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/run-scripts.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/run-scripts.md @@ -1,7 +1,7 @@ --- title: Running scripts before or after a job shortTitle: Run scripts -intro: 'Scripts can automatically execute on a self-hosted runner, directly before or after a job.' +intro: Scripts can automatically execute on a self-hosted runner, directly before or after a job. redirect_from: - /actions/hosting-your-own-runners/running-scripts-before-or-after-a-job - /actions/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job @@ -13,6 +13,7 @@ versions: ghec: '*' category: - Use and manage runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-runners/self-hosted-runners/use-in-a-workflow.md b/content/actions/how-tos/manage-runners/self-hosted-runners/use-in-a-workflow.md index 7579955d9a9f..484172ad7fe4 100644 --- a/content/actions/how-tos/manage-runners/self-hosted-runners/use-in-a-workflow.md +++ b/content/actions/how-tos/manage-runners/self-hosted-runners/use-in-a-workflow.md @@ -1,7 +1,7 @@ --- title: Using self-hosted runners in a workflow shortTitle: Use in a workflow -intro: 'To use self-hosted runners in a workflow, you can use labels or groups to specify the runner for a job.' +intro: To use self-hosted runners in a workflow, you can use labels or groups to specify the runner for a job. redirect_from: - /github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow - /actions/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow @@ -15,6 +15,7 @@ versions: ghec: '*' category: - Use and manage runners +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-workflow-runs/approve-runs-from-forks.md b/content/actions/how-tos/manage-workflow-runs/approve-runs-from-forks.md index a2088fa0e7e0..b48ef31c1e61 100644 --- a/content/actions/how-tos/manage-workflow-runs/approve-runs-from-forks.md +++ b/content/actions/how-tos/manage-workflow-runs/approve-runs-from-forks.md @@ -16,6 +16,7 @@ redirect_from: - /actions/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-private-forks category: - Manage and monitor workflow runs +contentType: how-tos --- Workflow runs triggered by a contributor's pull request from a fork may require manual approval from a maintainer with write access. You can configure workflow approval requirements for a [repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-required-approval-for-workflows-from-public-forks), [organization](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#configuring-required-approval-for-workflows-from-public-forks), or [enterprise](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-fork-pull-requests-in-your-enterprise). diff --git a/content/actions/how-tos/manage-workflow-runs/cancel-a-workflow-run.md b/content/actions/how-tos/manage-workflow-runs/cancel-a-workflow-run.md index 7c8869f18cc5..b26a3036c282 100644 --- a/content/actions/how-tos/manage-workflow-runs/cancel-a-workflow-run.md +++ b/content/actions/how-tos/manage-workflow-runs/cancel-a-workflow-run.md @@ -1,7 +1,7 @@ --- title: Canceling a workflow run shortTitle: Cancel a workflow run -intro: 'You can cancel a workflow run, including all jobs and steps, that is in progress.' +intro: You can cancel a workflow run, including all jobs and steps, that is in progress. versions: fpt: '*' ghes: '*' @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/canceling-a-workflow category: - Manage and monitor workflow runs +contentType: how-tos --- ## Canceling a workflow run diff --git a/content/actions/how-tos/manage-workflow-runs/delete-a-workflow-run.md b/content/actions/how-tos/manage-workflow-runs/delete-a-workflow-run.md index 9477a49deae1..4f7794705c1f 100644 --- a/content/actions/how-tos/manage-workflow-runs/delete-a-workflow-run.md +++ b/content/actions/how-tos/manage-workflow-runs/delete-a-workflow-run.md @@ -1,7 +1,7 @@ --- title: Deleting a workflow run shortTitle: Delete a workflow run -intro: 'You can delete a workflow run that has been completed, or is more than two weeks old.' +intro: You can delete a workflow run that has been completed, or is more than two weeks old. versions: fpt: '*' ghes: '*' @@ -12,6 +12,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/deleting-a-workflow-run category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-workflow-runs/disable-and-enable-workflows.md b/content/actions/how-tos/manage-workflow-runs/disable-and-enable-workflows.md index 6ee29713bfb6..212ddde63425 100644 --- a/content/actions/how-tos/manage-workflow-runs/disable-and-enable-workflows.md +++ b/content/actions/how-tos/manage-workflow-runs/disable-and-enable-workflows.md @@ -1,6 +1,6 @@ --- title: Disabling and enabling a workflow -intro: 'You can disable and re-enable a workflow using the {% data variables.product.prodname_dotcom %} UI, the REST API, or {% data variables.product.prodname_cli %}.' +intro: You can disable and re-enable a workflow using the {% data variables.product.prodname_dotcom %} UI, the REST API, or {% data variables.product.prodname_cli %}. versions: fpt: '*' ghes: '*' @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-workflow-runs/download-workflow-artifacts.md b/content/actions/how-tos/manage-workflow-runs/download-workflow-artifacts.md index 58827d4dab41..26506226c3ea 100644 --- a/content/actions/how-tos/manage-workflow-runs/download-workflow-artifacts.md +++ b/content/actions/how-tos/manage-workflow-runs/download-workflow-artifacts.md @@ -1,7 +1,7 @@ --- title: Downloading workflow artifacts intro: You can download archived artifacts before they automatically expire. -permissions: 'People who are signed into {% data variables.product.github %} and have read access to a repository can download workflow artifacts.' +permissions: People who are signed into {% data variables.product.github %} and have read access to a repository can download workflow artifacts. versions: fpt: '*' ghes: '*' @@ -14,6 +14,7 @@ redirect_from: - /actions/how-tos/manage-workflow-runs/downloading-workflow-artifacts category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-workflow-runs/index.md b/content/actions/how-tos/manage-workflow-runs/index.md index 7e2041373eff..7be810c522ea 100644 --- a/content/actions/how-tos/manage-workflow-runs/index.md +++ b/content/actions/how-tos/manage-workflow-runs/index.md @@ -28,4 +28,6 @@ redirect_from: - /actions/managing-workflow-runs-and-deployments - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs - /actions/how-tos/managing-workflow-runs-and-deployments +contentType: how-tos --- + diff --git a/content/actions/how-tos/manage-workflow-runs/manage-caches.md b/content/actions/how-tos/manage-workflow-runs/manage-caches.md index d68843a7bb19..6a90985aaa85 100644 --- a/content/actions/how-tos/manage-workflow-runs/manage-caches.md +++ b/content/actions/how-tos/manage-workflow-runs/manage-caches.md @@ -1,6 +1,6 @@ --- title: Managing caches -intro: 'You can monitor, filter, and delete dependency caches created from your workflows.' +intro: You can monitor, filter, and delete dependency caches created from your workflows. versions: fpt: '*' ghes: '*' @@ -11,6 +11,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/manage-caches category: - Manage and monitor workflow runs +contentType: how-tos --- This article describes managing caches with the {% data variables.product.prodname_dotcom %} web interface, but you can also manage them: diff --git a/content/actions/how-tos/manage-workflow-runs/manually-run-a-workflow.md b/content/actions/how-tos/manage-workflow-runs/manually-run-a-workflow.md index d70a51be9e3e..f277b331375c 100644 --- a/content/actions/how-tos/manage-workflow-runs/manually-run-a-workflow.md +++ b/content/actions/how-tos/manage-workflow-runs/manually-run-a-workflow.md @@ -1,6 +1,6 @@ --- title: Manually running a workflow -intro: 'When a workflow is configured to run on the `workflow_dispatch` event, you can run the workflow using the Actions tab on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_cli %}, or the REST API.' +intro: When a workflow is configured to run on the `workflow_dispatch` event, you can run the workflow using the Actions tab on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_cli %}, or the REST API. versions: fpt: '*' ghes: '*' @@ -14,6 +14,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs.md b/content/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs.md index f905381d0a72..a75c4110c605 100644 --- a/content/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs.md +++ b/content/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs.md @@ -1,7 +1,7 @@ --- title: Re-running workflows and jobs shortTitle: Re-run workflows and jobs -intro: 'You can re-run a workflow run, all failed jobs in a workflow run, or specific jobs in a workflow run up to 30 days after its initial run.' +intro: You can re-run a workflow run, all failed jobs in a workflow run, or specific jobs in a workflow run up to 30 days after its initial run. permissions: People with write permissions to a repository can re-run workflows in the repository. redirect_from: - /actions/managing-workflow-runs/re-running-a-workflow @@ -14,6 +14,7 @@ versions: ghec: '*' category: - Manage and monitor workflow runs +contentType: how-tos --- > [!NOTE] diff --git a/content/actions/how-tos/manage-workflow-runs/remove-workflow-artifacts.md b/content/actions/how-tos/manage-workflow-runs/remove-workflow-artifacts.md index 63d4268c34b4..d0a17be1e23b 100644 --- a/content/actions/how-tos/manage-workflow-runs/remove-workflow-artifacts.md +++ b/content/actions/how-tos/manage-workflow-runs/remove-workflow-artifacts.md @@ -1,6 +1,6 @@ --- title: Removing workflow artifacts -intro: 'You can reclaim used {% data variables.product.prodname_actions %} storage by deleting artifacts before they expire on {% data variables.product.github %}.' +intro: You can reclaim used {% data variables.product.prodname_actions %} storage by deleting artifacts before they expire on {% data variables.product.github %}. versions: fpt: '*' ghes: '*' @@ -12,6 +12,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/removing-workflow-artifacts category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/manage-workflow-runs/skip-workflow-runs.md b/content/actions/how-tos/manage-workflow-runs/skip-workflow-runs.md index 081f74cf28fa..fdb11f620ccb 100644 --- a/content/actions/how-tos/manage-workflow-runs/skip-workflow-runs.md +++ b/content/actions/how-tos/manage-workflow-runs/skip-workflow-runs.md @@ -12,6 +12,7 @@ redirect_from: - /actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/skipping-workflow-runs category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/monitor-workflows/add-a-status-badge.md b/content/actions/how-tos/monitor-workflows/add-a-status-badge.md index a90c10ee4066..f2d0360d8959 100644 --- a/content/actions/how-tos/monitor-workflows/add-a-status-badge.md +++ b/content/actions/how-tos/monitor-workflows/add-a-status-badge.md @@ -14,6 +14,7 @@ versions: ghec: '*' category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/monitor-workflows/enable-debug-logging.md b/content/actions/how-tos/monitor-workflows/enable-debug-logging.md index 4eed2068c444..bfde82cb51ba 100644 --- a/content/actions/how-tos/monitor-workflows/enable-debug-logging.md +++ b/content/actions/how-tos/monitor-workflows/enable-debug-logging.md @@ -1,7 +1,7 @@ --- title: Enabling debug logging shortTitle: Enable debug logging -intro: 'If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging.' +intro: If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging. redirect_from: - /actions/managing-workflow-runs/enabling-debug-logging - /actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging @@ -14,6 +14,7 @@ versions: ghec: '*' category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/monitor-workflows/index.md b/content/actions/how-tos/monitor-workflows/index.md index 557de7868aab..6f85e5e21c6a 100644 --- a/content/actions/how-tos/monitor-workflows/index.md +++ b/content/actions/how-tos/monitor-workflows/index.md @@ -1,6 +1,6 @@ --- title: Monitor workflows -intro: 'You can monitor {% data variables.product.prodname_actions %} workflows by using tools like the visualization graph and run logs.' +intro: You can monitor {% data variables.product.prodname_actions %} workflows by using tools like the visualization graph and run logs. versions: fpt: '*' ghes: '*' @@ -19,5 +19,6 @@ redirect_from: - /actions/how-tos/monitoring-and-troubleshooting-workflows - /actions/monitoring-and-troubleshooting-workflows/about-monitoring-and-troubleshooting - /actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/about-monitoring-workflows +contentType: how-tos --- diff --git a/content/actions/how-tos/monitor-workflows/use-the-visualization-graph.md b/content/actions/how-tos/monitor-workflows/use-the-visualization-graph.md index 17d1452fe887..932b5ebfa33f 100644 --- a/content/actions/how-tos/monitor-workflows/use-the-visualization-graph.md +++ b/content/actions/how-tos/monitor-workflows/use-the-visualization-graph.md @@ -14,6 +14,7 @@ versions: ghec: '*' category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/monitor-workflows/use-workflow-run-logs.md b/content/actions/how-tos/monitor-workflows/use-workflow-run-logs.md index bfcf8ca2b3c9..fdcb4e2a2003 100644 --- a/content/actions/how-tos/monitor-workflows/use-workflow-run-logs.md +++ b/content/actions/how-tos/monitor-workflows/use-workflow-run-logs.md @@ -1,7 +1,7 @@ --- title: Using workflow run logs shortTitle: Use workflow run logs -intro: 'You can view, search, and download the logs for each job in a workflow run.' +intro: You can view, search, and download the logs for each job in a workflow run. redirect_from: - /actions/managing-workflow-runs/using-workflow-run-logs - /actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs @@ -14,6 +14,7 @@ versions: ghec: '*' category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/monitor-workflows/view-job-execution-time.md b/content/actions/how-tos/monitor-workflows/view-job-execution-time.md index f34eb1a369a2..fc7477d4a282 100644 --- a/content/actions/how-tos/monitor-workflows/view-job-execution-time.md +++ b/content/actions/how-tos/monitor-workflows/view-job-execution-time.md @@ -1,7 +1,7 @@ --- title: Viewing job execution time shortTitle: View job execution time -intro: 'You can view the execution time of a job, including the billable minutes that a job accrued.' +intro: You can view the execution time of a job, including the billable minutes that a job accrued. redirect_from: - /actions/managing-workflow-runs/viewing-job-execution-time - /actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time @@ -13,6 +13,7 @@ versions: ghec: '*' category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/monitor-workflows/view-workflow-run-history.md b/content/actions/how-tos/monitor-workflows/view-workflow-run-history.md index 8f2b7005b675..8e3227bedd2a 100644 --- a/content/actions/how-tos/monitor-workflows/view-workflow-run-history.md +++ b/content/actions/how-tos/monitor-workflows/view-workflow-run-history.md @@ -14,6 +14,7 @@ versions: ghec: '*' category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/reuse-automations/create-workflow-templates.md b/content/actions/how-tos/reuse-automations/create-workflow-templates.md index 33c2db1ae621..e49980094cb1 100644 --- a/content/actions/how-tos/reuse-automations/create-workflow-templates.md +++ b/content/actions/how-tos/reuse-automations/create-workflow-templates.md @@ -13,7 +13,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -contentType: tutorials +contentType: how-tos category: - Reuse and share automations --- diff --git a/content/actions/how-tos/reuse-automations/index.md b/content/actions/how-tos/reuse-automations/index.md index ad7885e271cf..bf6a05e68626 100644 --- a/content/actions/how-tos/reuse-automations/index.md +++ b/content/actions/how-tos/reuse-automations/index.md @@ -1,7 +1,7 @@ --- title: Reusing automations shortTitle: Reuse automations -intro: 'Create modular automations that you can share and reuse across {% data variables.product.prodname_actions %} workflows.' +intro: Create modular automations that you can share and reuse across {% data variables.product.prodname_actions %} workflows. versions: fpt: '*' ghes: '*' @@ -20,6 +20,7 @@ children: - /share-across-private-repositories - /share-with-your-organization - /share-with-your-enterprise +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/reuse-automations/reuse-workflows.md b/content/actions/how-tos/reuse-automations/reuse-workflows.md index 0332fc2dd8f3..553b7d934b74 100644 --- a/content/actions/how-tos/reuse-automations/reuse-workflows.md +++ b/content/actions/how-tos/reuse-automations/reuse-workflows.md @@ -13,6 +13,7 @@ versions: ghes: '*' category: - Reuse and share automations +contentType: how-tos --- ## Creating a reusable workflow diff --git a/content/actions/how-tos/reuse-automations/share-across-private-repositories.md b/content/actions/how-tos/reuse-automations/share-across-private-repositories.md index 5706ec85c850..965bf965a9ee 100644 --- a/content/actions/how-tos/reuse-automations/share-across-private-repositories.md +++ b/content/actions/how-tos/reuse-automations/share-across-private-repositories.md @@ -10,6 +10,7 @@ redirect_from: - /actions/how-tos/sharing-automations/sharing-actions-and-workflows-from-your-private-repository category: - Reuse and share automations +contentType: how-tos --- > [!WARNING] diff --git a/content/actions/how-tos/reuse-automations/share-with-your-enterprise.md b/content/actions/how-tos/reuse-automations/share-with-your-enterprise.md index 234c8b1c19b8..fca68e170fe7 100644 --- a/content/actions/how-tos/reuse-automations/share-with-your-enterprise.md +++ b/content/actions/how-tos/reuse-automations/share-with-your-enterprise.md @@ -9,7 +9,7 @@ redirect_from: - /actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise - /actions/sharing-automations/sharing-actions-and-workflows-with-your-enterprise - /actions/how-tos/sharing-automations/sharing-actions-and-workflows-with-your-enterprise -contentType: tutorials +contentType: how-tos category: - Reuse and share automations --- diff --git a/content/actions/how-tos/reuse-automations/share-with-your-organization.md b/content/actions/how-tos/reuse-automations/share-with-your-organization.md index e55b90e4181e..5ab244ecbd22 100644 --- a/content/actions/how-tos/reuse-automations/share-with-your-organization.md +++ b/content/actions/how-tos/reuse-automations/share-with-your-organization.md @@ -11,6 +11,7 @@ redirect_from: - /actions/administering-github-actions/sharing-workflows-secrets-and-runners-with-your-organization category: - Reuse and share automations +contentType: how-tos --- > [!WARNING] diff --git a/content/actions/how-tos/secure-your-work/index.md b/content/actions/how-tos/secure-your-work/index.md index 70323137789d..7dcb13e2e1da 100644 --- a/content/actions/how-tos/secure-your-work/index.md +++ b/content/actions/how-tos/secure-your-work/index.md @@ -1,7 +1,7 @@ --- title: Security for GitHub Actions shortTitle: Secure your work -intro: 'Use security best practices with {% data variables.product.prodname_actions %}, and use {% data variables.product.prodname_actions %} to improve the security of your software supply chain.' +intro: Use security best practices with {% data variables.product.prodname_actions %}, and use {% data variables.product.prodname_actions %} to improve the security of your software supply chain. redirect_from: - /actions/security-guides - /actions/security-for-github-actions @@ -15,5 +15,6 @@ versions: children: - /use-artifact-attestations - /security-harden-deployments +contentType: how-tos --- diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/index.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/index.md index ce6a5037665f..77ef5ef2a711 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/index.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/index.md @@ -20,4 +20,6 @@ children: - /oidc-in-pypi - /oidc-in-cloud-providers - /oidc-with-reusable-workflows +contentType: how-tos --- + diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-aws.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-aws.md index 56ed01c90f4a..0031fe057e89 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-aws.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-aws.md @@ -10,7 +10,7 @@ redirect_from: - /actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services - /actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services - /actions/how-tos/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services -contentType: tutorials +contentType: how-tos category: - Secure your workflows --- diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-azure.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-azure.md index c6b7adc8de12..bb00ccd24be8 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-azure.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-azure.md @@ -11,7 +11,7 @@ redirect_from: - /actions/security-for-github-actions/security-guides/security-hardening-your-deployments/configuring-openid-connect-in-azure - /actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-azure - /actions/how-tos/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-azure -contentType: tutorials +contentType: how-tos category: - Secure your workflows --- diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-cloud-providers.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-cloud-providers.md index 8bda5767310e..d0759bdaa00f 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-cloud-providers.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-cloud-providers.md @@ -10,7 +10,7 @@ redirect_from: - /actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers - /actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers - /actions/how-tos/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-cloud-providers -contentType: tutorials +contentType: how-tos category: - Secure your workflows --- diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-google-cloud-platform.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-google-cloud-platform.md index 6558f3af5fe0..1875e63e43e9 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-google-cloud-platform.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-google-cloud-platform.md @@ -10,7 +10,7 @@ redirect_from: - /actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform - /actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform - /actions/how-tos/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform -contentType: tutorials +contentType: how-tos category: - Secure your workflows --- diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-hashicorp-vault.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-hashicorp-vault.md index 863c49842fe2..b2a016ef6461 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-hashicorp-vault.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-hashicorp-vault.md @@ -10,7 +10,7 @@ redirect_from: - /actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault - /actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault - /actions/how-tos/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault -contentType: tutorials +contentType: how-tos category: - Secure your workflows --- diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-jfrog.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-jfrog.md index 3cda8932f1e5..2423a4d9c085 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-jfrog.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-jfrog.md @@ -9,7 +9,7 @@ redirect_from: - /actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-jfrog - /actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog - /actions/how-tos/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-jfrog -contentType: tutorials +contentType: how-tos category: - Secure your workflows --- diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-octopus-deploy.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-octopus-deploy.md index 17419078435e..b865c36b60cb 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-octopus-deploy.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-octopus-deploy.md @@ -5,7 +5,7 @@ intro: Use OpenID Connect within your workflows to authenticate with Octopus Dep versions: fpt: '*' ghec: '*' -contentType: tutorials +contentType: how-tos category: - Secure your workflows --- diff --git a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-pypi.md b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-pypi.md index 323bb1d909d2..d659744c9677 100644 --- a/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-pypi.md +++ b/content/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-pypi.md @@ -9,7 +9,7 @@ redirect_from: - /actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-pypi - /actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi - /actions/how-tos/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-pypi -contentType: tutorials +contentType: how-tos category: - Secure your workflows --- diff --git a/content/actions/how-tos/secure-your-work/use-artifact-attestations/enforce-artifact-attestations.md b/content/actions/how-tos/secure-your-work/use-artifact-attestations/enforce-artifact-attestations.md index 9c12c151efa2..af91d218d35a 100644 --- a/content/actions/how-tos/secure-your-work/use-artifact-attestations/enforce-artifact-attestations.md +++ b/content/actions/how-tos/secure-your-work/use-artifact-attestations/enforce-artifact-attestations.md @@ -11,6 +11,7 @@ redirect_from: - /actions/how-tos/security-for-github-actions/using-artifact-attestations/enforcing-artifact-attestations-with-a-kubernetes-admission-controller category: - Secure your workflows +contentType: how-tos --- >[!NOTE] Before proceeding, ensure you have enabled build provenance for container images, including setting the `push-to-registry` attribute in the [`attest-build-provenance` action](https://github.com/actions/attest-build-provenance) as documented in [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images). This is required for the Policy Controller to verify the attestation. diff --git a/content/actions/how-tos/secure-your-work/use-artifact-attestations/increase-security-rating.md b/content/actions/how-tos/secure-your-work/use-artifact-attestations/increase-security-rating.md index f2e5fa0b7d40..c3a98fefa7e4 100644 --- a/content/actions/how-tos/secure-your-work/use-artifact-attestations/increase-security-rating.md +++ b/content/actions/how-tos/secure-your-work/use-artifact-attestations/increase-security-rating.md @@ -11,6 +11,7 @@ redirect_from: - /actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-and-reusable-workflows-to-achieve-slsa-v1-build-level-3 category: - Secure your workflows +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/secure-your-work/use-artifact-attestations/index.md b/content/actions/how-tos/secure-your-work/use-artifact-attestations/index.md index 8b7b54866b3b..e85040e056ef 100644 --- a/content/actions/how-tos/secure-your-work/use-artifact-attestations/index.md +++ b/content/actions/how-tos/secure-your-work/use-artifact-attestations/index.md @@ -15,4 +15,6 @@ children: redirect_from: - /actions/security-for-github-actions/using-artifact-attestations - /actions/how-tos/security-for-github-actions/using-artifact-attestations +contentType: how-tos --- + diff --git a/content/actions/how-tos/secure-your-work/use-artifact-attestations/manage-attestations.md b/content/actions/how-tos/secure-your-work/use-artifact-attestations/manage-attestations.md index b6ff74b79876..d3fea66ad99d 100644 --- a/content/actions/how-tos/secure-your-work/use-artifact-attestations/manage-attestations.md +++ b/content/actions/how-tos/secure-your-work/use-artifact-attestations/manage-attestations.md @@ -9,6 +9,7 @@ redirect_from: - /actions/how-tos/security-for-github-actions/using-artifact-attestations/managing-the-lifecycle-of-artifact-attestations category: - Secure your workflows +contentType: how-tos --- {% data reusables.actions.lifecycle-of-attestations %} diff --git a/content/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations.md b/content/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations.md index c374ab5bef91..7f964eda7673 100644 --- a/content/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations.md +++ b/content/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations.md @@ -12,6 +12,7 @@ redirect_from: - /actions/how-tos/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds category: - Secure your workflows +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/secure-your-work/use-artifact-attestations/verify-attestations-offline.md b/content/actions/how-tos/secure-your-work/use-artifact-attestations/verify-attestations-offline.md index 3333908b47ae..d7b218b10713 100644 --- a/content/actions/how-tos/secure-your-work/use-artifact-attestations/verify-attestations-offline.md +++ b/content/actions/how-tos/secure-your-work/use-artifact-attestations/verify-attestations-offline.md @@ -11,6 +11,7 @@ redirect_from: - /actions/how-tos/security-for-github-actions/using-artifact-attestations/verifying-attestations-offline category: - Secure your workflows +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/troubleshoot-workflows.md b/content/actions/how-tos/troubleshoot-workflows.md index dcc5ea21f538..1af848f1b923 100644 --- a/content/actions/how-tos/troubleshoot-workflows.md +++ b/content/actions/how-tos/troubleshoot-workflows.md @@ -1,7 +1,7 @@ --- title: Troubleshooting workflows shortTitle: Troubleshoot workflows -intro: 'You can use the tools in {% data variables.product.prodname_actions %} to debug your workflows.' +intro: You can use the tools in {% data variables.product.prodname_actions %} to debug your workflows. versions: fpt: '*' ghes: '*' @@ -15,6 +15,7 @@ redirect_from: - /actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows category: - Manage and monitor workflow runs +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/add-scripts.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/add-scripts.md index 2037fd1713e1..fd477e870a6b 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/add-scripts.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/add-scripts.md @@ -1,7 +1,7 @@ --- title: Adding scripts to your workflow shortTitle: Add scripts -intro: 'You can use {% data variables.product.prodname_actions %} workflows to run scripts.' +intro: You can use {% data variables.product.prodname_actions %} workflows to run scripts. versions: fpt: '*' ghes: '*' @@ -11,6 +11,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-what-your-workflow-does/adding-scripts-to-your-workflow category: - Write workflows +contentType: how-tos --- You can use a {% data variables.product.prodname_actions %} workflow to run scripts and shell commands, which are then executed on the assigned runner. This example demonstrates how to use the `run` keyword to execute the command `npm install -g bats` on the runner. diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/deploy-to-environment.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/deploy-to-environment.md index 05b5b59504f5..a2ec7969abe5 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/deploy-to-environment.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/deploy-to-environment.md @@ -14,6 +14,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-what-your-workflow-does/deploying-to-a-specific-environment category: - Deploy to environments +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/index.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/index.md index db04d161ccbf..064e11409016 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/index.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/index.md @@ -1,7 +1,7 @@ --- title: Choosing what your workflow does shortTitle: Choose what workflows do -intro: 'Workflows automate tasks in your software development lifecycle. Many tasks that you manually complete can be converted to a {% data variables.product.prodname_actions %} workflow.' +intro: Workflows automate tasks in your software development lifecycle. Many tasks that you manually complete can be converted to a {% data variables.product.prodname_actions %} workflow. redirect_from: - /actions/using-jobs - /actions/writing-workflows/choosing-what-your-workflow-does @@ -21,4 +21,6 @@ children: - /set-default-values-for-jobs - /deploy-to-environment - /run-job-variations +contentType: how-tos --- + diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs.md index bccd25c90a7b..54a62a0af836 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs.md @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-what-your-workflow-does/passing-information-between-jobs category: - Write workflows +contentType: how-tos --- ## Defining and using job outputs diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations.md index 24d150c1ff3a..ec1537676dfe 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations.md @@ -15,6 +15,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-what-your-workflow-does/running-variations-of-jobs-in-a-workflow category: - Write workflows +contentType: how-tos --- ## About matrix strategies diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/set-default-values-for-jobs.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/set-default-values-for-jobs.md index 643a64aa2a11..1256d7010197 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/set-default-values-for-jobs.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/set-default-values-for-jobs.md @@ -1,7 +1,7 @@ --- title: Setting a default shell and working directory shortTitle: Set default values for jobs -intro: 'Define the default settings that will apply to all jobs in the workflow, or all steps in a job.' +intro: Define the default settings that will apply to all jobs in the workflow, or all steps in a job. versions: fpt: '*' ghes: '*' @@ -13,6 +13,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-what-your-workflow-does/setting-a-default-shell-and-working-directory category: - Write workflows +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-jobs.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-jobs.md index 5ad95a4eac15..95c1db90af4d 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-jobs.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-jobs.md @@ -12,6 +12,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-what-your-workflow-does/using-jobs-in-a-workflow category: - Write workflows +contentType: how-tos --- ## Prerequisites diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets.md index 958d0a107433..cac993502734 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets.md @@ -1,7 +1,7 @@ --- title: Using secrets in GitHub Actions shortTitle: Use secrets -intro: 'Learn how to create secrets at the repository, environment, and organization levels for {% data variables.product.prodname_actions %} workflows.' +intro: Learn how to create secrets at the repository, environment, and organization levels for {% data variables.product.prodname_actions %} workflows. redirect_from: - /github/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets - /actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets @@ -22,6 +22,7 @@ versions: ghec: '*' category: - Secure your workflows +contentType: how-tos --- ## Creating secrets for a repository diff --git a/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables.md b/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables.md index cae73fcaee64..fb1ab12d64e9 100644 --- a/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables.md +++ b/content/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables.md @@ -19,6 +19,7 @@ versions: ghec: '*' category: - Write workflows +contentType: how-tos --- ## Defining environment variables for a single workflow diff --git a/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md b/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md index e74a1824e790..cf474fc9cd40 100644 --- a/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md +++ b/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md @@ -12,6 +12,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-when-your-workflow-runs/using-conditions-to-control-job-execution category: - Write workflows +contentType: how-tos --- You can use the `jobs..if` conditional to prevent a job from running unless a condition is met. {% data reusables.actions.if-supported-contexts %} diff --git a/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency.md b/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency.md index bf137deacd41..a3bce929c5fa 100644 --- a/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency.md +++ b/content/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency.md @@ -15,6 +15,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-when-your-workflow-runs/control-the-concurrency-of-workflows-and-jobs category: - Write workflows +contentType: how-tos --- ## Using concurrency in different scenarios diff --git a/content/actions/how-tos/write-workflows/choose-when-workflows-run/index.md b/content/actions/how-tos/write-workflows/choose-when-workflows-run/index.md index a276aad19e06..1bfdfca970cb 100644 --- a/content/actions/how-tos/write-workflows/choose-when-workflows-run/index.md +++ b/content/actions/how-tos/write-workflows/choose-when-workflows-run/index.md @@ -13,4 +13,6 @@ children: redirect_from: - /actions/writing-workflows/choosing-when-your-workflow-runs - /actions/how-tos/writing-workflows/choosing-when-your-workflow-runs +contentType: how-tos --- + diff --git a/content/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow.md b/content/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow.md index 9eedf5ad962f..ed93ed0ef4e5 100644 --- a/content/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow.md +++ b/content/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow.md @@ -10,7 +10,7 @@ redirect_from: - /actions/using-workflows/triggering-a-workflow - /actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow - /actions/how-tos/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow -contentType: tutorials +contentType: how-tos category: - Write workflows --- diff --git a/content/actions/how-tos/write-workflows/choose-where-workflows-run/choose-the-runner-for-a-job.md b/content/actions/how-tos/write-workflows/choose-where-workflows-run/choose-the-runner-for-a-job.md index 2f9ea904acc0..0aa39c81ad6c 100644 --- a/content/actions/how-tos/write-workflows/choose-where-workflows-run/choose-the-runner-for-a-job.md +++ b/content/actions/how-tos/write-workflows/choose-where-workflows-run/choose-the-runner-for-a-job.md @@ -12,6 +12,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-where-your-workflow-runs/choosing-the-runner-for-a-job category: - Write workflows +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/write-workflows/choose-where-workflows-run/index.md b/content/actions/how-tos/write-workflows/choose-where-workflows-run/index.md index 98fe2c2465db..a026771e7a4b 100644 --- a/content/actions/how-tos/write-workflows/choose-where-workflows-run/index.md +++ b/content/actions/how-tos/write-workflows/choose-where-workflows-run/index.md @@ -12,4 +12,6 @@ children: redirect_from: - /actions/writing-workflows/choosing-where-your-workflow-runs - /actions/how-tos/writing-workflows/choosing-where-your-workflow-runs +contentType: how-tos --- + diff --git a/content/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container.md b/content/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container.md index 8a9cd74144b9..1fdb871fc978 100644 --- a/content/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container.md +++ b/content/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container.md @@ -12,6 +12,7 @@ redirect_from: - /actions/how-tos/writing-workflows/choosing-where-your-workflow-runs/running-jobs-in-a-container category: - Write workflows +contentType: how-tos --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/how-tos/write-workflows/index.md b/content/actions/how-tos/write-workflows/index.md index 336236915446..828500b8eeef 100644 --- a/content/actions/how-tos/write-workflows/index.md +++ b/content/actions/how-tos/write-workflows/index.md @@ -16,5 +16,6 @@ children: - /choose-when-workflows-run - /choose-where-workflows-run - /choose-what-workflows-do +contentType: how-tos --- diff --git a/content/actions/how-tos/write-workflows/use-workflow-templates.md b/content/actions/how-tos/write-workflows/use-workflow-templates.md index 7931ab382110..948f7a3dd409 100644 --- a/content/actions/how-tos/write-workflows/use-workflow-templates.md +++ b/content/actions/how-tos/write-workflows/use-workflow-templates.md @@ -18,7 +18,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -contentType: tutorials +contentType: how-tos category: - Write workflows --- diff --git a/content/actions/reference/github-actions-importer/custom-transformers.md b/content/actions/reference/github-actions-importer/custom-transformers.md index e938cc3f8fbb..dcf9c494d76d 100644 --- a/content/actions/reference/github-actions-importer/custom-transformers.md +++ b/content/actions/reference/github-actions-importer/custom-transformers.md @@ -11,7 +11,7 @@ redirect_from: - /actions/migrating-to-github-actions/using-github-actions-importer-to-automate-migrations/extending-github-actions-importer-with-custom-transformers - /actions/how-tos/migrating-to-github-actions/using-github-actions-importer-to-automate-migrations/extending-github-actions-importer-with-custom-transformers - /actions/reference/extending-github-actions-importer-with-custom-transformers -contentType: how-tos +contentType: reference category: - Migrate to GitHub Actions --- diff --git a/content/actions/reference/github-actions-importer/index.md b/content/actions/reference/github-actions-importer/index.md index ddde9dd9ba3f..e6252701f081 100644 --- a/content/actions/reference/github-actions-importer/index.md +++ b/content/actions/reference/github-actions-importer/index.md @@ -9,4 +9,6 @@ versions: children: - /supplemental-arguments-and-settings - /custom-transformers +contentType: reference --- + diff --git a/content/actions/reference/index.md b/content/actions/reference/index.md index 69c156d12d75..a645f69bcae9 100644 --- a/content/actions/reference/index.md +++ b/content/actions/reference/index.md @@ -12,4 +12,6 @@ children: - /security - /limits - /github-actions-importer +contentType: reference --- + diff --git a/content/actions/reference/limits.md b/content/actions/reference/limits.md index 598a1a906935..284a39f46a5b 100644 --- a/content/actions/reference/limits.md +++ b/content/actions/reference/limits.md @@ -1,6 +1,6 @@ --- title: Actions limits -intro: 'There are limits in {% data variables.product.prodname_actions %} which you may hit as you scale up, some may be increased by contacting support.' +intro: There are limits in {% data variables.product.prodname_actions %} which you may hit as you scale up, some may be increased by contacting support. redirect_from: - /actions/monitoring-and-troubleshooting-workflows/troubleshooting-workflows/actions-limits - /actions/hosting-your-own-runners/managing-self-hosted-runners/usage-limits-for-self-hosted-runners @@ -13,6 +13,7 @@ versions: shortTitle: Limits category: - Administer GitHub Actions +contentType: reference --- You may be rate limited by {% data variables.product.prodname_actions %} when you scale your usage. Some limits can be increased by contacting {% data variables.contact.contact_support %}. diff --git a/content/actions/reference/runners/github-hosted-runners.md b/content/actions/reference/runners/github-hosted-runners.md index 08400975dda5..d4de66d4fb15 100644 --- a/content/actions/reference/runners/github-hosted-runners.md +++ b/content/actions/reference/runners/github-hosted-runners.md @@ -1,7 +1,7 @@ --- title: GitHub-hosted runners reference shortTitle: GitHub-hosted runners -intro: 'Find information about {% data variables.product.github %}-hosted runners, including their specifications and customization options.' +intro: Find information about {% data variables.product.github %}-hosted runners, including their specifications and customization options. versions: fpt: '*' ghes: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/reference/github-hosted-runners-reference category: - Set up runners +contentType: reference --- {% ifversion ghes %} diff --git a/content/actions/reference/runners/index.md b/content/actions/reference/runners/index.md index 1cc77f089678..15788b082a04 100644 --- a/content/actions/reference/runners/index.md +++ b/content/actions/reference/runners/index.md @@ -10,4 +10,6 @@ children: - /github-hosted-runners - /larger-runners - /self-hosted-runners +contentType: reference --- + diff --git a/content/actions/reference/runners/larger-runners.md b/content/actions/reference/runners/larger-runners.md index 217f2e85d234..bdf17bf692a3 100644 --- a/content/actions/reference/runners/larger-runners.md +++ b/content/actions/reference/runners/larger-runners.md @@ -1,7 +1,7 @@ --- title: Larger runners reference shortTitle: Larger runners -intro: 'Find information about larger runners, including their specifications and customization options.' +intro: Find information about larger runners, including their specifications and customization options. versions: fpt: '*' ghes: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/reference/larger-runners-reference category: - Set up runners +contentType: reference --- {% ifversion ghes %} diff --git a/content/actions/reference/runners/self-hosted-runners.md b/content/actions/reference/runners/self-hosted-runners.md index e518c32973c6..7ae4ff911b5c 100644 --- a/content/actions/reference/runners/self-hosted-runners.md +++ b/content/actions/reference/runners/self-hosted-runners.md @@ -15,7 +15,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -contentType: concepts +contentType: reference category: - Set up runners --- diff --git a/content/actions/reference/security/index.md b/content/actions/reference/security/index.md index 4b59ea6b23da..d1d1822f422a 100644 --- a/content/actions/reference/security/index.md +++ b/content/actions/reference/security/index.md @@ -10,4 +10,6 @@ children: - /secure-use - /secrets - /oidc +contentType: reference --- + diff --git a/content/actions/reference/security/oidc.md b/content/actions/reference/security/oidc.md index 7a956b793ce5..55f22032bda6 100644 --- a/content/actions/reference/security/oidc.md +++ b/content/actions/reference/security/oidc.md @@ -1,7 +1,7 @@ --- title: OpenID Connect reference shortTitle: OIDC -intro: 'Find information about using OpenID Connect (OIDC) to authenticate {% data variables.product.prodname_actions %} workflows with cloud providers.' +intro: Find information about using OpenID Connect (OIDC) to authenticate {% data variables.product.prodname_actions %} workflows with cloud providers. versions: fpt: '*' ghec: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/reference/openid-connect-reference category: - Secure your workflows +contentType: reference --- ## OIDC token claims @@ -71,7 +72,7 @@ The OIDC token includes the following claims. | `repository_owner`| The name of the organization in which the `repository` is stored. | | `repository_owner_id`| The ID of the organization in which the `repository` is stored. | | {% ifversion oidc-custom-properties %} | -| `repo_property_*`| Custom properties defined at the organization or enterprise level that are included as claims in the OIDC token, prefixed with `repo_property_`. For more information, see [AUTOTITLE](#including-repository-custom-properties-in-oidc-tokens). | +| `repo_property_*`| Custom properties defined at the organization or enterprise level that are included as claims in the OIDC token, prefixed with `repo_property_`. For more information, see [Including repository custom properties in OIDC tokens](#including-repository-custom-properties-in-oidc-tokens). | | {% endif %} | | `run_id`| The ID of the workflow run that triggered the workflow. | | `run_number`| The number of times this workflow has been run. | @@ -183,7 +184,7 @@ You can security harden your OIDC configuration by customizing the claims that a * You can customize the format of your OIDC configuration by setting conditions on the subject (`sub`) claim that require JWT tokens to originate from a specific repository, reusable workflow, or other source. * You can define granular OIDC policies by using additional OIDC token claims, such as `repository_id` and `repository_visibility`. See [AUTOTITLE](/actions/concepts/security/openid-connect#understanding-the-oidc-token). {% ifversion oidc-custom-properties %} -* You can include repository custom properties as claims in OIDC tokens, enabling attribute-based access control policies. See [AUTOTITLE](#including-repository-custom-properties-in-oidc-tokens). +* You can include repository custom properties as claims in OIDC tokens, enabling attribute-based access control policies. See [Including repository custom properties in OIDC tokens](#including-repository-custom-properties-in-oidc-tokens). {% endif %} ### Customizing the `audience` value diff --git a/content/actions/reference/security/secrets.md b/content/actions/reference/security/secrets.md index b3062d6fb2c4..a317b192b2a9 100644 --- a/content/actions/reference/security/secrets.md +++ b/content/actions/reference/security/secrets.md @@ -1,7 +1,7 @@ --- title: Secrets reference shortTitle: Secrets -intro: 'Find technical information about secrets in {% data variables.product.prodname_actions %}.' +intro: Find technical information about secrets in {% data variables.product.prodname_actions %}. versions: fpt: '*' ghec: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/reference/secrets-reference category: - Secure your workflows +contentType: reference --- ## Naming your secrets diff --git a/content/actions/reference/security/secure-use.md b/content/actions/reference/security/secure-use.md index d516978a7008..27e343b65c64 100644 --- a/content/actions/reference/security/secure-use.md +++ b/content/actions/reference/security/secure-use.md @@ -1,7 +1,7 @@ --- title: Secure use reference shortTitle: Secure use -intro: 'Security practices for writing workflows and using {% data variables.product.prodname_actions %} features.' +intro: Security practices for writing workflows and using {% data variables.product.prodname_actions %} features. redirect_from: - /actions/getting-started-with-github-actions/security-hardening-for-github-actions - /actions/learn-github-actions/security-hardening-for-github-actions @@ -18,6 +18,7 @@ versions: ghec: '*' category: - Secure your workflows +contentType: reference --- Find information about security best practices when you are writing workflows and using {% data variables.product.prodname_actions %} security features. diff --git a/content/actions/reference/workflows-and-actions/contexts.md b/content/actions/reference/workflows-and-actions/contexts.md index 04947ea97438..2d07b8e274f1 100644 --- a/content/actions/reference/workflows-and-actions/contexts.md +++ b/content/actions/reference/workflows-and-actions/contexts.md @@ -1,7 +1,7 @@ --- title: Contexts reference shortTitle: Contexts -intro: 'Find information about contexts available in {% data variables.product.prodname_actions %} workflows, including available properties, access methods, and usage examples.' +intro: Find information about contexts available in {% data variables.product.prodname_actions %} workflows, including available properties, access methods, and usage examples. redirect_from: - /articles/contexts-and-expression-syntax-for-github-actions - /github/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions @@ -19,6 +19,7 @@ versions: ghec: '*' category: - Write workflows +contentType: reference --- ## Available contexts diff --git a/content/actions/reference/workflows-and-actions/dependency-caching.md b/content/actions/reference/workflows-and-actions/dependency-caching.md index e8c5fd3018b0..05e5631e09bf 100644 --- a/content/actions/reference/workflows-and-actions/dependency-caching.md +++ b/content/actions/reference/workflows-and-actions/dependency-caching.md @@ -16,7 +16,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -contentType: concepts +contentType: reference category: - Write workflows --- diff --git a/content/actions/reference/workflows-and-actions/deployments-and-environments.md b/content/actions/reference/workflows-and-actions/deployments-and-environments.md index 3802f03914c4..91564ea31b5f 100644 --- a/content/actions/reference/workflows-and-actions/deployments-and-environments.md +++ b/content/actions/reference/workflows-and-actions/deployments-and-environments.md @@ -1,7 +1,7 @@ --- title: Deployments and environments shortTitle: Deployments and environments -intro: 'Find information about deployment protection rules, environment secrets, and environment variables.' +intro: Find information about deployment protection rules, environment secrets, and environment variables. versions: fpt: '*' ghes: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/reference/deployments-and-environments category: - Deploy to environments +contentType: reference --- ## Deployment protection rules diff --git a/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md b/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md index b50094b2ca4a..18ea075b2636 100644 --- a/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md +++ b/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md @@ -1,6 +1,6 @@ --- title: Events that trigger workflows -intro: 'You can configure your workflows to run when specific activity on {% data variables.product.github %} happens, at a scheduled time, or when an event outside of {% data variables.product.github %} occurs.' +intro: You can configure your workflows to run when specific activity on {% data variables.product.github %} happens, at a scheduled time, or when an event outside of {% data variables.product.github %} occurs. redirect_from: - /articles/events-that-trigger-workflows - /github/automating-your-workflow-with-github-actions/events-that-trigger-workflows @@ -15,6 +15,7 @@ versions: ghec: '*' category: - Write workflows +contentType: reference --- ## About events that trigger workflows diff --git a/content/actions/reference/workflows-and-actions/expressions.md b/content/actions/reference/workflows-and-actions/expressions.md index 9a15c2c9182d..0064a4343857 100644 --- a/content/actions/reference/workflows-and-actions/expressions.md +++ b/content/actions/reference/workflows-and-actions/expressions.md @@ -1,7 +1,7 @@ --- title: Evaluate expressions in workflows and actions shortTitle: Expressions -intro: 'Find information for expressions in {% data variables.product.prodname_actions %}.' +intro: Find information for expressions in {% data variables.product.prodname_actions %}. versions: fpt: '*' ghes: '*' @@ -13,6 +13,7 @@ redirect_from: - /actions/reference/evaluate-expressions-in-workflows-and-actions category: - Write workflows +contentType: reference --- ## Literals diff --git a/content/actions/reference/workflows-and-actions/index.md b/content/actions/reference/workflows-and-actions/index.md index f9cd9859484e..f3bac90f6946 100644 --- a/content/actions/reference/workflows-and-actions/index.md +++ b/content/actions/reference/workflows-and-actions/index.md @@ -19,4 +19,6 @@ children: - /metadata-syntax - /workflow-cancellation - /dockerfile-support +contentType: reference --- + diff --git a/content/actions/reference/workflows-and-actions/reusing-workflow-configurations.md b/content/actions/reference/workflows-and-actions/reusing-workflow-configurations.md index c3596f959897..b8b58de3e11b 100644 --- a/content/actions/reference/workflows-and-actions/reusing-workflow-configurations.md +++ b/content/actions/reference/workflows-and-actions/reusing-workflow-configurations.md @@ -11,6 +11,7 @@ redirect_from: - /actions/reference/workflows-and-actions/reusable-workflows category: - Reuse and share automations +contentType: reference --- ## Reusable workflows diff --git a/content/actions/reference/workflows-and-actions/variables.md b/content/actions/reference/workflows-and-actions/variables.md index dc990c820263..b1562a85754d 100644 --- a/content/actions/reference/workflows-and-actions/variables.md +++ b/content/actions/reference/workflows-and-actions/variables.md @@ -1,7 +1,7 @@ --- title: Variables reference shortTitle: Variables -intro: 'Find information for supported variables, naming conventions, limits, and contexts in {% data variables.product.prodname_actions %} workflows.' +intro: Find information for supported variables, naming conventions, limits, and contexts in {% data variables.product.prodname_actions %} workflows. versions: fpt: '*' ghes: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/reference/variables-reference category: - Write workflows +contentType: reference --- This article lists the supported variables you can use in {% data variables.product.prodname_actions %} workflows, including environment variables, configuration variables, and default variables provided by {% data variables.product.github %}. Use this reference to look up variable names, naming conventions, limits, and supported contexts when configuring your workflows. diff --git a/content/actions/reference/workflows-and-actions/workflow-cancellation.md b/content/actions/reference/workflows-and-actions/workflow-cancellation.md index 78c6b8718d56..2930da0b38a7 100644 --- a/content/actions/reference/workflows-and-actions/workflow-cancellation.md +++ b/content/actions/reference/workflows-and-actions/workflow-cancellation.md @@ -1,7 +1,7 @@ --- title: Workflow cancellation reference shortTitle: Workflow cancellation -intro: 'Find information on the steps {% data variables.product.prodname_dotcom %} takes to cancel a workflow run.' +intro: Find information on the steps {% data variables.product.prodname_dotcom %} takes to cancel a workflow run. versions: fpt: '*' ghes: '*' @@ -10,6 +10,7 @@ redirect_from: - /actions/reference/workflow-cancellation-reference category: - Manage and monitor workflow runs +contentType: reference --- When canceling a workflow run, you may be running other software that uses resources related to the workflow run. To help you free up resources related to the workflow run, it may help to understand the steps {% data variables.product.prodname_dotcom %} performs to cancel a workflow run. diff --git a/content/actions/reference/workflows-and-actions/workflow-commands.md b/content/actions/reference/workflows-and-actions/workflow-commands.md index ef69b9babd0c..e06d3dd3f85f 100644 --- a/content/actions/reference/workflows-and-actions/workflow-commands.md +++ b/content/actions/reference/workflows-and-actions/workflow-commands.md @@ -19,6 +19,7 @@ versions: ghec: '*' category: - Write workflows +contentType: reference --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/reference/workflows-and-actions/workflow-syntax.md b/content/actions/reference/workflows-and-actions/workflow-syntax.md index a42ed050a697..2cc3121c74ae 100644 --- a/content/actions/reference/workflows-and-actions/workflow-syntax.md +++ b/content/actions/reference/workflows-and-actions/workflow-syntax.md @@ -17,6 +17,7 @@ versions: ghec: '*' category: - Write workflows +contentType: reference --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/authenticate-with-github_token.md b/content/actions/tutorials/authenticate-with-github_token.md index ec51f8dc266b..c16ff42b73d3 100644 --- a/content/actions/tutorials/authenticate-with-github_token.md +++ b/content/actions/tutorials/authenticate-with-github_token.md @@ -1,6 +1,6 @@ --- title: Use GITHUB_TOKEN for authentication in workflows -intro: 'Learn how to use the `GITHUB_TOKEN` to authenticate on behalf of {% data variables.product.prodname_actions %}.' +intro: Learn how to use the `GITHUB_TOKEN` to authenticate on behalf of {% data variables.product.prodname_actions %}. redirect_from: - /github/automating-your-workflow-with-github-actions/authenticating-with-the-github_token - /actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token @@ -23,6 +23,7 @@ versions: shortTitle: Authenticate with GITHUB_TOKEN category: - Secure your workflows +contentType: tutorials --- This tutorial leads you through how to use the `GITHUB_TOKEN` for authentication in {% data variables.product.prodname_actions %} workflows, including examples for passing the token to actions, making API requests, and configuring permissions for secure automation. diff --git a/content/actions/tutorials/build-and-test-code/go.md b/content/actions/tutorials/build-and-test-code/go.md index cabcd8864ba5..95c436f0cdfe 100644 --- a/content/actions/tutorials/build-and-test-code/go.md +++ b/content/actions/tutorials/build-and-test-code/go.md @@ -14,6 +14,7 @@ redirect_from: - /actions/tutorials/build-and-test-code/building-and-testing-go category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/index.md b/content/actions/tutorials/build-and-test-code/index.md index f7591938db17..08aa9f208a56 100644 --- a/content/actions/tutorials/build-and-test-code/index.md +++ b/content/actions/tutorials/build-and-test-code/index.md @@ -1,7 +1,7 @@ --- title: Building and testing your code shortTitle: Build and test code -intro: 'You can automatically build and test your projects with {% data variables.product.prodname_actions %}.' +intro: You can automatically build and test your projects with {% data variables.product.prodname_actions %}. versions: fpt: '*' ghes: '*' @@ -33,5 +33,6 @@ children: - /rust - /swift - /xamarin-apps +contentType: tutorials --- diff --git a/content/actions/tutorials/build-and-test-code/java-with-ant.md b/content/actions/tutorials/build-and-test-code/java-with-ant.md index ebcf30fc1bd9..c7ac93d4c4bf 100644 --- a/content/actions/tutorials/build-and-test-code/java-with-ant.md +++ b/content/actions/tutorials/build-and-test-code/java-with-ant.md @@ -15,6 +15,7 @@ versions: shortTitle: Java with Ant category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/java-with-gradle.md b/content/actions/tutorials/build-and-test-code/java-with-gradle.md index 702362d7d298..1001b70a0216 100644 --- a/content/actions/tutorials/build-and-test-code/java-with-gradle.md +++ b/content/actions/tutorials/build-and-test-code/java-with-gradle.md @@ -16,6 +16,7 @@ versions: shortTitle: Java with Gradle category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/java-with-maven.md b/content/actions/tutorials/build-and-test-code/java-with-maven.md index 869da64d9435..dd966d6628a8 100644 --- a/content/actions/tutorials/build-and-test-code/java-with-maven.md +++ b/content/actions/tutorials/build-and-test-code/java-with-maven.md @@ -16,6 +16,7 @@ versions: shortTitle: Java with Maven category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/net.md b/content/actions/tutorials/build-and-test-code/net.md index 7135e68f40a9..aa482046f745 100644 --- a/content/actions/tutorials/build-and-test-code/net.md +++ b/content/actions/tutorials/build-and-test-code/net.md @@ -15,6 +15,7 @@ versions: shortTitle: .NET category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/nodejs.md b/content/actions/tutorials/build-and-test-code/nodejs.md index 7e2e80870750..094cd6f59447 100644 --- a/content/actions/tutorials/build-and-test-code/nodejs.md +++ b/content/actions/tutorials/build-and-test-code/nodejs.md @@ -17,6 +17,7 @@ versions: shortTitle: Node.js category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/powershell.md b/content/actions/tutorials/build-and-test-code/powershell.md index 52230080eb7c..50888d60e318 100644 --- a/content/actions/tutorials/build-and-test-code/powershell.md +++ b/content/actions/tutorials/build-and-test-code/powershell.md @@ -17,6 +17,7 @@ authors: shortTitle: PowerShell category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/python.md b/content/actions/tutorials/build-and-test-code/python.md index efad77a34418..8b13b25a0c23 100644 --- a/content/actions/tutorials/build-and-test-code/python.md +++ b/content/actions/tutorials/build-and-test-code/python.md @@ -17,6 +17,7 @@ versions: shortTitle: Python category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/ruby.md b/content/actions/tutorials/build-and-test-code/ruby.md index 67e0f1a30b52..edb571bd091b 100644 --- a/content/actions/tutorials/build-and-test-code/ruby.md +++ b/content/actions/tutorials/build-and-test-code/ruby.md @@ -15,6 +15,7 @@ versions: shortTitle: Ruby category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/rust.md b/content/actions/tutorials/build-and-test-code/rust.md index a9d7affa47c5..ce6b400fbb2a 100644 --- a/content/actions/tutorials/build-and-test-code/rust.md +++ b/content/actions/tutorials/build-and-test-code/rust.md @@ -13,6 +13,7 @@ redirect_from: - /actions/tutorials/build-and-test-code/building-and-testing-rust category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/swift.md b/content/actions/tutorials/build-and-test-code/swift.md index d87b743600a0..48f819208c52 100644 --- a/content/actions/tutorials/build-and-test-code/swift.md +++ b/content/actions/tutorials/build-and-test-code/swift.md @@ -15,6 +15,7 @@ versions: shortTitle: Swift category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/build-and-test-code/xamarin-apps.md b/content/actions/tutorials/build-and-test-code/xamarin-apps.md index e459bb7c06cb..1fd811204c18 100644 --- a/content/actions/tutorials/build-and-test-code/xamarin-apps.md +++ b/content/actions/tutorials/build-and-test-code/xamarin-apps.md @@ -15,6 +15,7 @@ versions: shortTitle: Xamarin apps category: - Build and test code +contentType: tutorials --- {% data reusables.actions.enterprise-github-hosted-runners %} diff --git a/content/actions/tutorials/create-actions/index.md b/content/actions/tutorials/create-actions/index.md index 289c4685ca4a..61accd2562b6 100644 --- a/content/actions/tutorials/create-actions/index.md +++ b/content/actions/tutorials/create-actions/index.md @@ -8,4 +8,6 @@ versions: children: - /create-a-javascript-action - /create-a-composite-action +contentType: tutorials --- + diff --git a/content/actions/tutorials/index.md b/content/actions/tutorials/index.md index 87a21e7c82ff..fbeb01db9775 100644 --- a/content/actions/tutorials/index.md +++ b/content/actions/tutorials/index.md @@ -25,4 +25,6 @@ redirect_from: - /actions/use-cases-and-examples/project-management/moving-assigned-issues-on-project-boards - /actions/use-cases-and-examples/project-management/removing-a-label-when-a-card-is-added-to-a-project-board-column - /actions/use-cases-and-examples +contentType: tutorials --- + diff --git a/content/actions/tutorials/manage-your-work/index.md b/content/actions/tutorials/manage-your-work/index.md index bb5dc3bf5c39..6e67130dc63e 100644 --- a/content/actions/tutorials/manage-your-work/index.md +++ b/content/actions/tutorials/manage-your-work/index.md @@ -1,7 +1,7 @@ --- title: Managing your work with GitHub Actions shortTitle: Manage your work -intro: 'You can automatically manage your issues and pull requests using {% data variables.product.prodname_actions %} workflows.' +intro: You can automatically manage your issues and pull requests using {% data variables.product.prodname_actions %} workflows. versions: fpt: '*' ghes: '*' @@ -19,4 +19,6 @@ redirect_from: - /actions/how-tos/use-cases-and-examples/project-management - /actions/examples - /actions/tutorials/project-management +contentType: tutorials --- + diff --git a/content/actions/tutorials/migrate-to-github-actions/automated-migrations/index.md b/content/actions/tutorials/migrate-to-github-actions/automated-migrations/index.md index 5598e719d566..c919ae8bcfb7 100644 --- a/content/actions/tutorials/migrate-to-github-actions/automated-migrations/index.md +++ b/content/actions/tutorials/migrate-to-github-actions/automated-migrations/index.md @@ -1,7 +1,7 @@ --- -title: 'Using {% data variables.product.prodname_actions_importer %} to automate migrations' +title: Using {% data variables.product.prodname_actions_importer %} to automate migrations shortTitle: Automated migrations -intro: 'Learn how to use {% data variables.product.prodname_actions_importer %} to migrate your CI/CD workflows to {% data variables.product.prodname_actions %}.' +intro: Learn how to use {% data variables.product.prodname_actions_importer %} to migrate your CI/CD workflows to {% data variables.product.prodname_actions %}. versions: fpt: '*' ghes: '*' @@ -20,4 +20,6 @@ redirect_from: - /actions/migrating-to-github-actions/using-github-actions-importer-to-automate-migrations - /actions/how-tos/migrating-to-github-actions/using-github-actions-importer-to-automate-migrations - /actions/tutorials/migrating-to-github-actions/using-github-actions-importer-to-automate-migrations +contentType: tutorials --- + diff --git a/content/actions/tutorials/migrate-to-github-actions/automated-migrations/use-github-actions-importer.md b/content/actions/tutorials/migrate-to-github-actions/automated-migrations/use-github-actions-importer.md index f5461c96d6be..b19140412e74 100644 --- a/content/actions/tutorials/migrate-to-github-actions/automated-migrations/use-github-actions-importer.md +++ b/content/actions/tutorials/migrate-to-github-actions/automated-migrations/use-github-actions-importer.md @@ -12,7 +12,7 @@ versions: fpt: '*' ghec: '*' ghes: '*' -contentType: how-tos +contentType: tutorials category: - Migrate to GitHub Actions --- diff --git a/content/actions/tutorials/migrate-to-github-actions/index.md b/content/actions/tutorials/migrate-to-github-actions/index.md index d6f66007bf0c..4b8e30b37fdb 100644 --- a/content/actions/tutorials/migrate-to-github-actions/index.md +++ b/content/actions/tutorials/migrate-to-github-actions/index.md @@ -1,7 +1,7 @@ --- title: Migrating to GitHub Actions shortTitle: Migrate to GitHub Actions -intro: 'Learn how to migrate your existing CI/CD workflows to {% data variables.product.prodname_actions %}.' +intro: Learn how to migrate your existing CI/CD workflows to {% data variables.product.prodname_actions %}. versions: fpt: '*' ghes: '*' @@ -14,5 +14,6 @@ redirect_from: children: - /automated-migrations - /manual-migrations +contentType: tutorials --- diff --git a/content/actions/tutorials/migrate-to-github-actions/manual-migrations/index.md b/content/actions/tutorials/migrate-to-github-actions/manual-migrations/index.md index 34a4287f22d6..74a4367a886d 100644 --- a/content/actions/tutorials/migrate-to-github-actions/manual-migrations/index.md +++ b/content/actions/tutorials/migrate-to-github-actions/manual-migrations/index.md @@ -1,7 +1,7 @@ --- title: Manually migrating to GitHub Actions shortTitle: Manual migrations -intro: 'Learn how to manually migrate your existing CI/CD workflows to {% data variables.product.prodname_actions %}.' +intro: Learn how to manually migrate your existing CI/CD workflows to {% data variables.product.prodname_actions %}. versions: fpt: '*' ghes: '*' @@ -17,4 +17,6 @@ redirect_from: - /actions/migrating-to-github-actions/manually-migrating-to-github-actions - /actions/how-tos/migrating-to-github-actions/manually-migrating-to-github-actions - /actions/tutorials/migrating-to-github-actions/manually-migrating-to-github-actions +contentType: tutorials --- + diff --git a/content/actions/tutorials/publish-packages/index.md b/content/actions/tutorials/publish-packages/index.md index fbc41c944a08..d3b92a9d864d 100644 --- a/content/actions/tutorials/publish-packages/index.md +++ b/content/actions/tutorials/publish-packages/index.md @@ -1,7 +1,7 @@ --- title: Publishing packages shortTitle: Publish packages -intro: 'You can automatically publish packages using {% data variables.product.prodname_actions %}.' +intro: You can automatically publish packages using {% data variables.product.prodname_actions %}. versions: fpt: '*' ghes: '*' @@ -17,5 +17,6 @@ children: - /publish-java-packages-with-gradle - /publish-java-packages-with-maven - /publish-nodejs-packages +contentType: tutorials --- diff --git a/content/actions/tutorials/use-actions-runner-controller/authenticate-to-the-api.md b/content/actions/tutorials/use-actions-runner-controller/authenticate-to-the-api.md index d9f4b385fdd1..ad0470903558 100644 --- a/content/actions/tutorials/use-actions-runner-controller/authenticate-to-the-api.md +++ b/content/actions/tutorials/use-actions-runner-controller/authenticate-to-the-api.md @@ -11,7 +11,7 @@ redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api#deploying-using-personal-access-token-classic-authentication - /actions/tutorials/actions-runner-controller/authenticating-arc-to-the-github-api -contentType: concepts +contentType: tutorials category: - Use and manage runners --- diff --git a/content/actions/tutorials/use-actions-runner-controller/deploy-runner-scale-sets.md b/content/actions/tutorials/use-actions-runner-controller/deploy-runner-scale-sets.md index e1cd716b2753..ea5c128875e6 100644 --- a/content/actions/tutorials/use-actions-runner-controller/deploy-runner-scale-sets.md +++ b/content/actions/tutorials/use-actions-runner-controller/deploy-runner-scale-sets.md @@ -11,7 +11,7 @@ redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller - /actions/tutorials/actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller -contentType: concepts +contentType: tutorials category: - Set up runners --- diff --git a/content/actions/tutorials/use-actions-runner-controller/index.md b/content/actions/tutorials/use-actions-runner-controller/index.md index 0137ac1f8171..353369cf05fb 100644 --- a/content/actions/tutorials/use-actions-runner-controller/index.md +++ b/content/actions/tutorials/use-actions-runner-controller/index.md @@ -7,15 +7,15 @@ versions: ghec: '*' layout: journey-landing journeyTracks: - - id: 'set_up_arc' - title: 'Set up Actions Runner Controller' - description: 'Install and configure Actions Runner Controller to run self-hosted runners at scale.' + - id: set_up_arc + title: Set up Actions Runner Controller + description: Install and configure Actions Runner Controller to run self-hosted runners at scale. guides: - - href: '/actions/tutorials/use-actions-runner-controller/quickstart' - - href: '/actions/tutorials/use-actions-runner-controller/deploy-runner-scale-sets' - - href: '/actions/tutorials/use-actions-runner-controller/authenticate-to-the-api' - - href: '/actions/tutorials/use-actions-runner-controller/use-arc-in-a-workflow' - - href: '/actions/tutorials/use-actions-runner-controller/troubleshoot' + - href: /actions/tutorials/use-actions-runner-controller/quickstart + - href: /actions/tutorials/use-actions-runner-controller/deploy-runner-scale-sets + - href: /actions/tutorials/use-actions-runner-controller/authenticate-to-the-api + - href: /actions/tutorials/use-actions-runner-controller/use-arc-in-a-workflow + - href: /actions/tutorials/use-actions-runner-controller/troubleshoot children: - /quickstart - /deploy-runner-scale-sets @@ -26,5 +26,6 @@ redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller - /actions/tutorials/actions-runner-controller +contentType: tutorials --- diff --git a/content/actions/tutorials/use-actions-runner-controller/quickstart.md b/content/actions/tutorials/use-actions-runner-controller/quickstart.md index cde56265148a..23dfe78017cf 100644 --- a/content/actions/tutorials/use-actions-runner-controller/quickstart.md +++ b/content/actions/tutorials/use-actions-runner-controller/quickstart.md @@ -11,7 +11,7 @@ redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller - /actions/tutorials/quickstart-for-actions-runner-controller - /actions/tutorials/actions-runner-controller/quickstart-for-actions-runner-controller -contentType: get-started +contentType: tutorials category: - Set up runners --- diff --git a/content/actions/tutorials/use-actions-runner-controller/troubleshoot.md b/content/actions/tutorials/use-actions-runner-controller/troubleshoot.md index 39af1ff57edd..b90c6450225a 100644 --- a/content/actions/tutorials/use-actions-runner-controller/troubleshoot.md +++ b/content/actions/tutorials/use-actions-runner-controller/troubleshoot.md @@ -10,7 +10,7 @@ redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors - /actions/tutorials/actions-runner-controller/troubleshooting-actions-runner-controller-errors -contentType: how-tos +contentType: tutorials category: - Use and manage runners --- diff --git a/content/actions/tutorials/use-actions-runner-controller/use-arc-in-a-workflow.md b/content/actions/tutorials/use-actions-runner-controller/use-arc-in-a-workflow.md index 3c1a380bca50..4c3fec03ee9f 100644 --- a/content/actions/tutorials/use-actions-runner-controller/use-arc-in-a-workflow.md +++ b/content/actions/tutorials/use-actions-runner-controller/use-arc-in-a-workflow.md @@ -11,7 +11,7 @@ redirect_from: - /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow - /actions/how-tos/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow - /actions/tutorials/actions-runner-controller/using-actions-runner-controller-runners-in-a-workflow -contentType: concepts +contentType: tutorials category: - Use and manage runners --- diff --git a/content/actions/tutorials/use-containerized-services/index.md b/content/actions/tutorials/use-containerized-services/index.md index cf09a11a9575..28be9eeacf5a 100644 --- a/content/actions/tutorials/use-containerized-services/index.md +++ b/content/actions/tutorials/use-containerized-services/index.md @@ -1,7 +1,7 @@ --- title: Using containerized services shortTitle: Use containerized services -intro: 'You can use containerized services in your {% data variables.product.prodname_actions %} workflows.' +intro: You can use containerized services in your {% data variables.product.prodname_actions %} workflows. versions: fpt: '*' ghes: '*' @@ -19,4 +19,6 @@ children: - /use-docker-service-containers - /create-postgresql-service-containers - /create-redis-service-containers +contentType: tutorials --- + diff --git a/content/actions/tutorials/use-containerized-services/use-docker-service-containers.md b/content/actions/tutorials/use-containerized-services/use-docker-service-containers.md index 68325a1f4cd2..33268dde3802 100644 --- a/content/actions/tutorials/use-containerized-services/use-docker-service-containers.md +++ b/content/actions/tutorials/use-containerized-services/use-docker-service-containers.md @@ -15,7 +15,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' -contentType: concepts +contentType: tutorials category: - Build and test code --- diff --git a/content/code-security/getting-started/github-security-features.md b/content/code-security/getting-started/github-security-features.md index c78c310da9b8..f48422700db2 100644 --- a/content/code-security/getting-started/github-security-features.md +++ b/content/code-security/getting-started/github-security-features.md @@ -1,6 +1,6 @@ --- title: GitHub security features -intro: 'An overview of {% data variables.product.github %}''s security features.' +intro: An overview of {% data variables.product.github %}'s security features. versions: fpt: '*' ghes: '*' diff --git a/content/code-security/getting-started/index.md b/content/code-security/getting-started/index.md index 134020900d50..78bd6df6cf7c 100644 --- a/content/code-security/getting-started/index.md +++ b/content/code-security/getting-started/index.md @@ -15,4 +15,6 @@ children: - /github-security-features - /quickstart-for-securing-your-repository - /quickstart-for-securing-your-organization +contentType: get-started --- + diff --git a/content/code-security/getting-started/quickstart-for-securing-your-organization.md b/content/code-security/getting-started/quickstart-for-securing-your-organization.md index e76d595804c8..b9905790237c 100644 --- a/content/code-security/getting-started/quickstart-for-securing-your-organization.md +++ b/content/code-security/getting-started/quickstart-for-securing-your-organization.md @@ -1,6 +1,6 @@ --- title: Quickstart for securing your organization -intro: "You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your organization secure." +intro: You can use a number of {% data variables.product.prodname_dotcom %} features to help keep your organization secure. permissions: '{% data reusables.permissions.security-org-enable %}' redirect_from: - /code-security/getting-started/securing-your-organization diff --git a/content/code-security/getting-started/quickstart-for-securing-your-repository.md b/content/code-security/getting-started/quickstart-for-securing-your-repository.md index c70f36187ae5..7f5bbb139416 100644 --- a/content/code-security/getting-started/quickstart-for-securing-your-repository.md +++ b/content/code-security/getting-started/quickstart-for-securing-your-repository.md @@ -1,6 +1,6 @@ --- title: Quickstart for securing your repository -intro: 'Manage access to your code. Find and fix vulnerable code and dependencies automatically.' +intro: Manage access to your code. Find and fix vulnerable code and dependencies automatically. permissions: '{% data reusables.permissions.security-repo-enable %}' redirect_from: - /github/administering-a-repository/about-securing-your-repository diff --git a/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/remove-linked-artifacts.md b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/remove-linked-artifacts.md index 190a953f007e..44ae804dda08 100644 --- a/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/remove-linked-artifacts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/remove-linked-artifacts.md @@ -1,14 +1,14 @@ --- title: Removing artifacts from the {% data variables.product.virtual_registry %} -intro: "Set the storage and deployment status of artifacts to reflect that they are no longer in use." +intro: Set the storage and deployment status of artifacts to reflect that they are no longer in use. versions: feature: virtual-registry topics: - Vulnerabilities - Dependencies -contentType: concepts -product: 'Organization accounts on any plan' -permissions: 'Write access to the repository where an artifact is built' +contentType: how-tos +product: Organization accounts on any plan +permissions: Write access to the repository where an artifact is built shortTitle: Remove linked artifacts --- diff --git a/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/upload-linked-artifacts.md b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/upload-linked-artifacts.md index dea89c9bbc37..0937ac43f167 100644 --- a/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/upload-linked-artifacts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/upload-linked-artifacts.md @@ -1,14 +1,14 @@ --- title: Uploading storage and deployment data to the {% data variables.product.virtual_registry %} -intro: "Associate packages and builds in your organization with storage and deployment data." +intro: Associate packages and builds in your organization with storage and deployment data. versions: feature: virtual-registry topics: - Vulnerabilities - Dependencies -contentType: concepts -product: 'Organization accounts on any plan' -permissions: 'Anyone with write access to an organization-owned repository' +contentType: how-tos +product: Organization accounts on any plan +permissions: Anyone with write access to an organization-owned repository shortTitle: Upload linked artifacts --- diff --git a/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/view-linked-artifacts.md b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/view-linked-artifacts.md index 1ef7a7d933c2..2b5f2d09a6d2 100644 --- a/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/view-linked-artifacts.md +++ b/content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/view-linked-artifacts.md @@ -1,14 +1,14 @@ --- title: Auditing your organization's builds on the {% data variables.product.virtual_registry %} -intro: "View or export metadata for build runs, storage details, and deployment context." +intro: View or export metadata for build runs, storage details, and deployment context. versions: feature: virtual-registry topics: - Vulnerabilities - Dependencies -contentType: concepts -product: 'Organization accounts on any plan' -permissions: 'Anyone with read access to an organization-owned repository' +contentType: how-tos +product: Organization accounts on any plan +permissions: Anyone with read access to an organization-owned repository shortTitle: View linked artifacts --- diff --git a/content/code-security/index.md b/content/code-security/index.md index 7c210cca6ec0..844a86624208 100644 --- a/content/code-security/index.md +++ b/content/code-security/index.md @@ -48,4 +48,6 @@ children: - /reference - /tutorials - /responsible-use +contentType: landing --- + diff --git a/content/code-security/reference/supply-chain-security/java-package-metadata-dependabot.md b/content/code-security/reference/supply-chain-security/java-package-metadata-dependabot.md index d6c5b258c69d..6adcc55f1024 100644 --- a/content/code-security/reference/supply-chain-security/java-package-metadata-dependabot.md +++ b/content/code-security/reference/supply-chain-security/java-package-metadata-dependabot.md @@ -14,7 +14,7 @@ topics: redirect_from: - /code-security/dependabot/ecosystems-supported-by-dependabot/optimizing-java-packages-dependabot - /code-security/how-tos/secure-your-supply-chain/manage-your-dependency-security/optimizing-java-packages-dependabot -contentType: how-tos +contentType: reference --- {% data variables.product.prodname_dependabot %} uses the `url`, `scm`, and `issueManagement` fields in `pom.xml` files to create pull requests for Java dependency updates. When you include this metadata, pull requests will contain links to release notes and issue trackers, helping users update packages with confidence. 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/evaluating-default-setup-for-code-scanning.md index d96885f910e4..0de2878954eb 100644 --- a/content/code-security/tutorials/customize-code-scanning/evaluating-default-setup-for-code-scanning.md +++ b/content/code-security/tutorials/customize-code-scanning/evaluating-default-setup-for-code-scanning.md @@ -12,7 +12,7 @@ versions: ghec: '*' redirect_from: - /code-security/code-scanning/enabling-code-scanning/evaluating-default-setup-for-code-scanning -contentType: concepts +contentType: tutorials --- When you first start using {% data variables.product.prodname_code_scanning %}, you'll likely use default setup. This guide describes how to evaluate how default setup for {% data variables.product.prodname_code_scanning %} is working for you, and what steps to take if something isn't working as you expect. This guide also describes how you can customize {% data variables.product.prodname_code_scanning %} if you find that you have a specific use case that your new configuration doesn't fit. diff --git a/content/copilot/concepts/agents/about-agent-skills.md b/content/copilot/concepts/agents/about-agent-skills.md index 70f1c3f7ca3c..fa6f689dc765 100644 --- a/content/copilot/concepts/agents/about-agent-skills.md +++ b/content/copilot/concepts/agents/about-agent-skills.md @@ -1,13 +1,14 @@ --- title: About agent skills shortTitle: Agent skills -intro: 'Skills allow {% data variables.product.prodname_copilot_short %} to perform specialized tasks.' +intro: Skills allow {% data variables.product.prodname_copilot_short %} to perform specialized tasks. product: '{% data reusables.gated-features.copilot-coding-agent %}

{% data reusables.gated-features.copilot-cli %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot category: - Learn about Copilot - Learn about Copilot CLI +contentType: concepts --- > [!NOTE] diff --git a/content/copilot/concepts/agents/coding-agent/about-custom-agents.md b/content/copilot/concepts/agents/coding-agent/about-custom-agents.md index 14754caf0d4b..111aa7a2674c 100644 --- a/content/copilot/concepts/agents/coding-agent/about-custom-agents.md +++ b/content/copilot/concepts/agents/coding-agent/about-custom-agents.md @@ -6,6 +6,7 @@ versions: feature: copilot category: - Learn about Copilot +contentType: concepts --- ## About {% data variables.copilot.custom_agents_short %} diff --git a/content/copilot/concepts/copilot-usage-metrics/index.md b/content/copilot/concepts/copilot-usage-metrics/index.md index 702c4a413658..7344fb0544b1 100644 --- a/content/copilot/concepts/copilot-usage-metrics/index.md +++ b/content/copilot/concepts/copilot-usage-metrics/index.md @@ -27,4 +27,6 @@ includedCategories: - Measure success - View metrics - Understand available data +contentType: concepts --- + diff --git a/content/copilot/how-tos/copilot-cli/cli-best-practices.md b/content/copilot/how-tos/copilot-cli/cli-best-practices.md index d5e67da78429..188c8804a255 100644 --- a/content/copilot/how-tos/copilot-cli/cli-best-practices.md +++ b/content/copilot/how-tos/copilot-cli/cli-best-practices.md @@ -1,15 +1,15 @@ --- title: Best practices for GitHub Copilot CLI shortTitle: Copilot CLI best practices -intro: 'Learn how to get the most out of {% data variables.copilot.copilot_cli %}.' +intro: Learn how to get the most out of {% data variables.copilot.copilot_cli %}. allowTitleToDifferFromFilename: true versions: feature: copilot -contentType: get-started +contentType: how-tos category: - - Build with Copilot CLI # Copilot CLI bespoke page - - Copilot in the CLI # Copilot CLI bespoke page - - Author and optimize with Copilot # Copilot discovery page + - Build with Copilot CLI + - Copilot in the CLI + - Author and optimize with Copilot --- ## Introduction diff --git a/content/copilot/how-tos/copilot-cli/cli-getting-started.md b/content/copilot/how-tos/copilot-cli/cli-getting-started.md index f7cfb63885e1..df38e4c8fbfe 100644 --- a/content/copilot/how-tos/copilot-cli/cli-getting-started.md +++ b/content/copilot/how-tos/copilot-cli/cli-getting-started.md @@ -1,16 +1,16 @@ --- title: Getting started with GitHub Copilot CLI shortTitle: Copilot CLI quickstart -intro: 'Quickly learn how to use {% data variables.copilot.copilot_cli %}.' +intro: Quickly learn how to use {% data variables.copilot.copilot_cli %}. allowTitleToDifferFromFilename: true product: '{% data reusables.gated-features.copilot-cli %}' versions: feature: copilot -contentType: get-started +contentType: how-tos category: - - Build with Copilot CLI # Copilot CLI bespoke page - - Quickstarts # Copilot CLI bespoke page - - Author and optimize with Copilot # Copilot discovery page + - Build with Copilot CLI + - Quickstarts + - Author and optimize with Copilot --- ## Introduction diff --git a/content/copilot/how-tos/copilot-cli/index.md b/content/copilot/how-tos/copilot-cli/index.md index 99b3ce8dd338..4ee33224e5b4 100644 --- a/content/copilot/how-tos/copilot-cli/index.md +++ b/content/copilot/how-tos/copilot-cli/index.md @@ -4,7 +4,7 @@ shortTitle: '{% data variables.copilot.copilot_cli_short %}' intro: Use {% data variables.product.prodname_copilot_short %} directly from your terminal to answer questions, write and debug code, and interact with {% data variables.product.github %}. versions: feature: copilot -contentType: landing +contentType: how-tos layout: bespoke-landing heroImage: /assets/images/banner-images/hero-4 sidebarLink: @@ -14,9 +14,6 @@ introLinks: overview: /copilot/concepts/agents/copilot-cli/about-copilot-cli quickstart: /copilot/how-tos/copilot-cli/cli-getting-started children: - # Top-level articles and sub-categories in the Copilot How-to's are listed at the top of this list. - # This sets the order we show them in the side nav. - # All content from other directories and in any sub-directories can be added in any order underneath. - /cli-getting-started - /cli-best-practices - /set-up-copilot-cli @@ -64,3 +61,4 @@ includedCategories: - Build with Copilot CLI - Administer Copilot CLI --- + diff --git a/content/copilot/how-tos/copilot-sdk/sdk-getting-started.md b/content/copilot/how-tos/copilot-sdk/sdk-getting-started.md index aedc8f24a1e5..31db61ef6c7f 100644 --- a/content/copilot/how-tos/copilot-sdk/sdk-getting-started.md +++ b/content/copilot/how-tos/copilot-sdk/sdk-getting-started.md @@ -1,12 +1,12 @@ --- title: Getting started with Copilot SDK shortTitle: Quickstart -intro: 'Learn how to install {% data variables.copilot.copilot_sdk_short %} and send your first message.' +intro: Learn how to install {% data variables.copilot.copilot_sdk_short %} and send your first message. allowTitleToDifferFromFilename: true -product: '{% data reusables.gated-features.copilot-sdk %}' +product: '{% data reusables.gated-features.copilot-sdk %}' versions: feature: copilot -contentType: get-started +contentType: how-tos category: - Learn about Copilot - Author and optimize with Copilot diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents.md index 9c9d4fdfa647..1f1e07ca7717 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents.md +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents.md @@ -1,13 +1,14 @@ --- title: Creating custom agents for {% data variables.copilot.copilot_coding_agent %} shortTitle: Create custom agents -intro: 'You can create specialized agents with tailored expertise for specific development tasks.' +intro: You can create specialized agents with tailored expertise for specific development tasks. product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot category: - Configure Copilot - Author and optimize with Copilot +contentType: how-tos --- {% data variables.copilot.custom_agents_caps_short %} allow you to tailor {% data variables.product.prodname_copilot_short %}'s expertise for specific tasks. For a conceptual overview of {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). diff --git a/content/copilot/reference/copilot-billing/index.md b/content/copilot/reference/copilot-billing/index.md index 7d2c5801bb84..7e733fd5dd6e 100644 --- a/content/copilot/reference/copilot-billing/index.md +++ b/content/copilot/reference/copilot-billing/index.md @@ -9,4 +9,6 @@ children: - /seat-assignment - /license-changes - /azure-billing +contentType: reference --- + diff --git a/content/copilot/reference/copilot-cli-reference/index.md b/content/copilot/reference/copilot-cli-reference/index.md index 8d4f643888e0..42fa171b124a 100644 --- a/content/copilot/reference/copilot-cli-reference/index.md +++ b/content/copilot/reference/copilot-cli-reference/index.md @@ -1,7 +1,7 @@ --- title: '{% data variables.copilot.copilot_cli_short %} reference' shortTitle: '{% data variables.copilot.copilot_cli_short %} reference' -intro: 'Find information on options and settings for {% data variables.copilot.copilot_cli_short %}.' +intro: Find information on options and settings for {% data variables.copilot.copilot_cli_short %}. versions: feature: copilot children: @@ -9,4 +9,6 @@ children: - /cli-plugin-reference - /cli-programmatic-reference - /acp-server +contentType: reference --- + diff --git a/content/copilot/reference/copilot-feature-matrix.md b/content/copilot/reference/copilot-feature-matrix.md index 4520d10a82b7..c992394b9b9f 100644 --- a/content/copilot/reference/copilot-feature-matrix.md +++ b/content/copilot/reference/copilot-feature-matrix.md @@ -1,10 +1,11 @@ --- title: Copilot feature matrix -intro: 'Identify which IDEs support which {% data variables.product.prodname_copilot %} features.' +intro: Identify which IDEs support which {% data variables.product.prodname_copilot %} features. versions: feature: copilot category: - Learn about Copilot +contentType: reference --- > [!NOTE] diff --git a/content/copilot/reference/copilot-usage-metrics/index.md b/content/copilot/reference/copilot-usage-metrics/index.md index 4b5786ee2bdf..c0681927c4d6 100644 --- a/content/copilot/reference/copilot-usage-metrics/index.md +++ b/content/copilot/reference/copilot-usage-metrics/index.md @@ -10,4 +10,6 @@ children: - /reconciling-usage-metrics - /lines-of-code-metrics - /example-schema +contentType: reference --- + diff --git a/content/copilot/tutorials/customization-library/custom-agents/bug-fix-teammate.md b/content/copilot/tutorials/customization-library/custom-agents/bug-fix-teammate.md index ee422a751f68..cfbc25ee509e 100644 --- a/content/copilot/tutorials/customization-library/custom-agents/bug-fix-teammate.md +++ b/content/copilot/tutorials/customization-library/custom-agents/bug-fix-teammate.md @@ -9,6 +9,7 @@ complexity: octicon: copilot versions: feature: copilot +contentType: tutorials --- {% data reusables.copilot.custom-agents-examples-note %} diff --git a/content/copilot/tutorials/customization-library/custom-agents/cleanup-specialist.md b/content/copilot/tutorials/customization-library/custom-agents/cleanup-specialist.md index 4420e23a82a1..a392b4689b40 100644 --- a/content/copilot/tutorials/customization-library/custom-agents/cleanup-specialist.md +++ b/content/copilot/tutorials/customization-library/custom-agents/cleanup-specialist.md @@ -9,6 +9,7 @@ complexity: octicon: copilot versions: feature: copilot +contentType: tutorials --- {% data reusables.copilot.custom-agents-examples-note %} diff --git a/content/copilot/tutorials/customization-library/custom-agents/implementation-planner.md b/content/copilot/tutorials/customization-library/custom-agents/implementation-planner.md index dc895e58612d..1d799acddf91 100644 --- a/content/copilot/tutorials/customization-library/custom-agents/implementation-planner.md +++ b/content/copilot/tutorials/customization-library/custom-agents/implementation-planner.md @@ -9,6 +9,7 @@ complexity: octicon: copilot versions: feature: copilot +contentType: tutorials --- {% data reusables.copilot.custom-agents-examples-note %} diff --git a/content/copilot/tutorials/customization-library/custom-agents/index.md b/content/copilot/tutorials/customization-library/custom-agents/index.md index aad5b52e5b10..6405772b473d 100644 --- a/content/copilot/tutorials/customization-library/custom-agents/index.md +++ b/content/copilot/tutorials/customization-library/custom-agents/index.md @@ -1,7 +1,7 @@ --- title: Custom agents shortTitle: Custom agents -intro: 'Discover a collection of custom agent profiles you can use as inspiration for your own workflows and needs.' +intro: Discover a collection of custom agent profiles you can use as inspiration for your own workflows and needs. versions: feature: copilot children: @@ -9,4 +9,6 @@ children: - /implementation-planner - /bug-fix-teammate - /cleanup-specialist +contentType: tutorials --- + diff --git a/content/copilot/tutorials/customization-library/custom-instructions/github-actions-helper.md b/content/copilot/tutorials/customization-library/custom-instructions/github-actions-helper.md index b63e64687ba0..2d913ed990df 100644 --- a/content/copilot/tutorials/customization-library/custom-instructions/github-actions-helper.md +++ b/content/copilot/tutorials/customization-library/custom-instructions/github-actions-helper.md @@ -1,6 +1,6 @@ --- title: GitHub Actions helper -intro: 'Generate and improve {% data variables.product.prodname_actions %} workflows.' +intro: Generate and improve {% data variables.product.prodname_actions %} workflows. versions: feature: copilot category: @@ -12,6 +12,7 @@ category: complexity: - Simple octicon: book +contentType: tutorials --- {% data reusables.copilot.customization-examples-note %} diff --git a/content/copilot/tutorials/customization-library/custom-instructions/issue-manager.md b/content/copilot/tutorials/customization-library/custom-instructions/issue-manager.md index cfe5d4b5ba78..cb4f4b0ba3f1 100644 --- a/content/copilot/tutorials/customization-library/custom-instructions/issue-manager.md +++ b/content/copilot/tutorials/customization-library/custom-instructions/issue-manager.md @@ -1,6 +1,6 @@ --- title: Issue manager -intro: 'Create well-structured issues and responses.' +intro: Create well-structured issues and responses. versions: feature: copilot category: @@ -10,6 +10,7 @@ category: complexity: - Simple octicon: book +contentType: tutorials --- {% data reusables.copilot.customization-examples-note %} diff --git a/content/copilot/tutorials/customization-library/custom-instructions/pull-request-assistant.md b/content/copilot/tutorials/customization-library/custom-instructions/pull-request-assistant.md index 0b79011a6172..c742fd549e16 100644 --- a/content/copilot/tutorials/customization-library/custom-instructions/pull-request-assistant.md +++ b/content/copilot/tutorials/customization-library/custom-instructions/pull-request-assistant.md @@ -1,6 +1,6 @@ --- title: Pull request assistant -intro: 'Generate comprehensive pull request descriptions and reviews.' +intro: Generate comprehensive pull request descriptions and reviews. versions: feature: copilot category: @@ -10,6 +10,7 @@ category: complexity: - Simple octicon: book +contentType: tutorials --- {% data reusables.copilot.customization-examples-note %} diff --git a/content/copilot/tutorials/customization-library/custom-instructions/your-first-custom-instructions.md b/content/copilot/tutorials/customization-library/custom-instructions/your-first-custom-instructions.md index 64c0d66676d3..34fa4d7a8912 100644 --- a/content/copilot/tutorials/customization-library/custom-instructions/your-first-custom-instructions.md +++ b/content/copilot/tutorials/customization-library/custom-instructions/your-first-custom-instructions.md @@ -1,6 +1,6 @@ --- title: Your first custom instructions -intro: 'Create and test your first custom instruction with this simple example.' +intro: Create and test your first custom instruction with this simple example. versions: feature: copilot category: @@ -10,6 +10,7 @@ category: complexity: - Simple octicon: book +contentType: tutorials --- {% data reusables.copilot.customization-examples-note %} diff --git a/content/integrations/concepts/about-building-integrations.md b/content/integrations/concepts/about-building-integrations.md index 2e3956ecd891..833706f0a8df 100644 --- a/content/integrations/concepts/about-building-integrations.md +++ b/content/integrations/concepts/about-building-integrations.md @@ -1,6 +1,6 @@ --- title: About building integrations -intro: 'You can build integrations to extend {% data variables.product.company_short %}''s functionality.' +intro: You can build integrations to extend {% data variables.product.company_short %}'s functionality. redirect_from: - /get-started/exploring-integrations/about-building-integrations versions: @@ -10,6 +10,7 @@ versions: category: - Learn about integrations - Build integrations +contentType: concepts --- Integrations are tools that extend {% data variables.product.company_short %}'s functionality. Integrations can do things on {% data variables.product.company_short %} like open issues, comment on pull requests, and manage projects. They can also do things outside of {% data variables.product.company_short %} based on events that happen on {% data variables.product.company_short %}. For example, an integration can post on Slack when an issue is opened on {% data variables.product.company_short %}. diff --git a/content/integrations/concepts/about-integrations.md b/content/integrations/concepts/about-integrations.md index 857fba771bcb..f58ac7ede315 100644 --- a/content/integrations/concepts/about-integrations.md +++ b/content/integrations/concepts/about-integrations.md @@ -1,16 +1,17 @@ --- title: About GitHub integrations shortTitle: About integrations -intro: 'Learn how to connect, extend, and customize GitHub with apps and tools.' +intro: Learn how to connect, extend, and customize GitHub with apps and tools. redirect_from: - /get-started/exploring-integrations/about-integrations - /get-started/exploring-integrations/about-using-integrations versions: - fpt: '*' - ghes: '*' - ghec: '*' + fpt: '*' + ghes: '*' + ghec: '*' category: - Learn about integrations +contentType: concepts --- Integrations are tools that extend {% data variables.product.github %} functionality by allowing you to connect your {% data variables.product.github %} account with other applications and services, enabling you to streamline your workflow and enhance collaboration. diff --git a/content/integrations/concepts/featured-github-integrations.md b/content/integrations/concepts/featured-github-integrations.md index f343747f54da..ffecb6467620 100644 --- a/content/integrations/concepts/featured-github-integrations.md +++ b/content/integrations/concepts/featured-github-integrations.md @@ -1,6 +1,6 @@ --- title: Featured GitHub integrations -intro: 'Use {% data variables.product.github %} extensions to work seamlessly in repositories on {% data variables.location.product_location %} within third-party applications.' +intro: Use {% data variables.product.github %} extensions to work seamlessly in repositories on {% data variables.location.product_location %} within third-party applications. redirect_from: - /articles/about-github-extensions-for-third-party-applications - /articles/github-extensions-and-integrations @@ -16,6 +16,7 @@ versions: shortTitle: Featured integrations category: - Learn about integrations +contentType: concepts --- {% ifversion fpt or ghec %} diff --git a/content/integrations/concepts/github-developer-program.md b/content/integrations/concepts/github-developer-program.md index 164dcff1bf7d..d9836abe2e41 100644 --- a/content/integrations/concepts/github-developer-program.md +++ b/content/integrations/concepts/github-developer-program.md @@ -1,6 +1,6 @@ --- title: GitHub Developer Program -intro: 'If you build tools that integrate with GitHub, you can join the GitHub Developer Program.' +intro: If you build tools that integrate with GitHub, you can join the GitHub Developer Program. redirect_from: - /program - /developers/overview/github-developer-program @@ -11,6 +11,7 @@ versions: category: - Learn about integrations - Build integrations +contentType: concepts --- Building an application that integrates with {% data variables.product.github %}? Register for our Developer Program! The possibilities are endless, and you enjoy the kudos. [Register now](https://github.com/developer/register). diff --git a/content/integrations/how-tos/slack/customize-notifications.md b/content/integrations/how-tos/slack/customize-notifications.md index f3895e5a87da..f3a5d2359c8e 100644 --- a/content/integrations/how-tos/slack/customize-notifications.md +++ b/content/integrations/how-tos/slack/customize-notifications.md @@ -1,12 +1,12 @@ --- title: Customizing notifications for GitHub in Slack shortTitle: Customize notifications -intro: 'Learn how to customize notifications for GitHub in Slack.' +intro: Learn how to customize notifications for GitHub in Slack. versions: fpt: '*' ghes: '*' ghec: '*' -contentType: reference +contentType: how-tos category: - Use integrations --- diff --git a/content/integrations/how-tos/slack/integrate-github-with-slack.md b/content/integrations/how-tos/slack/integrate-github-with-slack.md index 2d66d58842fe..d954c7751ed2 100644 --- a/content/integrations/how-tos/slack/integrate-github-with-slack.md +++ b/content/integrations/how-tos/slack/integrate-github-with-slack.md @@ -1,13 +1,14 @@ --- title: Integrating GitHub with Slack shortTitle: Integrate GitHub with Slack -intro: 'Learn how to integrate GitHub with Slack to improve collaboration and streamline workflows.' +intro: Learn how to integrate GitHub with Slack to improve collaboration and streamline workflows. versions: - fpt: '*' - ghes: '*' - ghec: '*' + fpt: '*' + ghes: '*' + ghec: '*' category: - Administer integrations +contentType: how-tos --- ## About the {% data variables.product.github %} integration for Slack diff --git a/content/integrations/how-tos/slack/use-github-in-slack.md b/content/integrations/how-tos/slack/use-github-in-slack.md index ec6137895630..f863ff213ac0 100644 --- a/content/integrations/how-tos/slack/use-github-in-slack.md +++ b/content/integrations/how-tos/slack/use-github-in-slack.md @@ -1,13 +1,14 @@ --- title: Using GitHub in Slack shortTitle: Use GitHub in Slack -intro: 'Learn how to use GitHub in Slack to improve collaboration and streamline your workflow.' +intro: Learn how to use GitHub in Slack to improve collaboration and streamline your workflow. versions: - fpt: '*' - ghes: '*' - ghec: '*' + fpt: '*' + ghes: '*' + ghec: '*' category: - Use integrations +contentType: how-tos --- The {% data variables.product.github %} integration for Slack allows you to connect your {% data variables.product.github %} account to the {% data variables.product.github %} app in Slack. Once connected, you can use slash commands to interact with {% data variables.product.github %}, receive notifications about repository activity, and collaborate with your team directly within Slack. diff --git a/content/integrations/how-tos/teams/customize-notifications.md b/content/integrations/how-tos/teams/customize-notifications.md index e9c78d0a71dd..1a2423c32e06 100644 --- a/content/integrations/how-tos/teams/customize-notifications.md +++ b/content/integrations/how-tos/teams/customize-notifications.md @@ -1,12 +1,12 @@ --- -title: 'Customizing notifications for {% data variables.product.github %} in Teams' +title: Customizing notifications for {% data variables.product.github %} in Teams shortTitle: Customize notifications -intro: 'Customize {% data variables.product.github %} notifications to manage your work within Teams.' +intro: Customize {% data variables.product.github %} notifications to manage your work within Teams. versions: fpt: '*' ghes: '*' ghec: '*' -contentType: reference +contentType: how-tos --- You can customize your notifications by subscribing to activity that is relevant to your Microsoft Teams channel, and unsubscribing from activity that is less helpful to your project. diff --git a/content/integrations/how-tos/teams/integrate-github-with-teams.md b/content/integrations/how-tos/teams/integrate-github-with-teams.md index cd4ce8fb6f71..e61c92a71315 100644 --- a/content/integrations/how-tos/teams/integrate-github-with-teams.md +++ b/content/integrations/how-tos/teams/integrate-github-with-teams.md @@ -1,11 +1,12 @@ --- -title: 'Integrating {% data variables.product.github %} with Teams' +title: Integrating {% data variables.product.github %} with Teams shortTitle: Integrate GitHub with Teams -intro: 'Set up the GitHub integration with Teams to improve collaboration and streamline workflows.' +intro: Set up the GitHub integration with Teams to improve collaboration and streamline workflows. versions: - fpt: '*' - ghes: '*' - ghec: '*' + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos --- ## About the {% data variables.product.github %} integration for Teams diff --git a/content/integrations/how-tos/teams/use-github-in-teams.md b/content/integrations/how-tos/teams/use-github-in-teams.md index 9d17060d8cd9..6730629d4c8b 100644 --- a/content/integrations/how-tos/teams/use-github-in-teams.md +++ b/content/integrations/how-tos/teams/use-github-in-teams.md @@ -1,11 +1,12 @@ --- -title: 'Using {% data variables.product.github %} in Teams' -shortTitle: 'Use GitHub in Teams' -intro: 'Learn how to use {% data variables.product.github %} in Teams to improve collaboration and streamline your workflow.' +title: Using {% data variables.product.github %} in Teams +shortTitle: Use GitHub in Teams +intro: Learn how to use {% data variables.product.github %} in Teams to improve collaboration and streamline your workflow. versions: - fpt: '*' - ghes: '*' - ghec: '*' + fpt: '*' + ghes: '*' + ghec: '*' +contentType: how-tos --- The {% data variables.product.github %} integration for Microsoft Teams lets you connect your {% data variables.product.github %} account to the {% data variables.product.github %} app in Teams. Once connected, you can subscribe to notifications, run commands, and collaborate on issues and pull requests directly within Teams. diff --git a/content/integrations/tutorials/index.md b/content/integrations/tutorials/index.md index 4ec949670ed1..3ee60d5d5aff 100644 --- a/content/integrations/tutorials/index.md +++ b/content/integrations/tutorials/index.md @@ -1,13 +1,14 @@ --- title: Tutorials for GitHub integrations shortTitle: Tutorials -intro: 'Build skills and knowledge about {% data variables.product.github %} Integrations through examples and hands-on activities.' +intro: Build skills and knowledge about {% data variables.product.github %} Integrations through examples and hands-on activities. versions: fpt: '*' ghes: '*' ghec: '*' children: - - /slack - - /teams -contentType: reference + - /slack + - /teams +contentType: tutorials --- + diff --git a/content/integrations/tutorials/slack/create-issues.md b/content/integrations/tutorials/slack/create-issues.md index 3b41c3e6318a..3a57aea468ba 100644 --- a/content/integrations/tutorials/slack/create-issues.md +++ b/content/integrations/tutorials/slack/create-issues.md @@ -1,12 +1,12 @@ --- title: Creating issues with the GitHub integration in Slack shortTitle: Create issues -intro: 'Learn how to create issues with the {% data variables.product.github %} integration in Slack.' +intro: Learn how to create issues with the {% data variables.product.github %} integration in Slack. versions: fpt: '*' ghes: '*' ghec: '*' -contentType: reference +contentType: tutorials category: - Use integrations --- diff --git a/content/integrations/tutorials/slack/index.md b/content/integrations/tutorials/slack/index.md index f776b179cf66..bb0833e7fc0e 100644 --- a/content/integrations/tutorials/slack/index.md +++ b/content/integrations/tutorials/slack/index.md @@ -1,13 +1,14 @@ --- title: Tutorials for the GitHub Slack integration shortTitle: Slack -intro: 'Build skills and knowledge about the {% data variables.product.github %} Slack integration through examples and hands-on activities.' +intro: Build skills and knowledge about the {% data variables.product.github %} Slack integration through examples and hands-on activities. versions: fpt: '*' ghes: '*' ghec: '*' children: - - /create-issues - - /manage-issues -contentType: reference + - /create-issues + - /manage-issues +contentType: tutorials --- + diff --git a/content/integrations/tutorials/slack/manage-issues.md b/content/integrations/tutorials/slack/manage-issues.md index 08fd7c21d976..1b8ff766c239 100644 --- a/content/integrations/tutorials/slack/manage-issues.md +++ b/content/integrations/tutorials/slack/manage-issues.md @@ -1,12 +1,12 @@ --- title: Managing issues with the GitHub integration in Slack shortTitle: Manage issues -intro: 'Learn how to manage issues with the {% data variables.product.github %} integration in Slack.' +intro: Learn how to manage issues with the {% data variables.product.github %} integration in Slack. versions: fpt: '*' ghes: '*' ghec: '*' -contentType: reference +contentType: tutorials category: - Use integrations --- diff --git a/content/integrations/tutorials/teams/create-issues.md b/content/integrations/tutorials/teams/create-issues.md index 086392c5e998..42ab2602b03d 100644 --- a/content/integrations/tutorials/teams/create-issues.md +++ b/content/integrations/tutorials/teams/create-issues.md @@ -1,12 +1,12 @@ --- title: Creating issues with the GitHub integration in Teams shortTitle: Create issues -intro: 'Learn how to create issues with the {% data variables.product.github %} integration in Teams.' +intro: Learn how to create issues with the {% data variables.product.github %} integration in Teams. versions: fpt: '*' ghes: '*' ghec: '*' -contentType: reference +contentType: tutorials --- ## Creating issues with the {% data variables.product.github %} integration in Teams diff --git a/content/integrations/tutorials/teams/index.md b/content/integrations/tutorials/teams/index.md index ad42186149ff..e6e047a6c841 100644 --- a/content/integrations/tutorials/teams/index.md +++ b/content/integrations/tutorials/teams/index.md @@ -1,13 +1,14 @@ --- title: Tutorials for the GitHub Teams integration shortTitle: Teams -intro: 'Build skills and knowledge about the {% data variables.product.github %} Teams integration through examples and hands-on activities.' +intro: Build skills and knowledge about the {% data variables.product.github %} Teams integration through examples and hands-on activities. versions: fpt: '*' ghes: '*' ghec: '*' children: - - /create-issues - - /manage-issues -contentType: reference + - /create-issues + - /manage-issues +contentType: tutorials --- + diff --git a/content/integrations/tutorials/teams/manage-issues.md b/content/integrations/tutorials/teams/manage-issues.md index e62939e713c1..50caec3833d7 100644 --- a/content/integrations/tutorials/teams/manage-issues.md +++ b/content/integrations/tutorials/teams/manage-issues.md @@ -2,12 +2,12 @@ title: Managing issues with the GitHub integration in Teams shortTitle: Manage issues and PRs allowTitleToDifferFromFilename: true -intro: 'Learn how to manage issues and pull requests with the {% data variables.product.github %} integration in Teams.' +intro: Learn how to manage issues and pull requests with the {% data variables.product.github %} integration in Teams. versions: fpt: '*' ghes: '*' ghec: '*' -contentType: reference +contentType: tutorials --- ## Managing issues in Teams diff --git a/content/subscriptions-and-notifications/concepts/about-notifications.md b/content/subscriptions-and-notifications/concepts/about-notifications.md index 1ae352e07d1e..0b7b61087117 100644 --- a/content/subscriptions-and-notifications/concepts/about-notifications.md +++ b/content/subscriptions-and-notifications/concepts/about-notifications.md @@ -1,6 +1,6 @@ --- title: About notifications -intro: 'Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} that you''ve subscribed to. You can use the notifications inbox to customize, triage, and manage your updates.' +intro: Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} that you've subscribed to. You can use the notifications inbox to customize, triage, and manage your updates. redirect_from: - /articles/notifications - /articles/about-notifications @@ -13,6 +13,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' +contentType: concepts --- ## Notifications and subscriptions diff --git a/content/subscriptions-and-notifications/concepts/index.md b/content/subscriptions-and-notifications/concepts/index.md index 08ae8ceac0c3..a18898b83fed 100644 --- a/content/subscriptions-and-notifications/concepts/index.md +++ b/content/subscriptions-and-notifications/concepts/index.md @@ -9,5 +9,6 @@ versions: children: - /about-notifications - /scheduled-reminders +contentType: concepts --- diff --git a/content/subscriptions-and-notifications/get-started/configuring-notifications.md b/content/subscriptions-and-notifications/get-started/configuring-notifications.md index a17f375bbda1..8e7e997153a5 100644 --- a/content/subscriptions-and-notifications/get-started/configuring-notifications.md +++ b/content/subscriptions-and-notifications/get-started/configuring-notifications.md @@ -1,6 +1,6 @@ --- title: Configuring notifications -intro: 'Choose the type of activity on {% data variables.product.prodname_dotcom %} that you want to receive notifications for and how you want these updates delivered.' +intro: Choose the type of activity on {% data variables.product.prodname_dotcom %} that you want to receive notifications for and how you want these updates delivered. redirect_from: - /articles/about-web-notifications - /format-of-notification-emails @@ -21,6 +21,7 @@ versions: fpt: '*' ghes: '*' ghec: '*' +contentType: get-started --- ## Notification delivery options diff --git a/content/subscriptions-and-notifications/get-started/index.md b/content/subscriptions-and-notifications/get-started/index.md index 7d5350d362ba..6c5b2ddf8448 100644 --- a/content/subscriptions-and-notifications/get-started/index.md +++ b/content/subscriptions-and-notifications/get-started/index.md @@ -1,7 +1,7 @@ --- title: Get started with your GitHub subscriptions and notifications shortTitle: Get started -intro: 'Learn about configuring your {% data variables.product.github %} notifications and subscriptions.' +intro: Learn about configuring your {% data variables.product.github %} notifications and subscriptions. redirect_from: - /articles/getting-started-with-notifications - /github/managing-subscriptions-and-notifications-on-github/setting-up-notifications @@ -13,4 +13,6 @@ versions: ghec: '*' children: - /configuring-notifications +contentType: get-started --- + diff --git a/content/subscriptions-and-notifications/how-tos/index.md b/content/subscriptions-and-notifications/how-tos/index.md index 884e03b85fde..5edd135808e9 100644 --- a/content/subscriptions-and-notifications/how-tos/index.md +++ b/content/subscriptions-and-notifications/how-tos/index.md @@ -14,5 +14,6 @@ children: - /managing-your-scheduled-reminders - /managing-security-notifications - /managing-marketing-emails-from-github +contentType: how-tos --- diff --git a/content/subscriptions-and-notifications/how-tos/managing-github-actions-notifications.md b/content/subscriptions-and-notifications/how-tos/managing-github-actions-notifications.md index fe014ba08591..99cbb9257a00 100644 --- a/content/subscriptions-and-notifications/how-tos/managing-github-actions-notifications.md +++ b/content/subscriptions-and-notifications/how-tos/managing-github-actions-notifications.md @@ -6,6 +6,7 @@ versions: ghec: '*' ghes: '*' shortTitle: Manage Actions notifications +contentType: how-tos --- For repositories that are set up with {% data variables.product.prodname_actions %} and that you are watching, you can choose how you want to receive workflow run updates. diff --git a/content/subscriptions-and-notifications/how-tos/managing-marketing-emails-from-github.md b/content/subscriptions-and-notifications/how-tos/managing-marketing-emails-from-github.md index 64e5d71424ca..2d7ae4f8350e 100644 --- a/content/subscriptions-and-notifications/how-tos/managing-marketing-emails-from-github.md +++ b/content/subscriptions-and-notifications/how-tos/managing-marketing-emails-from-github.md @@ -13,6 +13,7 @@ versions: fpt: '*' ghec: '*' shortTitle: Manage marketing emails +contentType: how-tos --- ## Managing {% data variables.product.prodname_dotcom %} marketing emails diff --git a/content/subscriptions-and-notifications/how-tos/managing-organization-notifications.md b/content/subscriptions-and-notifications/how-tos/managing-organization-notifications.md index 5b73e5a77f78..03d6e9bc8ee8 100644 --- a/content/subscriptions-and-notifications/how-tos/managing-organization-notifications.md +++ b/content/subscriptions-and-notifications/how-tos/managing-organization-notifications.md @@ -6,6 +6,7 @@ versions: ghec: '*' ghes: '*' shortTitle: Manage organization notifications +contentType: how-tos --- ## Organization alerts notification options diff --git a/content/subscriptions-and-notifications/how-tos/managing-security-notifications.md b/content/subscriptions-and-notifications/how-tos/managing-security-notifications.md index 787837419d0f..ba7343e3bd38 100644 --- a/content/subscriptions-and-notifications/how-tos/managing-security-notifications.md +++ b/content/subscriptions-and-notifications/how-tos/managing-security-notifications.md @@ -6,6 +6,7 @@ versions: ghec: '*' ghes: '*' shortTitle: Manage security notifications +contentType: how-tos --- ## {% data variables.product.prodname_dependabot_alerts %} notification options diff --git a/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/index.md b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/index.md index 7ecbdd92c473..ee723b1d0393 100644 --- a/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/index.md +++ b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/index.md @@ -1,6 +1,6 @@ --- title: Managing subscriptions for activity on GitHub -intro: 'To maintain sustainable notification workflows, understand and regularly review your subscriptions.' +intro: To maintain sustainable notification workflows, understand and regularly review your subscriptions. redirect_from: - /github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github - /account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github @@ -13,5 +13,6 @@ children: - /viewing-your-subscriptions - /managing-your-subscriptions shortTitle: Manage subscriptions +contentType: how-tos --- diff --git a/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md index 99135aad30e5..8262fde9f917 100644 --- a/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md +++ b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md @@ -1,6 +1,6 @@ --- title: Managing your subscriptions -intro: 'To help you manage your notifications efficiently, there are several ways to unsubscribe.' +intro: To help you manage your notifications efficiently, there are several ways to unsubscribe. versions: fpt: '*' ghes: '*' @@ -11,6 +11,7 @@ redirect_from: - /account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions - /subscriptions-and-notifications/managing-subscriptions-for-activity-on-github/managing-your-subscriptions shortTitle: Manage your subscriptions +contentType: how-tos --- To help you understand your subscriptions and decide whether to unsubscribe, see [AUTOTITLE](/subscriptions-and-notifications/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions). diff --git a/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md index eb94e9cb9104..c58116cfb039 100644 --- a/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md +++ b/content/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md @@ -1,6 +1,6 @@ --- title: Viewing your subscriptions -intro: 'To understand where your notifications are coming from and your notifications volume, we recommend reviewing your subscriptions and watched repositories regularly.' +intro: To understand where your notifications are coming from and your notifications volume, we recommend reviewing your subscriptions and watched repositories regularly. redirect_from: - /articles/subscribing-to-conversations - /articles/unsubscribing-from-conversations @@ -23,6 +23,7 @@ versions: ghes: '*' ghec: '*' shortTitle: View subscriptions +contentType: how-tos --- You receive notifications for your subscriptions of ongoing activity on {% data variables.product.github %}. There are many reasons you can be subscribed to a conversation. For more information, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications#notifications-and-subscriptions). diff --git a/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/index.md b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/index.md index 0483b47b5cc4..4589fcca0c7d 100644 --- a/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/index.md +++ b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/index.md @@ -15,5 +15,6 @@ children: - /managing-notifications-from-your-inbox - /triaging-a-single-notification shortTitle: Customize a workflow +contentType: how-tos --- diff --git a/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index 371e4b0a3ace..e59e9a5a0ae5 100644 --- a/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -13,6 +13,7 @@ versions: ghes: '*' ghec: '*' shortTitle: Manage from your inbox +contentType: how-tos --- ## Prerequisites diff --git a/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/triaging-a-single-notification.md b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/triaging-a-single-notification.md index 2628dcab92b2..367c6915e49c 100644 --- a/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/triaging-a-single-notification.md +++ b/content/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/triaging-a-single-notification.md @@ -1,6 +1,6 @@ --- title: Triaging a single notification -intro: 'When you review and investigate a single notification, you have several triaging options that are optimized for the detailed notification view.' +intro: When you review and investigate a single notification, you have several triaging options that are optimized for the detailed notification view. versions: fpt: '*' ghes: '*' @@ -11,6 +11,7 @@ redirect_from: - /account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification - /subscriptions-and-notifications/viewing-and-triaging-notifications/triaging-a-single-notification shortTitle: Triage a notification +contentType: how-tos --- ## Saving a single notification diff --git a/content/subscriptions-and-notifications/index.md b/content/subscriptions-and-notifications/index.md index 538fb0a77327..3d116b9742a5 100644 --- a/content/subscriptions-and-notifications/index.md +++ b/content/subscriptions-and-notifications/index.md @@ -1,6 +1,6 @@ --- title: Subscriptions and notifications documentation -intro: 'You can specify how to receive notifications, the repositories you are interested in, and the types of activity you want to hear about.' +intro: You can specify how to receive notifications, the repositories you are interested in, and the types of activity you want to hear about. redirect_from: - /categories/76/articles - /categories/notifications @@ -26,5 +26,6 @@ children: - /tutorials - /reference shortTitle: Subscriptions & notifications +contentType: landing --- diff --git a/content/subscriptions-and-notifications/reference/email-notification-headers.md b/content/subscriptions-and-notifications/reference/email-notification-headers.md index 32ea98bbc5d7..146f7b1cdc09 100644 --- a/content/subscriptions-and-notifications/reference/email-notification-headers.md +++ b/content/subscriptions-and-notifications/reference/email-notification-headers.md @@ -1,10 +1,11 @@ --- title: Email notification headers -intro: 'Learn how to filter email notifications by using information in the headers.' +intro: Learn how to filter email notifications by using information in the headers. versions: fpt: '*' ghes: '*' ghec: '*' +contentType: reference --- Each email notification that {% data variables.product.prodname_dotcom %} sends contains header information. The header information in every email is consistent, so you can use it in your email client to filter or forward all {% data variables.product.prodname_dotcom %} notifications, or certain types of {% data variables.product.prodname_dotcom %} notifications. diff --git a/content/subscriptions-and-notifications/reference/inbox-filters.md b/content/subscriptions-and-notifications/reference/inbox-filters.md index a0cd04590e7e..51239439fbd3 100644 --- a/content/subscriptions-and-notifications/reference/inbox-filters.md +++ b/content/subscriptions-and-notifications/reference/inbox-filters.md @@ -1,10 +1,11 @@ --- title: Inbox filters -intro: 'Learn about filtering notifications in your {% data variables.product.prodname_dotcom %} inbox.' +intro: Learn about filtering notifications in your {% data variables.product.prodname_dotcom %} inbox. versions: fpt: '*' ghes: '*' ghec: '*' +contentType: reference --- You can create custom filters for your inbox using the following supported filters. For more information about creating custom filters, see [AUTOTITLE](/subscriptions-and-notifications/how-tos/viewing-and-triaging-notifications/managing-notifications-from-your-inbox#customizing-your-inbox-with-custom-filters). diff --git a/content/subscriptions-and-notifications/reference/index.md b/content/subscriptions-and-notifications/reference/index.md index ffa6c694e2a6..43011d449f5f 100644 --- a/content/subscriptions-and-notifications/reference/index.md +++ b/content/subscriptions-and-notifications/reference/index.md @@ -10,5 +10,6 @@ children: - /inbox-filters - /email-notification-headers - /types-of-emails-github-sends +contentType: reference --- diff --git a/content/subscriptions-and-notifications/tutorials/customizing-a-workflow-for-triaging-your-notifications.md b/content/subscriptions-and-notifications/tutorials/customizing-a-workflow-for-triaging-your-notifications.md index d71c8e50db5d..5e21cf7d47ab 100644 --- a/content/subscriptions-and-notifications/tutorials/customizing-a-workflow-for-triaging-your-notifications.md +++ b/content/subscriptions-and-notifications/tutorials/customizing-a-workflow-for-triaging-your-notifications.md @@ -1,6 +1,6 @@ --- title: Customizing a workflow for triaging your notifications -intro: 'To create an ideal workflow for triaging your notifications, you can adapt and customize these example workflows.' +intro: To create an ideal workflow for triaging your notifications, you can adapt and customize these example workflows. versions: fpt: '*' ghes: '*' @@ -11,6 +11,7 @@ redirect_from: - /account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications - /subscriptions-and-notifications/viewing-and-triaging-notifications/customizing-a-workflow-for-triaging-your-notifications shortTitle: Triage your notifications +contentType: tutorials --- ## Starting your inbox triage diff --git a/content/subscriptions-and-notifications/tutorials/index.md b/content/subscriptions-and-notifications/tutorials/index.md index c0db9ceac763..7a666833f1ee 100644 --- a/content/subscriptions-and-notifications/tutorials/index.md +++ b/content/subscriptions-and-notifications/tutorials/index.md @@ -1,11 +1,13 @@ --- title: Tutorials for your GitHub notifications shortTitle: Tutorials -intro: 'Build skills and knowledge about your {% data variables.product.github %} notifications.' +intro: Build skills and knowledge about your {% data variables.product.github %} notifications. versions: fpt: '*' ghes: '*' ghec: '*' children: - /customizing-a-workflow-for-triaging-your-notifications +contentType: tutorials --- + diff --git a/data/reusables/contributing/content-linter-rules.md b/data/reusables/contributing/content-linter-rules.md index 7a25fe2c0a7a..1ed859c8cb10 100644 --- a/data/reusables/contributing/content-linter-rules.md +++ b/data/reusables/contributing/content-linter-rules.md @@ -67,6 +67,7 @@ | GHD062 | frontmatter-intro-links | introLinks keys must be valid keys defined in data/ui.yml under product_landing | error | frontmatter, single-source | | GHD063 | frontmatter-children | Children frontmatter paths must exist. Supports relative paths and absolute /content/ paths for cross-product inclusion. | error | frontmatter, children | | GHD064 | rai-app-card-structure | RAI application/platform card articles must follow the required template structure | warning | feature, rai | +| GHD065 | frontmatter-content-type | Content files in content-type directories must have a contentType frontmatter property that matches the parent directory. | error | frontmatter, content-type | | [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon- | The octicon liquid syntax used is deprecated. Use this format instead `octicon "" aria-label=""` | error | | | [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | | | [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | | diff --git a/src/content-linter/lib/linting-rules/frontmatter-content-type.ts b/src/content-linter/lib/linting-rules/frontmatter-content-type.ts new file mode 100644 index 000000000000..7130d18edd12 --- /dev/null +++ b/src/content-linter/lib/linting-rules/frontmatter-content-type.ts @@ -0,0 +1,163 @@ +import fs from 'fs' +import path from 'path' +import { addError } from 'markdownlint-rule-helpers' + +import { getFrontmatter } from '../helpers/utils' +import { contentTypesEnum } from '@/frame/lib/frontmatter' +import type { RuleParams, RuleErrorCallback } from '@/content-linter/types' + +const RESPONSIBLE_USE_STRING = 'responsible-use' +const GETTING_STARTED_STRING = 'getting-started' + +// Directory names that correspond to a known content type. +// This includes the canonical contentType values (minus the special-purpose +// ones: homepage, landing, rai, other) plus directory-name aliases: +// - "responsible-use" → contentType "rai" +// - "getting-started" → contentType "get-started" (some products use this variant) +const KNOWN_CONTENT_TYPE_DIRS = new Set([ + ...contentTypesEnum.filter((t) => !['homepage', 'landing', 'rai', 'other'].includes(t)), + RESPONSIBLE_USE_STRING, + GETTING_STARTED_STRING, +]) + +// Lazily computed set of product directories whose subdirectories all follow +// the content-type directory pattern. Once computed the set is reused for +// every file processed in the same lint run. +let qualifyingProducts: Set | null = null + +/** + * Scan `content/` and return the set of product directory names whose + * **immediate** subdirectories are all in `KNOWN_CONTENT_TYPE_DIRS`. + */ +function getQualifyingProducts(): Set { + if (qualifyingProducts) return qualifyingProducts + + const contentDir = path.resolve(process.env.ROOT || '.', 'content') + const products = new Set() + + for (const entry of fs.readdirSync(contentDir, { withFileTypes: true })) { + if (!entry.isDirectory()) continue + if (entry.name === 'early-access') continue + + const productPath = path.join(contentDir, entry.name) + const subdirs = fs + .readdirSync(productPath, { withFileTypes: true }) + .filter((e) => e.isDirectory()) + + // Skip products with no subdirectories (e.g. flat products) + if (subdirs.length === 0) continue + + // A product qualifies when ALL of its subdirectories are known + // content-type directories. Use .includes() for responsible-use so + // that variations like "responsible-use-of-…" are recognised, matching + // the logic in dirToContentType(). + const isKnownDir = (name: string) => + KNOWN_CONTENT_TYPE_DIRS.has(name) || name.includes(RESPONSIBLE_USE_STRING) + if (subdirs.every((sub) => isKnownDir(sub.name))) { + products.add(entry.name) + } + } + + qualifyingProducts = products + return products +} + +/** Map a directory name to its expected `contentType` value. */ +function dirToContentType(dirName: string): string { + if (dirName.includes(RESPONSIBLE_USE_STRING)) return 'rai' + if (dirName === GETTING_STARTED_STRING) return 'get-started' + if (contentTypesEnum.includes(dirName)) return dirName + return 'other' +} + +/** + * Reset the cached qualifying-products set. Exported so that tests can + * call it between test cases if the filesystem fixture changes. + */ +export function resetCache(): void { + qualifyingProducts = null +} + +export const frontmatterContentType = { + names: ['GHD065', 'frontmatter-content-type'], + description: + 'Content files in content-type directories must have a contentType frontmatter property that matches the parent directory.', + tags: ['frontmatter', 'content-type'], + function: (params: RuleParams, onError: RuleErrorCallback) => { + const filePath = params.name + const contentDir = path.resolve(process.env.ROOT || '.', 'content') + + // Resolve the params.name relative to the content directory. + // When markdownlint runs with `strings`, params.name is the key + // (often a relative path like "content/copilot/how-tos/file.md"). + // When it runs with `files`, params.name is the real file path. + // Resolve non-absolute paths against ROOT (not CWD) so the rule + // works correctly when process.env.ROOT differs from the working directory. + const rootDir = process.env.ROOT || '.' + const resolved = path.isAbsolute(filePath) ? filePath : path.resolve(rootDir, filePath) + const relativePath = path.relative(contentDir, resolved) + + // Skip files that aren't under content/ + if (relativePath.startsWith('..')) return + + const segments = relativePath.split(path.sep) + // Need at least product/something (e.g. copilot/index.md) + if (segments.length < 2) return + + const product = segments[0] + if (!getQualifyingProducts().has(product)) return + + const fm = getFrontmatter(params.lines) + if (!fm) return + + // Determine expected contentType + let expectedType: string + if (segments.length === 2 && segments[1] === 'index.md') { + // Product-level index.md is always a landing page + expectedType = 'landing' + } else if (segments.length === 2) { + // Non-index files directly under content// are unusual + // in qualifying products — skip them rather than requiring + // contentType: other. + return + } else { + expectedType = dirToContentType(segments[1]) + } + + // Find the best line number for the error. + // Prefer the contentType line; fall back to the opening `---`. + const contentTypeLine = params.lines.findIndex((line) => + line.trimStart().startsWith('contentType'), + ) + const fmOpenLine = params.lines.indexOf('---') + const errorLine = + contentTypeLine !== -1 ? contentTypeLine + 1 : fmOpenLine !== -1 ? fmOpenLine + 1 : 1 + + const fixHint = `Run \`npx tsx src/content-render/scripts/add-content-type.ts --paths ${product}\` to fix.` + + // Check: contentType must exist + if (!fm.contentType) { + addError( + onError, + errorLine, + `Missing contentType frontmatter. Expected: "${expectedType}". ${fixHint}`, + undefined, + undefined, + undefined, + ) + return + } + + // Check: contentType must match the directory-derived value + if (fm.contentType !== expectedType) { + addError( + onError, + errorLine, + `contentType "${fm.contentType}" does not match expected "${expectedType}" based on directory. ${fixHint}`, + undefined, + undefined, + undefined, + ) + } + }, +} diff --git a/src/content-linter/lib/linting-rules/index.ts b/src/content-linter/lib/linting-rules/index.ts index ec04747929e5..47c182b64075 100644 --- a/src/content-linter/lib/linting-rules/index.ts +++ b/src/content-linter/lib/linting-rules/index.ts @@ -56,6 +56,7 @@ import { frontmatterIntroLinks } from './frontmatter-intro-links' import { frontmatterChildren } from './frontmatter-children' import { frontmatterCurlyQuotes } from './frontmatter-curly-quotes' import { raiAppCardStructure } from '@/content-linter/lib/linting-rules/rai-app-card-structure' +import { frontmatterContentType } from '@/content-linter/lib/linting-rules/frontmatter-content-type' // Using any type because @github/markdownlint-github doesn't provide TypeScript declarations // The elements in the array have a 'names' property that contains rule identifiers @@ -123,6 +124,7 @@ export const gitHubDocsMarkdownlint = { frontmatterIntroLinks, // GHD062 frontmatterChildren, // GHD063 raiAppCardStructure, // GHD064 + frontmatterContentType, // GHD065 // Search-replace rules searchReplace, // Open-source plugin diff --git a/src/content-linter/style/github-docs.ts b/src/content-linter/style/github-docs.ts index 323ff4e6077d..c8f9ce3253e5 100644 --- a/src/content-linter/style/github-docs.ts +++ b/src/content-linter/style/github-docs.ts @@ -303,6 +303,12 @@ export const githubDocsFrontmatterConfig = { 'partial-markdown-files': false, 'yml-files': false, }, + 'frontmatter-content-type': { + // GHD065 + severity: 'error', + 'partial-markdown-files': false, + 'yml-files': false, + }, } // Configures rules from the `github/markdownlint-github` repo diff --git a/src/content-linter/tests/unit/frontmatter-content-type.ts b/src/content-linter/tests/unit/frontmatter-content-type.ts new file mode 100644 index 000000000000..932e88902f6e --- /dev/null +++ b/src/content-linter/tests/unit/frontmatter-content-type.ts @@ -0,0 +1,201 @@ +import { describe, expect, test, beforeEach, beforeAll, afterAll } from 'vitest' + +import { runRule } from '@/content-linter/lib/init-test' +import { + frontmatterContentType, + resetCache, +} from '@/content-linter/lib/linting-rules/frontmatter-content-type' + +// Disable frontMatter stripping so the rule can parse frontmatter itself +const fmOptions = { markdownlintOptions: { frontMatter: null } } + +// Helper: build a Markdown string with valid frontmatter +function md(fmLines: string[], body = 'Some content.'): string { + return ['---', ...fmLines, '---', '', body].join('\n') +} + +// Use the fixture content directory so the qualifying-products scan is +// hermetic and won't break if the real content/ layout changes. +// The fixture tree includes: +// content/copilot/{how-tos,concepts,tutorials,reference,get-started,getting-started,responsible-use} → qualifies +// content/actions/{category,using-workflows} → does NOT qualify +const FIXTURE_ROOT = 'src/fixtures/fixtures' + +describe('GHD065 - frontmatter-content-type', () => { + const savedRoot = process.env.ROOT + + beforeAll(() => { + process.env.ROOT = FIXTURE_ROOT + }) + + afterAll(() => { + process.env.ROOT = savedRoot + }) + + // Clear the qualifying-products cache between tests so that each + // test starts with a fresh filesystem scan. + beforeEach(() => { + resetCache() + }) + + // ------------------------------------------------------------------- + // Passing cases + // ------------------------------------------------------------------- + + test('file with correct contentType matching directory passes', async () => { + const strings = { + 'content/copilot/how-tos/test-file.md': md([ + 'title: Test', + 'contentType: how-tos', + 'versions:', + " fpt: '*'", + ]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/how-tos/test-file.md'] + expect(errors).toEqual([]) + }) + + test('file with contentType "rai" in responsible-use directory passes', async () => { + const strings = { + 'content/copilot/responsible-use/test-file.md': md([ + 'title: RAI Page', + 'contentType: rai', + 'versions:', + " fpt: '*'", + ]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/responsible-use/test-file.md'] + expect(errors).toEqual([]) + }) + + test('file with contentType "get-started" in getting-started directory passes', async () => { + // Some products use "getting-started" instead of "get-started" as directory name + const strings = { + 'content/copilot/getting-started/test-file.md': md([ + 'title: Getting Started', + 'contentType: get-started', + 'versions:', + " fpt: '*'", + ]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/getting-started/test-file.md'] + expect(errors).toEqual([]) + }) + + test('product-level index.md with contentType "landing" passes', async () => { + const strings = { + 'content/copilot/index.md': md([ + 'title: Copilot', + 'contentType: landing', + 'versions:', + " fpt: '*'", + ]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/index.md'] + expect(errors).toEqual([]) + }) + + test('file outside qualifying product is not checked', async () => { + // actions in fixtures has non-EDI subdirs (category/, using-workflows/), + // so it does NOT qualify — the rule should skip it entirely. + const strings = { + 'content/actions/category/test-file.md': md(['title: Test', 'versions:', " fpt: '*'"]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/actions/category/test-file.md'] + expect(errors).toEqual([]) + }) + + test('file not under content/ is skipped', async () => { + const strings = { + 'data/reusables/test.md': md(['title: Test', 'versions:', " fpt: '*'"]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['data/reusables/test.md'] + expect(errors).toEqual([]) + }) + + // ------------------------------------------------------------------- + // Failing cases + // ------------------------------------------------------------------- + + test('missing contentType in qualifying product triggers error', async () => { + const strings = { + 'content/copilot/tutorials/test-file.md': md(['title: Tutorial', 'versions:', " fpt: '*'"]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/tutorials/test-file.md'] + expect(errors.length).toBe(1) + expect(errors[0].ruleNames).toContain('GHD065') + expect(errors[0].errorDetail).toContain('Missing contentType') + expect(errors[0].errorDetail).toContain('"tutorials"') + expect(errors[0].errorDetail).toContain('add-content-type.ts') + }) + + test('mismatched contentType triggers error', async () => { + const strings = { + 'content/copilot/concepts/test-file.md': md([ + 'title: Concepts Page', + 'contentType: how-tos', + 'versions:', + " fpt: '*'", + ]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/concepts/test-file.md'] + expect(errors.length).toBe(1) + expect(errors[0].ruleNames).toContain('GHD065') + expect(errors[0].errorDetail).toContain('"how-tos"') + expect(errors[0].errorDetail).toContain('"concepts"') + }) + + test('product-level index.md with wrong contentType triggers error', async () => { + const strings = { + 'content/copilot/index.md': md([ + 'title: Copilot', + 'contentType: concepts', + 'versions:', + " fpt: '*'", + ]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/index.md'] + expect(errors.length).toBe(1) + expect(errors[0].errorDetail).toContain('"concepts"') + expect(errors[0].errorDetail).toContain('"landing"') + }) + + test('deeply nested file still checks against content-type directory', async () => { + const strings = { + 'content/copilot/get-started/subdir/deep.md': md([ + 'title: Deep page', + 'contentType: get-started', + 'versions:', + " fpt: '*'", + ]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/get-started/subdir/deep.md'] + expect(errors).toEqual([]) + }) + + test('deeply nested file with wrong contentType triggers error', async () => { + const strings = { + 'content/copilot/reference/subdir/deep.md': md([ + 'title: Deep page', + 'contentType: tutorials', + 'versions:', + " fpt: '*'", + ]), + } + const result = await runRule(frontmatterContentType, { strings, ...fmOptions }) + const errors = result['content/copilot/reference/subdir/deep.md'] + expect(errors.length).toBe(1) + expect(errors[0].errorDetail).toContain('"tutorials"') + expect(errors[0].errorDetail).toContain('"reference"') + }) +}) diff --git a/src/content-render/scripts/add-content-type.ts b/src/content-render/scripts/add-content-type.ts index 92c2380e70e5..ef78f234e3a3 100644 --- a/src/content-render/scripts/add-content-type.ts +++ b/src/content-render/scripts/add-content-type.ts @@ -156,6 +156,11 @@ function determineContentType(relativePath: string): string { return RAI_TYPE } + // Allow 'getting-started' as an alternative directory name for 'get-started'. + if (derivedContentType === 'getting-started') { + return 'get-started' + } + // When the content directory matches any of the allowed // content type values (such as 'get-started', // 'concepts', 'how-tos', 'reference', and 'tutorials'), diff --git a/src/fixtures/fixtures/content/copilot/concepts/index.md b/src/fixtures/fixtures/content/copilot/concepts/index.md new file mode 100644 index 000000000000..633db26bd396 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/concepts/index.md @@ -0,0 +1,10 @@ +--- +title: Concepts +intro: Understand GitHub Copilot concepts. +versions: + fpt: '*' + ghec: '*' +contentType: concepts +children: + - /overview +--- diff --git a/src/fixtures/fixtures/content/copilot/concepts/overview.md b/src/fixtures/fixtures/content/copilot/concepts/overview.md new file mode 100644 index 000000000000..af2a552d6120 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/concepts/overview.md @@ -0,0 +1,8 @@ +--- +title: Copilot overview +intro: Learn about GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: concepts +--- diff --git a/src/fixtures/fixtures/content/copilot/get-started/index.md b/src/fixtures/fixtures/content/copilot/get-started/index.md new file mode 100644 index 000000000000..d7e2c81d5f59 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/get-started/index.md @@ -0,0 +1,10 @@ +--- +title: Get started +intro: Get started with GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: get-started +children: + - /quickstart +--- diff --git a/src/fixtures/fixtures/content/copilot/get-started/quickstart.md b/src/fixtures/fixtures/content/copilot/get-started/quickstart.md new file mode 100644 index 000000000000..8b766f3cc2b0 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/get-started/quickstart.md @@ -0,0 +1,8 @@ +--- +title: Quickstart +intro: Get up and running with GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: get-started +--- diff --git a/src/fixtures/fixtures/content/copilot/getting-started/index.md b/src/fixtures/fixtures/content/copilot/getting-started/index.md new file mode 100644 index 000000000000..c94e8a1417be --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/getting-started/index.md @@ -0,0 +1,10 @@ +--- +title: Getting started +intro: Getting started with GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: get-started +children: + - /setup +--- diff --git a/src/fixtures/fixtures/content/copilot/getting-started/setup.md b/src/fixtures/fixtures/content/copilot/getting-started/setup.md new file mode 100644 index 000000000000..db4750dcec2c --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/getting-started/setup.md @@ -0,0 +1,8 @@ +--- +title: Setup +intro: Set up GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: get-started +--- diff --git a/src/fixtures/fixtures/content/copilot/how-tos/index.md b/src/fixtures/fixtures/content/copilot/how-tos/index.md new file mode 100644 index 000000000000..199630f4946a --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/how-tos/index.md @@ -0,0 +1,10 @@ +--- +title: How-tos +intro: How-to guides for GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: how-tos +children: + - /using-copilot +--- diff --git a/src/fixtures/fixtures/content/copilot/how-tos/using-copilot.md b/src/fixtures/fixtures/content/copilot/how-tos/using-copilot.md new file mode 100644 index 000000000000..7be059501c98 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/how-tos/using-copilot.md @@ -0,0 +1,8 @@ +--- +title: Using Copilot +intro: Learn how to use GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: how-tos +--- diff --git a/src/fixtures/fixtures/content/copilot/index.md b/src/fixtures/fixtures/content/copilot/index.md new file mode 100644 index 000000000000..9014bf2fe4ae --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/index.md @@ -0,0 +1,17 @@ +--- +title: GitHub Copilot Documentation +shortTitle: GitHub Copilot +intro: Use GitHub Copilot to enhance your development workflow. +versions: + fpt: '*' + ghec: '*' +contentType: landing +children: + - /concepts + - /get-started + - /getting-started + - /how-tos + - /reference + - /responsible-use + - /tutorials +--- diff --git a/src/fixtures/fixtures/content/copilot/reference/api.md b/src/fixtures/fixtures/content/copilot/reference/api.md new file mode 100644 index 000000000000..995fdeacfbed --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/reference/api.md @@ -0,0 +1,8 @@ +--- +title: API reference +intro: GitHub Copilot API reference. +versions: + fpt: '*' + ghec: '*' +contentType: reference +--- diff --git a/src/fixtures/fixtures/content/copilot/reference/index.md b/src/fixtures/fixtures/content/copilot/reference/index.md new file mode 100644 index 000000000000..d6e7d9b17de9 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/reference/index.md @@ -0,0 +1,10 @@ +--- +title: Reference +intro: GitHub Copilot reference documentation. +versions: + fpt: '*' + ghec: '*' +contentType: reference +children: + - /api +--- diff --git a/src/fixtures/fixtures/content/copilot/responsible-use/guidelines.md b/src/fixtures/fixtures/content/copilot/responsible-use/guidelines.md new file mode 100644 index 000000000000..ed1226880b47 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/responsible-use/guidelines.md @@ -0,0 +1,8 @@ +--- +title: Responsible use guidelines +intro: Guidelines for responsible use of GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: rai +--- diff --git a/src/fixtures/fixtures/content/copilot/responsible-use/index.md b/src/fixtures/fixtures/content/copilot/responsible-use/index.md new file mode 100644 index 000000000000..3b00762a4eb8 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/responsible-use/index.md @@ -0,0 +1,10 @@ +--- +title: Responsible use +intro: Responsible use of GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: rai +children: + - /guidelines +--- diff --git a/src/fixtures/fixtures/content/copilot/tutorials/first-steps.md b/src/fixtures/fixtures/content/copilot/tutorials/first-steps.md new file mode 100644 index 000000000000..6d8f8464b930 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/tutorials/first-steps.md @@ -0,0 +1,8 @@ +--- +title: First steps with Copilot +intro: A tutorial for getting started with GitHub Copilot. +versions: + fpt: '*' + ghec: '*' +contentType: tutorials +--- diff --git a/src/fixtures/fixtures/content/copilot/tutorials/index.md b/src/fixtures/fixtures/content/copilot/tutorials/index.md new file mode 100644 index 000000000000..959ea315b362 --- /dev/null +++ b/src/fixtures/fixtures/content/copilot/tutorials/index.md @@ -0,0 +1,10 @@ +--- +title: Tutorials +intro: GitHub Copilot tutorials. +versions: + fpt: '*' + ghec: '*' +contentType: tutorials +children: + - /first-steps +--- diff --git a/src/fixtures/fixtures/content/index.md b/src/fixtures/fixtures/content/index.md index c4fda9c57663..ba405bde1d67 100644 --- a/src/fixtures/fixtures/content/index.md +++ b/src/fixtures/fixtures/content/index.md @@ -44,7 +44,7 @@ children: - organizations # - pull-requests # - issues - # - copilot + - copilot # - codespaces # - packages # - search-github From 2f8960ae48f3734f40d6d75f641a57014361be5c Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Fri, 13 Mar 2026 10:35:38 -0700 Subject: [PATCH 2/4] Add discovery landing page for content/authentication (#60031) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: subatoi <32935794+subatoi@users.noreply.github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> --- .../about-passkeys.md | 2 ++ .../managing-your-passkeys.md | 2 ++ .../signing-in-with-a-passkey.md | 2 ++ ...bout-authentication-with-single-sign-on.md | 2 ++ ...henticating-with-a-managed-user-account.md | 2 ++ ...ccess-token-for-use-with-single-sign-on.md | 2 ++ .../authorizing-an-app-for-single-sign-on.md | 2 ++ ...-an-ssh-key-for-use-with-single-sign-on.md | 2 ++ ...g-and-managing-your-active-sso-sessions.md | 2 ++ .../about-ssh.md | 2 ++ ...ng-a-new-ssh-key-to-your-github-account.md | 2 ++ .../checking-for-existing-ssh-keys.md | 2 ++ ...-ssh-key-and-adding-it-to-the-ssh-agent.md | 2 ++ .../connecting-to-github-with-ssh/index.md | 15 ++++++-- .../managing-deploy-keys.md | 2 ++ .../testing-your-ssh-connection.md | 2 ++ .../using-ssh-agent-forwarding.md | 2 ++ .../working-with-ssh-key-passphrases.md | 2 ++ content/authentication/index.md | 36 ++++++++++--------- .../about-anonymized-urls.md | 2 ++ .../about-authentication-to-github.md | 2 ++ .../about-githubs-ip-addresses.md | 2 ++ .../creating-a-strong-password.md | 2 ++ .../githubs-ssh-key-fingerprints.md | 2 ++ .../managing-your-personal-access-tokens.md | 2 ++ .../preventing-unauthorized-access.md | 2 ++ ...moving-sensitive-data-from-a-repository.md | 2 ++ .../reviewing-your-deploy-keys.md | 2 ++ .../reviewing-your-security-log.md | 2 ++ .../reviewing-your-ssh-keys.md | 2 ++ .../security-log-events.md | 2 ++ .../sudo-mode.md | 2 ++ .../switching-between-accounts.md | 2 ++ .../token-expiration-and-revocation.md | 2 ++ ...updating-your-github-access-credentials.md | 2 ++ .../verifying-new-devices-when-signing-in.md | 2 ++ .../viewing-and-managing-your-sessions.md | 2 ++ .../about-commit-signature-verification.md | 2 ++ ...adding-a-gpg-key-to-your-github-account.md | 2 ++ .../associating-an-email-with-your-gpg-key.md | 2 ++ .../checking-for-existing-gpg-keys.md | 2 ++ ...cation-statuses-for-all-of-your-commits.md | 2 ++ .../generating-a-new-gpg-key.md | 2 ++ .../index.md | 15 +++++++- .../signing-commits.md | 2 ++ .../signing-tags.md | 2 ++ .../telling-git-about-your-signing-key.md | 2 ++ ...out-mandatory-two-factor-authentication.md | 2 ++ .../about-two-factor-authentication.md | 2 ++ ...-github-using-two-factor-authentication.md | 2 ++ ...g-your-two-factor-authentication-method.md | 2 ++ ...-factor-authentication-recovery-methods.md | 2 ++ .../configuring-two-factor-authentication.md | 2 ++ ...s-where-sms-authentication-is-supported.md | 2 ++ ...uthentication-for-your-personal-account.md | 2 ++ ...ccount-if-you-lose-your-2fa-credentials.md | 2 ++ ...ooting-two-factor-authentication-issues.md | 2 ++ ...t-and-tag-signature-verification-status.md | 2 ++ ...-verified-email-address-in-your-gpg-key.md | 2 ++ .../deleted-or-missing-ssh-keys.md | 2 ++ .../error-agent-admitted-failure-to-sign.md | 2 ++ .../error-bad-file-number.md | 2 ++ .../error-host-key-verification-failed.md | 2 ++ .../error-key-already-in-use.md | 2 ++ .../error-permission-denied-publickey.md | 2 ++ ...ission-to-userrepo-denied-to-other-user.md | 2 ++ ...on-to-userrepo-denied-to-userother-repo.md | 2 ++ ...dd-illegal-option----apple-use-keychain.md | 2 ++ ...e-problem-verify-that-the-ca-cert-is-ok.md | 2 ++ .../error-unknown-key-type.md | 2 ++ .../error-were-doing-an-ssh-key-audit.md | 2 ++ .../recovering-your-ssh-key-passphrase.md | 2 ++ .../using-ssh-over-the-https-port.md | 2 ++ 73 files changed, 187 insertions(+), 19 deletions(-) diff --git a/content/authentication/authenticating-with-a-passkey/about-passkeys.md b/content/authentication/authenticating-with-a-passkey/about-passkeys.md index a81d929baeea..b57446f90456 100644 --- a/content/authentication/authenticating-with-a-passkey/about-passkeys.md +++ b/content/authentication/authenticating-with-a-passkey/about-passkeys.md @@ -7,6 +7,8 @@ versions: ghec: '*' ghes: '*' shortTitle: About passkeys +category: + - Learn about authentication --- {% data reusables.passkeys.ghes-disable %} diff --git a/content/authentication/authenticating-with-a-passkey/managing-your-passkeys.md b/content/authentication/authenticating-with-a-passkey/managing-your-passkeys.md index ea26fb32308e..4317b82ffdce 100644 --- a/content/authentication/authenticating-with-a-passkey/managing-your-passkeys.md +++ b/content/authentication/authenticating-with-a-passkey/managing-your-passkeys.md @@ -7,6 +7,8 @@ versions: ghec: '*' ghes: '*' shortTitle: Manage your passkeys +category: + - Sign in with SSO or a passkey contentType: how-tos --- diff --git a/content/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md b/content/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md index 1baf02ee344e..3515bd2024f7 100644 --- a/content/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md +++ b/content/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey.md @@ -7,6 +7,8 @@ versions: ghec: '*' ghes: '*' shortTitle: Sign in with a passkey +category: + - Sign in with SSO or a passkey contentType: how-tos --- diff --git a/content/authentication/authenticating-with-single-sign-on/about-authentication-with-single-sign-on.md b/content/authentication/authenticating-with-single-sign-on/about-authentication-with-single-sign-on.md index ddcf0117399f..c09319a61de8 100644 --- a/content/authentication/authenticating-with-single-sign-on/about-authentication-with-single-sign-on.md +++ b/content/authentication/authenticating-with-single-sign-on/about-authentication-with-single-sign-on.md @@ -9,6 +9,8 @@ redirect_from: versions: ghec: '*' shortTitle: Single sign-on +category: + - Learn about authentication --- ## About authentication with SSO diff --git a/content/authentication/authenticating-with-single-sign-on/authenticating-with-a-managed-user-account.md b/content/authentication/authenticating-with-single-sign-on/authenticating-with-a-managed-user-account.md index 863146156e94..2be2538ee3d8 100644 --- a/content/authentication/authenticating-with-single-sign-on/authenticating-with-a-managed-user-account.md +++ b/content/authentication/authenticating-with-single-sign-on/authenticating-with-a-managed-user-account.md @@ -8,6 +8,8 @@ redirect_from: versions: ghec: '*' allowTitleToDifferFromFilename: true +category: + - Sign in with SSO or a passkey --- If you use a {% data variables.enterprise.prodname_managed_user %}, you must authenticate through your identity provider (IdP) to access {% data variables.product.prodname_dotcom %}. The location where you can authenticate depends on whether your enterprise uses SAML or OIDC authentication. diff --git a/content/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on.md b/content/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on.md index 2314e56f88e4..4dc59bda3fe4 100644 --- a/content/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on.md +++ b/content/authentication/authenticating-with-single-sign-on/authorizing-a-personal-access-token-for-use-with-single-sign-on.md @@ -10,6 +10,8 @@ redirect_from: versions: ghec: '*' shortTitle: '{% data variables.product.pat_generic_caps %} with SSO' +category: + - Sign in with SSO or a passkey --- You must authorize your {% data variables.product.pat_v1 %} after creation before the token can access an organization that uses SAML single sign-on (SSO). Access to `internal` resources (repositories, projects, and packages) in an enterprise requires an SSO authorization for an organization within an enterprise. For more information about creating a new {% data variables.product.pat_v1 %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). {% data variables.product.pat_v2_caps %}s are authorized during token creation, before access to the organization is granted. diff --git a/content/authentication/authenticating-with-single-sign-on/authorizing-an-app-for-single-sign-on.md b/content/authentication/authenticating-with-single-sign-on/authorizing-an-app-for-single-sign-on.md index 9ffdf91c2b57..0ad4e81e9a73 100644 --- a/content/authentication/authenticating-with-single-sign-on/authorizing-an-app-for-single-sign-on.md +++ b/content/authentication/authenticating-with-single-sign-on/authorizing-an-app-for-single-sign-on.md @@ -4,6 +4,8 @@ intro: 'To use an {% data variables.product.prodname_oauth_app %} or {% data var versions: ghec: '*' shortTitle: Apps and SSO +category: + - Sign in with SSO or a passkey --- ## About authorizing apps with SSO diff --git a/content/authentication/authenticating-with-single-sign-on/authorizing-an-ssh-key-for-use-with-single-sign-on.md b/content/authentication/authenticating-with-single-sign-on/authorizing-an-ssh-key-for-use-with-single-sign-on.md index 84d025265a35..142136f8b644 100644 --- a/content/authentication/authenticating-with-single-sign-on/authorizing-an-ssh-key-for-use-with-single-sign-on.md +++ b/content/authentication/authenticating-with-single-sign-on/authorizing-an-ssh-key-for-use-with-single-sign-on.md @@ -10,6 +10,8 @@ redirect_from: versions: ghec: '*' shortTitle: SSH Key with SSO +category: + - Sign in with SSO or a passkey --- ## About authorization of SSH keys diff --git a/content/authentication/authenticating-with-single-sign-on/viewing-and-managing-your-active-sso-sessions.md b/content/authentication/authenticating-with-single-sign-on/viewing-and-managing-your-active-sso-sessions.md index 0cf3d3455d3e..dabc36f540ca 100644 --- a/content/authentication/authenticating-with-single-sign-on/viewing-and-managing-your-active-sso-sessions.md +++ b/content/authentication/authenticating-with-single-sign-on/viewing-and-managing-your-active-sso-sessions.md @@ -9,6 +9,8 @@ redirect_from: versions: ghec: '*' shortTitle: Active SSO sessions +category: + - Sign in with SSO or a passkey contentType: how-tos --- diff --git a/content/authentication/connecting-to-github-with-ssh/about-ssh.md b/content/authentication/connecting-to-github-with-ssh/about-ssh.md index 15fd95e2cbcf..a6249fb5d718 100644 --- a/content/authentication/connecting-to-github-with-ssh/about-ssh.md +++ b/content/authentication/connecting-to-github-with-ssh/about-ssh.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Learn about authentication --- {% data reusables.ssh.about-ssh %} For more information about SSH, see [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell) on Wikipedia. diff --git a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index daaab70f4b2a..4825815b3f06 100644 --- a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Add a new SSH key +category: + - Connect with SSH --- ## About addition of SSH keys to your account diff --git a/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md b/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md index 75fd0daee795..4bbccd260e4d 100644 --- a/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md +++ b/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Check for existing SSH key +category: + - Connect with SSH --- ## About SSH keys diff --git a/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index f8c1eccf8668..a78a9e0acdd7 100644 --- a/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -12,6 +12,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Generate new SSH key +category: + - Connect with SSH --- ## About SSH key passphrases diff --git a/content/authentication/connecting-to-github-with-ssh/index.md b/content/authentication/connecting-to-github-with-ssh/index.md index 19b586c9dd5a..17e51017cccc 100644 --- a/content/authentication/connecting-to-github-with-ssh/index.md +++ b/content/authentication/connecting-to-github-with-ssh/index.md @@ -15,14 +15,25 @@ versions: fpt: '*' ghes: '*' ghec: '*' +layout: journey-landing +journeyTracks: + - id: 'connect_with_ssh' + title: 'Connect to GitHub with SSH' + description: 'Set up SSH authentication to securely connect to {% data variables.product.github %} without entering your password each time.' + guides: + - href: '/authentication/connecting-to-github-with-ssh/about-ssh' + - href: '/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys' + - href: '/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent' + - href: '/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account' + - href: '/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection' children: - /about-ssh - - /using-ssh-agent-forwarding - - /managing-deploy-keys - /checking-for-existing-ssh-keys - /generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent - /adding-a-new-ssh-key-to-your-github-account - /testing-your-ssh-connection - /working-with-ssh-key-passphrases + - /using-ssh-agent-forwarding + - /managing-deploy-keys shortTitle: Connect with SSH --- diff --git a/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md b/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md index 39eaaf549a6c..a5afd50c0f6e 100644 --- a/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md +++ b/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md @@ -12,6 +12,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Connect with SSH --- diff --git a/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md b/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md index 330cf4faccbc..35859bd5ef32 100644 --- a/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md +++ b/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Test your SSH connection +category: + - Connect with SSH --- Before testing your SSH connection, you should have already: diff --git a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md index 4d5a867a2058..dee0e0c3b75a 100644 --- a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md +++ b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md @@ -11,6 +11,8 @@ versions: ghes: '*' ghec: '*' shortTitle: SSH agent forwarding +category: + - Connect with SSH --- diff --git a/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md b/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md index 2a2e29b85cd8..828692be143b 100644 --- a/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md +++ b/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md @@ -12,6 +12,8 @@ versions: ghes: '*' ghec: '*' shortTitle: SSH key passphrases +category: + - Connect with SSH --- ## About passphrases for SSH keys diff --git a/content/authentication/index.md b/content/authentication/index.md index 3e16f5049a29..8314aa0e5e7e 100644 --- a/content/authentication/index.md +++ b/content/authentication/index.md @@ -1,7 +1,7 @@ --- title: Authentication documentation shortTitle: Authentication -intro: 'Keep your account and data secure with features like two-factor authentication, SSH, and commit signature verification.' +intro: 'Authenticate securely to {% data variables.product.github %} with passwords, tokens, SSH keys, and more—and keep your account protected.' redirect_from: - /categories/56/articles - /categories/ssh @@ -20,24 +20,28 @@ versions: ghec: '*' introLinks: overview: /authentication/keeping-your-account-and-data-secure/about-authentication-to-github -featuredLinks: - startHere: - - /authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent - - /authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens +changelog: + label: '2FA,authentication,security keys,SSH,token authentication' +layout: discovery-landing +carousels: + recommended: + - /authentication/keeping-your-account-and-data-secure/about-authentication-to-github + - /authentication/connecting-to-github-with-ssh + - /authentication/managing-commit-signature-verification - /authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication - popular: - - /authentication/troubleshooting-ssh - - /authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys - - /authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account - - /authentication/authenticating-with-single-sign-on - - /authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits - guideCards: + - /authentication/authenticating-with-a-passkey/signing-in-with-a-passkey + - /authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens + - /authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository - /authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials - /authentication/troubleshooting-ssh/error-permission-denied-publickey - - /authentication/keeping-your-account-and-data-secure/creating-a-strong-password -changelog: - label: '2FA,authentication,security keys,SSH,token authentication' -layout: product-landing +includedCategories: + - Learn about authentication + - Set up two-factor authentication + - Connect with SSH + - Sign in with SSO or a passkey + - Sign your commits + - Manage access credentials + - Troubleshoot authentication issues children: - /keeping-your-account-and-data-secure - /securing-your-account-with-two-factor-authentication-2fa diff --git a/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md b/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md index fdda4789f671..de4bc7e928ba 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md @@ -10,6 +10,8 @@ redirect_from: versions: fpt: '*' ghec: '*' +category: + - Learn about authentication --- To host your images, {% data variables.product.github %} uses the [open-source project Camo](https://github.com/atmos/camo). Camo generates an anonymous URL proxy for each file which hides your browser details and related information from other users. On {% data variables.product.prodname_dotcom_the_website %}, the URL starts `https://.githubusercontent.com/`, with different subdomains depending on how you uploaded the image. diff --git a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md index 344fbda780e0..06740585564e 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md @@ -9,6 +9,8 @@ redirect_from: - /github/authenticating-to-github/about-authentication-to-github - /github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github shortTitle: Authentication to GitHub +category: + - Learn about authentication --- ## About authentication to {% data variables.product.github %} diff --git a/content/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md b/content/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md index b8624f2ddc2a..1d33e33de74f 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses.md @@ -14,6 +14,8 @@ versions: fpt: '*' ghec: '*' shortTitle: GitHub's IP addresses +category: + - Learn about authentication --- You can retrieve a list of the IP addresses for your {% data variables.product.github %} environment from the [meta](https://api.github.com/meta) API endpoint. For more information, see [AUTOTITLE](/rest/meta). diff --git a/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md b/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md index d62908fc3cd3..c8f1a4675bba 100644 --- a/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md +++ b/content/authentication/keeping-your-account-and-data-secure/creating-a-strong-password.md @@ -11,6 +11,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Create a strong password +category: + - Manage access credentials --- You must choose or generate a password for your account on {% data variables.product.prodname_dotcom %} that is at least: * {% ifversion ghes %}Seven{% else %}Eight{% endif %} characters long, if it includes a number and a lowercase letter, or diff --git a/content/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints.md b/content/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints.md index 9dd2925eb9f3..e4982cad38c3 100644 --- a/content/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints.md +++ b/content/authentication/keeping-your-account-and-data-secure/githubs-ssh-key-fingerprints.md @@ -11,6 +11,8 @@ versions: fpt: '*' ghec: '*' shortTitle: SSH key fingerprints +category: + - Connect with SSH --- These are {% data variables.product.prodname_dotcom %}'s public key fingerprints: diff --git a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md index 31d5bab2b91a..3b9058958383 100644 --- a/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md +++ b/content/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.md @@ -15,6 +15,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Manage access credentials --- > [!WARNING] diff --git a/content/authentication/keeping-your-account-and-data-secure/preventing-unauthorized-access.md b/content/authentication/keeping-your-account-and-data-secure/preventing-unauthorized-access.md index 20b1a9e010ff..cb8ce954927a 100644 --- a/content/authentication/keeping-your-account-and-data-secure/preventing-unauthorized-access.md +++ b/content/authentication/keeping-your-account-and-data-secure/preventing-unauthorized-access.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Unauthorized access +category: + - Manage access credentials --- {% data variables.product.github %} requires a password to perform sensitive actions, such as adding new SSH keys, authorizing applications, or modifying team members. diff --git a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index 32aaf0ef69ab..b4eabbe9df8b 100644 --- a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -13,6 +13,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Remove sensitive data +category: + - Manage access credentials --- ## About removing sensitive data from a repository diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md index 1033e9af7f40..1633c7038dbc 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-deploy-keys.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Deploy keys +category: + - Connect with SSH --- {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md index db7fade5e107..dc31cc1e083c 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Review security log +category: + - Manage access credentials --- ## Accessing your security log diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md index 98d8595e985f..44f5fd950702 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md @@ -11,6 +11,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Connect with SSH --- You can delete unauthorized (or possibly compromised) SSH keys to ensure that an attacker no longer has access to your repositories. You can also approve existing SSH keys that are valid. diff --git a/content/authentication/keeping-your-account-and-data-secure/security-log-events.md b/content/authentication/keeping-your-account-and-data-secure/security-log-events.md index 2f0a34f6fe88..7c838b4c63f8 100644 --- a/content/authentication/keeping-your-account-and-data-secure/security-log-events.md +++ b/content/authentication/keeping-your-account-and-data-secure/security-log-events.md @@ -6,6 +6,8 @@ versions: ghes: '*' ghec: '*' autogenerated: audit-logs +category: + - Manage access credentials --- > [!NOTE] diff --git a/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md b/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md index 1e152f97663f..ae9e35c46628 100644 --- a/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md +++ b/content/authentication/keeping-your-account-and-data-secure/sudo-mode.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Manage access credentials --- ## About sudo mode diff --git a/content/authentication/keeping-your-account-and-data-secure/switching-between-accounts.md b/content/authentication/keeping-your-account-and-data-secure/switching-between-accounts.md index c278e7a93bcc..98000b6c5ffb 100644 --- a/content/authentication/keeping-your-account-and-data-secure/switching-between-accounts.md +++ b/content/authentication/keeping-your-account-and-data-secure/switching-between-accounts.md @@ -6,6 +6,8 @@ versions: fpt: '*' ghec: '*' ghes: '*' +category: + - Manage access credentials contentType: concepts --- diff --git a/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md b/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md index 137cda619404..74a19c539c1a 100644 --- a/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md +++ b/content/authentication/keeping-your-account-and-data-secure/token-expiration-and-revocation.md @@ -8,6 +8,8 @@ versions: shortTitle: Token expiration redirect_from: - /github/authenticating-to-github/keeping-your-account-and-data-secure/token-expiration-and-revocation +category: + - Manage access credentials --- When a token has expired or has been revoked, it can no longer be used to authenticate Git and API requests. It is not possible to restore an expired or revoked token, you or the application will need to create a new token. diff --git a/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md b/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md index 27fa4f36e7c0..c729e76987ac 100644 --- a/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md +++ b/content/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials.md @@ -12,6 +12,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Update access credentials +category: + - Manage access credentials --- {% ifversion ghec %} diff --git a/content/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in.md b/content/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in.md index 18ab4271bb07..7a734cab83bd 100644 --- a/content/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in.md +++ b/content/authentication/keeping-your-account-and-data-secure/verifying-new-devices-when-signing-in.md @@ -5,6 +5,8 @@ versions: fpt: '*' ghec: '*' shortTitle: Verifying devices on sign in +category: + - Manage access credentials --- ## About device verification diff --git a/content/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md b/content/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md index 5137fbfc2fcf..684d561246c6 100644 --- a/content/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md +++ b/content/authentication/keeping-your-account-and-data-secure/viewing-and-managing-your-sessions.md @@ -6,6 +6,8 @@ versions: ghec: '*' ghes: '*' shortTitle: Viewing and managing sessions +category: + - Manage access credentials contentType: how-tos --- diff --git a/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md index 2fd4dfe7c89f..df6ae9ad246a 100644 --- a/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md +++ b/content/authentication/managing-commit-signature-verification/about-commit-signature-verification.md @@ -12,6 +12,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Commit signature verification +category: + - Learn about authentication --- ## About commit signature verification diff --git a/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md b/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md index fd37c57a1b86..6a2328861757 100644 --- a/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md +++ b/content/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account.md @@ -15,6 +15,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Add a GPG key +category: + - Sign your commits --- ## About addition of GPG keys to your account diff --git a/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md b/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md index 9674582169e0..e1f726a9e6ee 100644 --- a/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md +++ b/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Associate email with GPG key +category: + - Sign your commits --- If you're using a GPG key that matches your committer identity and your verified email address associated with your account on {% data variables.location.product_location %}, then you can begin signing commits and signing tags. diff --git a/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md b/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md index d356cb086331..6d49c9868dca 100644 --- a/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md +++ b/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Existing GPG keys +category: + - Sign your commits --- {% data reusables.gpg.supported-gpg-key-algorithms %} diff --git a/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md b/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md index fbbaf38f0dd1..689db785554b 100644 --- a/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md +++ b/content/authentication/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits.md @@ -9,6 +9,8 @@ versions: redirect_from: - /github/authenticating-to-github/displaying-verification-statuses-for-all-of-your-commits - /github/authenticating-to-github/managing-commit-signature-verification/displaying-verification-statuses-for-all-of-your-commits +category: + - Sign your commits --- ## About vigilant mode diff --git a/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md b/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md index 70e65aa8cf0d..fd8fb8a66540 100644 --- a/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md +++ b/content/authentication/managing-commit-signature-verification/generating-a-new-gpg-key.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Sign your commits --- {% data reusables.gpg.supported-gpg-key-algorithms %} diff --git a/content/authentication/managing-commit-signature-verification/index.md b/content/authentication/managing-commit-signature-verification/index.md index ac78ca72f048..15c2aec192de 100644 --- a/content/authentication/managing-commit-signature-verification/index.md +++ b/content/authentication/managing-commit-signature-verification/index.md @@ -10,9 +10,21 @@ versions: fpt: '*' ghes: '*' ghec: '*' +layout: journey-landing +journeyTracks: + - id: 'sign_commits_with_gpg' + title: 'Sign your commits with GPG' + description: 'Set up GPG commit signing so others can verify that your commits come from a trusted source.' + guides: + - href: '/authentication/managing-commit-signature-verification/about-commit-signature-verification' + - href: '/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys' + - href: '/authentication/managing-commit-signature-verification/generating-a-new-gpg-key' + - href: '/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account' + - href: '/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key' + - href: '/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key' + - href: '/authentication/managing-commit-signature-verification/signing-commits' children: - /about-commit-signature-verification - - /displaying-verification-statuses-for-all-of-your-commits - /checking-for-existing-gpg-keys - /generating-a-new-gpg-key - /adding-a-gpg-key-to-your-github-account @@ -20,5 +32,6 @@ children: - /associating-an-email-with-your-gpg-key - /signing-commits - /signing-tags + - /displaying-verification-statuses-for-all-of-your-commits shortTitle: Verify commit signatures --- diff --git a/content/authentication/managing-commit-signature-verification/signing-commits.md b/content/authentication/managing-commit-signature-verification/signing-commits.md index 2aa9131855f9..6a7759be7536 100644 --- a/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -11,6 +11,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Sign your commits --- {% data reusables.gpg.desktop-support-for-commit-signing %} diff --git a/content/authentication/managing-commit-signature-verification/signing-tags.md b/content/authentication/managing-commit-signature-verification/signing-tags.md index d50673899aa7..3dd1b0cb47a1 100644 --- a/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -10,6 +10,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Sign your commits --- {% data reusables.gpg.desktop-support-for-commit-signing %} diff --git a/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md b/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md index 74c76f6a9960..dba808dda89d 100644 --- a/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md +++ b/content/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key.md @@ -11,6 +11,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Tell Git about your signing key +category: + - Sign your commits --- ## Telling Git about your GPG key diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md index 036ab9fa60c8..89c986277730 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-mandatory-two-factor-authentication.md @@ -5,6 +5,8 @@ versions: fpt: '*' ghec: '*' shortTitle: About mandatory 2FA +category: + - Learn about authentication --- {% data reusables.two_fa.mandatory-2fa-contributors-2023-nested %} diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md index 8a4f33355f8b..7166e100684a 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: About 2FA +category: + - Learn about authentication --- {% ifversion mandatory-2fa-dotcom-contributors %} diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md index b8fc72f20a5f..8ab0e7fa2cf0 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md @@ -13,6 +13,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Access GitHub with 2FA +category: + - Set up two-factor authentication --- {% ifversion 2fa-check-up-period %} diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md index 5b7d1c40d96e..1c57472c626c 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/changing-your-two-factor-authentication-method.md @@ -13,6 +13,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Change 2FA method +category: + - Set up two-factor authentication --- You can reconfigure your two-factor authentication (2FA) settings or add new 2FA methods without disabling 2FA entirely, allowing you to keep both your recovery codes and your membership in organizations that require 2FA. diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md index 3d902d114a06..28cdeb20616b 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication-recovery-methods.md @@ -15,6 +15,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Configure 2FA recovery +category: + - Set up two-factor authentication --- In addition to securely storing your two-factor authentication (2FA) recovery codes, we strongly recommend configuring two or more authentication methods to avoid losing access to your account. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key). diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md index a16eaddee5e0..eece2f6583e2 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication.md @@ -13,6 +13,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Configure 2FA +category: + - Set up two-factor authentication --- {% ifversion mandatory-2fa-dotcom-contributors %} diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md index 6e1a8c81af0b..45a98844a6ad 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/countries-where-sms-authentication-is-supported.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghec: '*' shortTitle: Countries supporting SMS +category: + - Learn about authentication --- If we don't support two-factor authentication via text message for your country of residence, you can set up authentication via a TOTP mobile application. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication). diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md index abd9e9315c35..d5549c34631f 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/disabling-two-factor-authentication-for-your-personal-account.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Disable 2FA +category: + - Set up two-factor authentication --- {% ifversion mandatory-2fa-dotcom-contributors %} diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md index 767456fd1008..7a501bac345a 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials.md @@ -12,6 +12,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Recover an account with 2FA +category: + - Troubleshoot authentication issues --- {% ifversion fpt or ghec %} diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues.md index f897b9a2834a..47ce31809664 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/troubleshooting-two-factor-authentication-issues.md @@ -6,6 +6,8 @@ versions: ghec: '*' ghes: '*' shortTitle: Troubleshooting 2FA +category: + - Troubleshoot authentication issues --- If you are receiving a "Two-factor authentication failed" error when authenticating with two-factor authentication (2FA), the authentication code you are entering is incorrect. You can try troubleshooting your configured authentication methods before attempting account recovery. diff --git a/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md b/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md index 778d9a3f110f..f7b660f8c152 100644 --- a/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md +++ b/content/authentication/troubleshooting-commit-signature-verification/checking-your-commit-and-tag-signature-verification-status.md @@ -11,6 +11,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Check verification status +category: + - Troubleshoot authentication issues --- ## Checking your commit signature verification status diff --git a/content/authentication/troubleshooting-commit-signature-verification/using-a-verified-email-address-in-your-gpg-key.md b/content/authentication/troubleshooting-commit-signature-verification/using-a-verified-email-address-in-your-gpg-key.md index 93bd7173682a..cc785060068d 100644 --- a/content/authentication/troubleshooting-commit-signature-verification/using-a-verified-email-address-in-your-gpg-key.md +++ b/content/authentication/troubleshooting-commit-signature-verification/using-a-verified-email-address-in-your-gpg-key.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Use verified email in GPG key +category: + - Troubleshoot authentication issues --- {% ifversion fpt or ghec %} If you need to verify your GitHub email address, see [AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/verifying-your-email-address). {% endif %}If you need to update or add an email address to your GPG key, see [AUTOTITLE](/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key). diff --git a/content/authentication/troubleshooting-ssh/deleted-or-missing-ssh-keys.md b/content/authentication/troubleshooting-ssh/deleted-or-missing-ssh-keys.md index 0f047979dfa8..f1017ba64f71 100644 --- a/content/authentication/troubleshooting-ssh/deleted-or-missing-ssh-keys.md +++ b/content/authentication/troubleshooting-ssh/deleted-or-missing-ssh-keys.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghec: '*' shortTitle: Deleted or missing SSH keys +category: + - Troubleshoot authentication issues --- {% data variables.product.prodname_dotcom %} automatically deletes inactive SSH keys to help keep accounts safe, such as after someone leaves a job or loses a computer. diff --git a/content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md b/content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md index 39f445311d8d..8d9cc3cc9ffb 100644 --- a/content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md +++ b/content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md @@ -11,6 +11,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Agent failure to sign +category: + - Troubleshoot authentication issues --- When trying to SSH into {% data variables.location.product_location %} on a Linux computer, you may see the following message in your terminal: diff --git a/content/authentication/troubleshooting-ssh/error-bad-file-number.md b/content/authentication/troubleshooting-ssh/error-bad-file-number.md index 484132786eb2..9b2ba15688f9 100644 --- a/content/authentication/troubleshooting-ssh/error-bad-file-number.md +++ b/content/authentication/troubleshooting-ssh/error-bad-file-number.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Troubleshoot authentication issues --- When running remote Git commands or SSH, your connection might time out: diff --git a/content/authentication/troubleshooting-ssh/error-host-key-verification-failed.md b/content/authentication/troubleshooting-ssh/error-host-key-verification-failed.md index 5d321151e354..b0832f7a795e 100644 --- a/content/authentication/troubleshooting-ssh/error-host-key-verification-failed.md +++ b/content/authentication/troubleshooting-ssh/error-host-key-verification-failed.md @@ -4,6 +4,8 @@ intro: 'As a security precaution, SSH keeps track of which hosts it has previous versions: fpt: '*' ghec: '*' +category: + - Troubleshoot authentication issues --- This error means that the server to which you're connecting presented a key that doesn't match the keys seen for this server in the past. diff --git a/content/authentication/troubleshooting-ssh/error-key-already-in-use.md b/content/authentication/troubleshooting-ssh/error-key-already-in-use.md index 785904cc644a..a2962cf67dc9 100644 --- a/content/authentication/troubleshooting-ssh/error-key-already-in-use.md +++ b/content/authentication/troubleshooting-ssh/error-key-already-in-use.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghes: '*' ghec: '*' +category: + - Troubleshoot authentication issues --- ## Finding where the key has been used diff --git a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md index 33cd03dfab33..05c2612edac1 100644 --- a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md +++ b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md @@ -10,6 +10,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Permission denied (publickey) +category: + - Troubleshoot authentication issues --- {% ifversion ghec %} diff --git a/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-other-user.md b/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-other-user.md index 77e74dcd695e..0c2c475b7d7a 100644 --- a/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-other-user.md +++ b/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-other-user.md @@ -11,5 +11,7 @@ versions: ghes: '*' ghec: '*' shortTitle: Permission denied other-user +category: + - Troubleshoot authentication issues --- To fix this, the owner of the repository (`user`) needs to add your account (`other-user`) as a collaborator on the repository or to a team that has write access to the repository. diff --git a/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md b/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md index 09ac7b81cf06..cc20a31fcc28 100644 --- a/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md +++ b/content/authentication/troubleshooting-ssh/error-permission-to-userrepo-denied-to-userother-repo.md @@ -11,6 +11,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Permission denied other-repo +category: + - Troubleshoot authentication issues --- To fix this, remove the deploy key from the repository, and [add the key to your personal account](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) instead. diff --git a/content/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain.md b/content/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain.md index 0bc00a953362..d4692fadb360 100644 --- a/content/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain.md +++ b/content/authentication/troubleshooting-ssh/error-ssh-add-illegal-option----apple-use-keychain.md @@ -12,6 +12,8 @@ versions: ghes: '*' ghec: '*' shortTitle: 'ssh-add "illegal option" error' +category: + - Troubleshoot authentication issues --- The `--apple-use-keychain` option is in Apple's standard version of `ssh-add`, which stores the passphrase in your keychain for you when you add an ssh key to the ssh-agent. If you have installed a different version of `ssh-add`, it may lack support for `--apple-use-keychain`. diff --git a/content/authentication/troubleshooting-ssh/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md b/content/authentication/troubleshooting-ssh/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md index 8d815912eaad..e1b0499e2485 100644 --- a/content/authentication/troubleshooting-ssh/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md +++ b/content/authentication/troubleshooting-ssh/error-ssl-certificate-problem-verify-that-the-ca-cert-is-ok.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghec: '*' shortTitle: SSL certificate problem +category: + - Troubleshoot authentication issues --- The error you receive may look like the following: diff --git a/content/authentication/troubleshooting-ssh/error-unknown-key-type.md b/content/authentication/troubleshooting-ssh/error-unknown-key-type.md index eb43e75347d9..359dd99eb30a 100644 --- a/content/authentication/troubleshooting-ssh/error-unknown-key-type.md +++ b/content/authentication/troubleshooting-ssh/error-unknown-key-type.md @@ -8,6 +8,8 @@ versions: redirect_from: - /github/authenticating-to-github/error-unknown-key-type - /github/authenticating-to-github/troubleshooting-ssh/error-unknown-key-type +category: + - Troubleshoot authentication issues --- ## About the `unknown key type` error diff --git a/content/authentication/troubleshooting-ssh/error-were-doing-an-ssh-key-audit.md b/content/authentication/troubleshooting-ssh/error-were-doing-an-ssh-key-audit.md index 008fad0d317c..e8d30eeca723 100644 --- a/content/authentication/troubleshooting-ssh/error-were-doing-an-ssh-key-audit.md +++ b/content/authentication/troubleshooting-ssh/error-were-doing-an-ssh-key-audit.md @@ -11,6 +11,8 @@ versions: ghes: '*' ghec: '*' shortTitle: SSH key audit +category: + - Troubleshoot authentication issues --- When using an unverified key to perform Git operations, you will be prompted to perform an audit of your SSH keys. diff --git a/content/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md b/content/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md index 8ecb29b2f659..c37b730796b6 100644 --- a/content/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md +++ b/content/authentication/troubleshooting-ssh/recovering-your-ssh-key-passphrase.md @@ -12,6 +12,8 @@ versions: ghes: '*' ghec: '*' shortTitle: Recover SSH key passphrase +category: + - Troubleshoot authentication issues --- {% mac %} diff --git a/content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md b/content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md index 83327df41aa8..a2cbb69a9be1 100644 --- a/content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md +++ b/content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md @@ -9,6 +9,8 @@ versions: fpt: '*' ghec: '*' shortTitle: Use SSH over HTTPS port +category: + - Troubleshoot authentication issues --- > [!WARNING] From f78fe1d73b1edcd2d42917da9a4cf1834e776481 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Fri, 13 Mar 2026 10:49:39 -0700 Subject: [PATCH 3/4] Sync secret scanning data (#60212) Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../data/pattern-docs/fpt/public-docs.yml | 10 ++++++++++ .../data/pattern-docs/ghec/public-docs.yml | 10 ++++++++++ 2 files changed, 20 insertions(+) diff --git a/src/secret-scanning/data/pattern-docs/fpt/public-docs.yml b/src/secret-scanning/data/pattern-docs/fpt/public-docs.yml index 0aff6b371184..c95af330cab3 100644 --- a/src/secret-scanning/data/pattern-docs/fpt/public-docs.yml +++ b/src/secret-scanning/data/pattern-docs/fpt/public-docs.yml @@ -4036,6 +4036,16 @@ hasExtendedMetadata: false base64Supported: false isduplicate: false +- provider: Salesforce + supportedSecret: Salesforce Marketing Cloud API OAuth2 Token + secretType: salesforce_marketing_cloud_api_oauth2_token + isPublic: false + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + hasExtendedMetadata: false + base64Supported: false + isduplicate: false - provider: Salesforce supportedSecret: Salesforce OAuth2 Consumer Key secretType: salesforce_oauth2_consumer_key,
salesforce_oauth2_consumer_secret diff --git a/src/secret-scanning/data/pattern-docs/ghec/public-docs.yml b/src/secret-scanning/data/pattern-docs/ghec/public-docs.yml index 0aff6b371184..c95af330cab3 100644 --- a/src/secret-scanning/data/pattern-docs/ghec/public-docs.yml +++ b/src/secret-scanning/data/pattern-docs/ghec/public-docs.yml @@ -4036,6 +4036,16 @@ hasExtendedMetadata: false base64Supported: false isduplicate: false +- provider: Salesforce + supportedSecret: Salesforce Marketing Cloud API OAuth2 Token + secretType: salesforce_marketing_cloud_api_oauth2_token + isPublic: false + isPrivateWithGhas: true + hasPushProtection: false + hasValidityCheck: false + hasExtendedMetadata: false + base64Supported: false + isduplicate: false - provider: Salesforce supportedSecret: Salesforce OAuth2 Consumer Key secretType: salesforce_oauth2_consumer_key,
salesforce_oauth2_consumer_secret From 818d95e4bd74e05eccd4deb81e065da12d6b7ef2 Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Fri, 13 Mar 2026 17:53:36 +0000 Subject: [PATCH 4/4] [2026-03-12] Repository admins can opt-in to allow GitHub Actions checks to run automatically for Copilot coding agent PRs (#60103) Co-authored-by: hubwriter Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- .../agents/coding-agent/about-coding-agent.md | 6 +++-- .../configuring-agent-settings.md | 23 +++++++++++++++++++ .../use-copilot-agents/coding-agent/index.md | 1 + .../coding-agent/review-copilot-prs.md | 8 +------ ...ing-agent-workflow-run-approval-default.md | 9 ++++++++ 5 files changed, 38 insertions(+), 9 deletions(-) create mode 100644 content/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings.md create mode 100644 data/reusables/copilot/coding-agent-workflow-run-approval-default.md diff --git a/content/copilot/concepts/agents/coding-agent/about-coding-agent.md b/content/copilot/concepts/agents/coding-agent/about-coding-agent.md index 84adb65f128f..b26c2ade403e 100644 --- a/content/copilot/concepts/agents/coding-agent/about-coding-agent.md +++ b/content/copilot/concepts/agents/coding-agent/about-coding-agent.md @@ -142,7 +142,9 @@ Security is a fundamental consideration when you enable {% data variables.copilo * **Restricted development environment**: {% data variables.copilot.copilot_coding_agent %} works in a sandbox development environment with internet access controlled by a firewall. It has read-only access to the repository it's assigned to work in. * **Limited access to branches**: {% data variables.copilot.copilot_coding_agent %} can only create and push to branches beginning with `copilot/`. It is subject to any branch protections and required checks for the working repository. * **Responds only to users with write permissions**: {% data variables.copilot.copilot_coding_agent %} will not respond to feedback from users with lower levels of access. -* **Treated as an outside collaborator**: Draft pull requests proposed by {% data variables.copilot.copilot_coding_agent %} require approval by a user with write permissions before Actions workflows can run. {% data variables.copilot.copilot_coding_agent %} cannot mark its pull requests as "Ready for review" and cannot approve or merge a pull request. +* **Treated as an outside collaborator** + * Draft pull requests created by {% data variables.copilot.copilot_coding_agent %} must be reviewed and merged by a human. {% data variables.copilot.copilot_coding_agent %} cannot mark its pull requests as "Ready for review" and cannot approve or merge a pull request. + * By default, {% data variables.product.prodname_actions %} workflows are not triggered for {% data variables.copilot.copilot_coding_agent %}'s pull requests until a user with write access to the repository clicks the **Approve and run workflows** button. Optionally, you can configure {% data variables.product.prodname_copilot_short %} to allow workflows to run automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs#managing-github-actions-workflow-runs). * **Tracked for compliance**: {% data variables.copilot.copilot_coding_agent %}'s commits are co-authored by the developer who assigned the issue or requested the change to the pull request, allowing attribution of proposed changes. The developer who asked {% data variables.product.prodname_copilot_short %} to create a pull request cannot approve that pull request. In repositories where an approving review is required, this ensures that at least one independent developer reviews {% data variables.copilot.copilot_coding_agent %}'s work. For more information, see: @@ -161,7 +163,7 @@ To mitigate this risk, {% data variables.product.github %}: * **Limits who can assign tasks to {% data variables.copilot.copilot_coding_agent %}.** Only users with write access to the repository can trigger {% data variables.copilot.copilot_coding_agent %} to work. Comments from users without write access are never presented to the agent. * **Limits the permissions in access tokens used by {% data variables.copilot.copilot_coding_agent %}.** Pushes are only allowed to branches beginning with `copilot/`. {% data variables.copilot.copilot_coding_agent %} cannot push to the `main` or `master` branches. * **Limits {% data variables.copilot.copilot_coding_agent %}'s credentials.** {% data variables.copilot.copilot_coding_agent %} can only perform simple push operations. It cannot directly run `git push` or other Git commands. -* **Restricts {% data variables.product.prodname_actions %} workflow runs.** Workflows are not triggered until {% data variables.copilot.copilot_coding_agent %}'s code is reviewed and a user with write access to the repo clicks the **Approve and run workflows** button. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot). +* **Restricts {% data variables.product.prodname_actions %} workflow runs.** By default, workflows are not triggered until {% data variables.copilot.copilot_coding_agent %}'s code is reviewed and a user with write access to the repository clicks the **Approve and run workflows** button. Optionally, you can configure {% data variables.product.prodname_copilot_short %} to allow workflows to run automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs#managing-github-actions-workflow-runs). * **Prevents the user who asked {% data variables.copilot.copilot_coding_agent %} to create a pull request from approving it.** This maintains the expected controls in the "Required approvals" rule and branch protection. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets). ### Risk: {% data variables.copilot.copilot_coding_agent %} has access to sensitive information diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings.md new file mode 100644 index 000000000000..306c20a082fc --- /dev/null +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings.md @@ -0,0 +1,23 @@ +--- +title: Configuring settings for GitHub Copilot coding agent +shortTitle: Configuring agent settings +intro: 'Learn how to configure settings for {% data variables.copilot.copilot_coding_agent %}' +versions: + feature: copilot +topics: + - Copilot +contentType: how-tos +category: + - Configure Copilot +--- + +## Allowing {% data variables.product.prodname_actions %} workflows to run automatically when {% data variables.product.prodname_copilot_short %} pushes + +{% data reusables.copilot.coding-agent-workflow-run-approval-default %} + +> [!WARNING] Allowing {% data variables.product.prodname_actions %} workflows to run without approval may allow unreviewed code written by {% data variables.product.prodname_copilot_short %} to gain write access to your repository or access your {% data variables.product.prodname_actions %} secrets. + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short %}**. +1. In the "Actions workflow approval" section, disable the **Require approval for workflow runs** setting. \ No newline at end of file diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md index bf81d8725a53..a2ef8df2f1d7 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md @@ -23,6 +23,7 @@ children: - /customize-the-agent-environment - /customize-the-agent-firewall - /use-hooks + - /configuring-agent-settings - /troubleshoot-coding-agent redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md index 0ed547ae2790..fd0910f626ef 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md +++ b/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md @@ -48,13 +48,7 @@ For more information, see the section "Use comments to iterate on a pull request ## Managing {% data variables.product.prodname_actions %} workflow runs -{% data variables.product.prodname_actions %} workflows will not run automatically when {% data variables.product.prodname_copilot_short %} pushes changes to a pull request. - -{% data variables.product.prodname_actions %} workflows can be privileged and have access to sensitive secrets. {% data reusables.actions.workflows.inspect-proposed-changes %} - -To allow {% data variables.product.prodname_actions %} workflows to run, click the **Approve and run workflows** button in the pull request's merge box. - -![Screenshot of the merge box on a pull request from Copilot with the "Approve and run workflows" button.](/assets/images/help/copilot/coding-agent/approve-and-run-workflows.png) +{% data reusables.copilot.coding-agent-workflow-run-approval-default %} For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings). ## Giving feedback on {% data variables.product.prodname_copilot_short %}'s work diff --git a/data/reusables/copilot/coding-agent-workflow-run-approval-default.md b/data/reusables/copilot/coding-agent-workflow-run-approval-default.md new file mode 100644 index 000000000000..1b7685a58775 --- /dev/null +++ b/data/reusables/copilot/coding-agent-workflow-run-approval-default.md @@ -0,0 +1,9 @@ +By default, {% data variables.product.prodname_actions %} workflows will not run automatically when {% data variables.product.prodname_copilot_short %} pushes changes to a pull request. + +{% data variables.product.prodname_actions %} workflows can be privileged and have access to sensitive secrets. {% data reusables.actions.workflows.inspect-proposed-changes %} + +To allow {% data variables.product.prodname_actions %} workflows to run, click the **Approve and run workflows** button in the pull request's merge box. + +![Screenshot of the merge box on a pull request from {% data variables.product.prodname_copilot_short %} with the "Approve and run workflows" button.](/assets/images/help/copilot/coding-agent/approve-and-run-workflows.png) + +Optionally, you can configure {% data variables.copilot.copilot_coding_agent %} to allow {% data variables.product.prodname_actions %} workflows to run without human intervention. \ No newline at end of file