From a8c7801607b1a22483a6dde45ae14cac3c64d742 Mon Sep 17 00:00:00 2001 From: Roniece Ricardo <33437850+RonRicardo@users.noreply.github.com> Date: Fri, 20 Dec 2024 15:01:52 -0500 Subject: [PATCH] [Quote removal] Remove quotes from data/reusables/actions and data/reusables/accounts (#53657) Co-authored-by: Ashish Keshan Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> --- .../accounts/accounts-billed-separately.md | 2 +- .../accounts/create-personal-access-tokens.md | 2 +- .../accounts/you-must-know-your-password.md | 2 +- .../actions/about-artifact-attestations.md | 2 +- .../about-deployment-with-github-actions.md | 2 +- data/reusables/actions/about-environments.md | 2 +- .../actions/about-oidc-short-overview.md | 2 +- data/reusables/actions/about-runner-groups.md | 4 +-- .../about-security-hardening-for-worklows.md | 2 +- .../actions/action-bundled-actions.md | 2 +- .../actions/actions-activity-types.md | 2 +- .../actions-runner-controller-about-arc.md | 2 +- ...ons-secrets-variables-repository-access.md | 2 +- .../actions/actions-tab-new-runners-note.md | 4 +-- ...tions-usage-metrics-not-billing-metrics.md | 2 +- .../actions/add-hosted-runner-overview.md | 2 +- .../actions/allow-specific-actions-intro.md | 8 +++--- .../actions/arc-runners-namespace.md | 2 +- .../artifact-attestations-step-explanation.md | 2 +- .../artifact-log-retention-statement.md | 2 +- .../azure-vnet-about-larger-runners.md | 4 +-- .../azure-vnet-configuring-overview.md | 2 +- ...-creating-network-configuration-prereqs.md | 4 +-- .../actions/azure-vnet-enterprise-policy.md | 2 +- ...ure-vnet-hosted-compute-troubleshooting.md | 2 +- .../actions/azure-vnet-intro-capabilities.md | 2 +- .../actions/azure-vnet-next-steps-links.md | 6 ++-- .../actions/azure-vnet-procedures-prereqs.md | 4 +-- .../actions/azure-vnet-supported-regions.md | 2 +- .../reusables/actions/cd-templates-actions.md | 2 +- data/reusables/actions/choose-repo.md | 2 +- data/reusables/actions/commit-workflow.md | 2 +- .../actions/context-injection-warning.md | 2 +- .../actions/create-azure-app-plan.md | 4 +-- .../actions/create-azure-publish-profile.md | 4 +-- ...eating-a-runner-group-for-an-enterprise.md | 2 +- ...ting-a-runner-group-for-an-organization.md | 8 +++--- ...endabot-version-updates-actions-caveats.md | 2 +- .../dependabot-version-updates-for-actions.md | 2 +- .../disable-selfhosted-runners-crossrefs.md | 4 +-- .../actions/enabling-actions-metrics.md | 2 +- .../actions/enterprise-common-prereqs.md | 4 +-- ...nterprise-gcp-storage-credential-fields.md | 2 +- .../actions/enterprise-http-proxy.md | 2 +- .../actions/enterprise-limit-actions-use.md | 2 +- .../actions/enterprise-marketplace-actions.md | 2 +- .../enterprise-postinstall-nextsteps.md | 2 +- ...enterprise-s3-storage-credential-fields.md | 2 +- .../actions/enterprise-setup-prereq.md | 2 +- .../actions/enterprise-storage-about.md | 2 +- .../actions/forked-write-permission.md | 2 +- .../gai-config-environment-variables.md | 2 +- .../actions/gai-custom-transformers-rec.md | 2 +- data/reusables/actions/gai-inspect-audit.md | 2 +- .../actions/general-security-hardening.md | 2 +- ...github-hosted-runners-check-concurrency.md | 2 +- .../actions/github-token-permissions.md | 2 +- .../github-token-scope-descriptions.md | 28 +++++++++---------- .../actions/github_sha_description.md | 2 +- .../actions/if-supported-contexts.md | 2 +- .../actions/internal-actions-summary.md | 2 +- .../actions/introducing-enterprise.md | 2 +- .../ip-allow-list-self-hosted-runners.md | 2 +- .../jobs/choosing-runner-github-hosted.md | 6 ++-- .../actions/jobs/choosing-runner-overview.md | 2 +- .../jobs/choosing-runner-self-hosted.md | 2 +- .../actions/jobs/matrix-from-context.md | 4 +-- ...-assigning-permissions-to-jobs-specific.md | 2 +- .../section-assigning-permissions-to-jobs.md | 2 +- .../jobs/section-defining-outputs-for-jobs.md | 2 +- ...ion-running-jobs-in-a-container-options.md | 2 +- .../jobs/section-using-concurrency-jobs.md | 2 +- .../actions/jobs/section-using-concurrency.md | 2 +- ...ing-conditions-to-control-job-execution.md | 2 +- .../section-using-environments-for-jobs.md | 8 +++--- .../section-using-jobs-in-a-workflow-needs.md | 2 +- .../jobs/section-using-jobs-in-a-workflow.md | 4 +-- .../actions/jobs/using-matrix-strategy.md | 2 +- .../actions/larger-runner-name-note.md | 2 +- ...r-runners-troubleshooting-linux-windows.md | 8 +++--- .../actions/learn-more-about-yaml.md | 2 +- data/reusables/actions/make-workflow-file.md | 2 +- .../reusables/actions/migrating-enterprise.md | 2 +- .../actions/more-resources-for-ghes.md | 2 +- .../oidc-deployment-protection-rules.md | 2 +- data/reusables/actions/oidc-link-to-intro.md | 2 +- data/reusables/actions/oidc-on-ghecom.md | 2 +- .../actions/oidc-permissions-token.md | 4 +-- .../reusables/actions/oidc-security-notice.md | 2 +- .../actions/onboarding-next-steps.md | 14 +++++----- .../org-access-to-github-hosted-runners.md | 2 +- .../org-to-enterprise-actions-permissions.md | 2 +- .../actions/partial-reruns-with-reusable.md | 6 ++-- ...ment-secrets-and-variables-organization.md | 2 +- ...rmissions-statement-secrets-environment.md | 2 +- .../actions/postgres-environment-variables.md | 2 +- ...pull-request-target-permissions-warning.md | 2 +- .../actions/redis-environment-variables.md | 2 +- data/reusables/actions/reusable-keyword.md | 2 +- .../reusable-workflow-calling-syntax.md | 2 +- data/reusables/actions/reusable-workflows.md | 2 +- .../actions/run-jobs-larger-runners.md | 2 +- data/reusables/actions/runner-labels.md | 2 +- .../actions/runner-tool-cache-description.md | 2 +- .../secrets-and-variables-org-permissions.md | 2 +- .../actions/self-hosted-runner-configure.md | 2 +- ...self-hosted-runner-networking-to-dotcom.md | 2 +- .../self-hosted-runner-ports-protocols.md | 2 +- .../self-hosted-runner-public-repo-access.md | 2 +- .../actions/self-hosted-runner-reqs-docker.md | 2 +- .../self-hosted-runner-security-admonition.md | 2 +- .../self-hosted-runners-prerequisites.md | 2 +- .../actions/service-container-prereqs.md | 2 +- .../settings-actions-pages-custom-workflow.md | 2 +- .../actions/supported-github-runners.md | 2 +- data/reusables/actions/third-party-actions.md | 2 +- .../upgrade-runners-before-upgrade-ghes.md | 2 +- .../reusables/actions/use-request-body-api.md | 2 +- .../actions/viewing-actions-metrics.md | 4 +-- .../workflow-basic-example-and-explanation.md | 4 +-- .../actions/workflow-permissions-intro.md | 2 +- .../actions/workflow-run-approve-link.md | 2 +- .../workflow-run-approve-public-fork.md | 4 +-- .../actions/workflow-runs-dependabot-note.md | 2 +- .../actions/workflow-templates-categories.md | 6 ++-- ...workflow-templates-for-more-information.md | 2 +- .../actions/workflow-templates-repo-link.md | 2 +- .../workflows-from-public-fork-setting.md | 2 +- .../workflows/required-workflow-beta.md | 4 +-- .../required-workflow-prerequisites.md | 8 +++--- .../required-workflow-source-notes.md | 4 +-- .../run-on-specific-branches-or-tags1.md | 2 +- .../workflows/section-specifying-branches.md | 2 +- .../section-triggering-a-workflow-schedule.md | 2 +- .../section-triggering-a-workflow-types.md | 2 +- .../section-triggering-a-workflow.md | 2 +- .../workflows/triggering-a-workflow-paths1.md | 2 +- .../workflows/triggering-a-workflow-paths5.md | 2 +- .../triggering-workflow-branches1.md | 2 +- 139 files changed, 198 insertions(+), 198 deletions(-) diff --git a/data/reusables/accounts/accounts-billed-separately.md b/data/reusables/accounts/accounts-billed-separately.md index e345b271fe13..9e417e9ed1b1 100644 --- a/data/reusables/accounts/accounts-billed-separately.md +++ b/data/reusables/accounts/accounts-billed-separately.md @@ -1 +1 @@ -Each account on {% data variables.product.product_name %} is billed separately. Upgrading an organization account enables paid features for the organization's repositories only and does not affect the features available in repositories owned by any associated personal accounts. Similarly, upgrading a personal account enables paid features for the personal account's repositories only and does not affect the repositories of any organization accounts. For more information about account types, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)." +Each account on {% data variables.product.product_name %} is billed separately. Upgrading an organization account enables paid features for the organization's repositories only and does not affect the features available in repositories owned by any associated personal accounts. Similarly, upgrading a personal account enables paid features for the personal account's repositories only and does not affect the repositories of any organization accounts. For more information about account types, see [AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts). diff --git a/data/reusables/accounts/create-personal-access-tokens.md b/data/reusables/accounts/create-personal-access-tokens.md index d5f4dc61abb9..2c556616b31f 100644 --- a/data/reusables/accounts/create-personal-access-tokens.md +++ b/data/reusables/accounts/create-personal-access-tokens.md @@ -1 +1 @@ -1. For each of your accounts, create a dedicated {% data variables.product.pat_v1 %} with `repo` scope. {% ifversion pat-v2 %}Or, for each of your accounts and for each organization that you are a member of, create a {% data variables.product.pat_v2 %} that can access the desired repositories and that has read and write permissions on repository contents.{% endif %} For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." +1. For each of your accounts, create a dedicated {% data variables.product.pat_v1 %} with `repo` scope. {% ifversion pat-v2 %}Or, for each of your accounts and for each organization that you are a member of, create a {% data variables.product.pat_v2 %} that can access the desired repositories and that has read and write permissions on repository contents.{% endif %} For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). diff --git a/data/reusables/accounts/you-must-know-your-password.md b/data/reusables/accounts/you-must-know-your-password.md index fb12d1309ac1..e0daa499b49d 100644 --- a/data/reusables/accounts/you-must-know-your-password.md +++ b/data/reusables/accounts/you-must-know-your-password.md @@ -1 +1 @@ -If you protect your personal account with two-factor authentication but do not know your password, {% ifversion 2fa-recovery-flow %} you will need to start a two-factor authentication recovery request. For more information, see "[Request help with two-factor authentication](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials#requesting-help-with-two-factor-authentication)."{% else %}you will not be able to follow these steps to recover your account.{% data variables.product.company_short %} can send a password reset email to a verified address associated with your account. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials#requesting-a-new-password)."{% endif %} +If you protect your personal account with two-factor authentication but do not know your password, {% ifversion 2fa-recovery-flow %} you will need to start a two-factor authentication recovery request. For more information, see [Request help with two-factor authentication](/authentication/securing-your-account-with-two-factor-authentication-2fa/recovering-your-account-if-you-lose-your-2fa-credentials#requesting-help-with-two-factor-authentication).{% else %}you will not be able to follow these steps to recover your account.{% data variables.product.company_short %} can send a password reset email to a verified address associated with your account. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/updating-your-github-access-credentials#requesting-a-new-password).{% endif %} diff --git a/data/reusables/actions/about-artifact-attestations.md b/data/reusables/actions/about-artifact-attestations.md index 0860a1904871..ab2e90fa79c9 100644 --- a/data/reusables/actions/about-artifact-attestations.md +++ b/data/reusables/actions/about-artifact-attestations.md @@ -4,6 +4,6 @@ When you generate artifact attestations with your software, you create cryptogra * A link to the workflow associated with the artifact. * The repository, organization, environment, commit SHA, and triggering event for the artifact. -* Other information from the OIDC token used to establish provenance. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." +* Other information from the OIDC token used to establish provenance. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). You can also generate artifact attestations that include an associated software bill of materials (SBOM). Associating your builds with a list of the open source dependencies used in them provides transparency and enables consumers to comply with data protection standards. diff --git a/data/reusables/actions/about-deployment-with-github-actions.md b/data/reusables/actions/about-deployment-with-github-actions.md index d53b435cb81c..b07d10a6d78d 100644 --- a/data/reusables/actions/about-deployment-with-github-actions.md +++ b/data/reusables/actions/about-deployment-with-github-actions.md @@ -1 +1 @@ -You can deliver deployments through {% data variables.product.prodname_actions %} and environments or with the REST API and third party apps. For more information about using environments to deploy with {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment)." For more information about deployments with the REST API, see "[AUTOTITLE](/rest/repos#deployments)." +You can deliver deployments through {% data variables.product.prodname_actions %} and environments or with the REST API and third party apps. For more information about using environments to deploy with {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment). For more information about deployments with the REST API, see [AUTOTITLE](/rest/repos#deployments). diff --git a/data/reusables/actions/about-environments.md b/data/reusables/actions/about-environments.md index b8c0d8d7144f..998b2b1c39e0 100644 --- a/data/reusables/actions/about-environments.md +++ b/data/reusables/actions/about-environments.md @@ -1 +1 @@ -Environments are used to describe a general deployment target like `production`, `staging`, or `development`. When a {% data variables.product.prodname_actions %} workflow deploys to an environment, the environment is displayed on the main page of the repository. You can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow{% ifversion actions-custom-deployment-protection-rules-beta %}, gate deployments with custom deployment protection rules{% endif %}, or limit access to secrets. For more information about creating environments, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment)." +Environments are used to describe a general deployment target like `production`, `staging`, or `development`. When a {% data variables.product.prodname_actions %} workflow deploys to an environment, the environment is displayed on the main page of the repository. You can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow{% ifversion actions-custom-deployment-protection-rules-beta %}, gate deployments with custom deployment protection rules{% endif %}, or limit access to secrets. For more information about creating environments, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment). diff --git a/data/reusables/actions/about-oidc-short-overview.md b/data/reusables/actions/about-oidc-short-overview.md index 9e62e3e0d175..2bbcbd9cd490 100644 --- a/data/reusables/actions/about-oidc-short-overview.md +++ b/data/reusables/actions/about-oidc-short-overview.md @@ -1,2 +1,2 @@ -If your {% data variables.product.prodname_actions %} workflows need to access resources from a cloud provider that supports OpenID Connect (OIDC), you can configure your workflows to authenticate directly to the cloud provider. This will let you stop storing these credentials as long-lived secrets and provide other security benefits. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)" +If your {% data variables.product.prodname_actions %} workflows need to access resources from a cloud provider that supports OpenID Connect (OIDC), you can configure your workflows to authenticate directly to the cloud provider. This will let you stop storing these credentials as long-lived secrets and provide other security benefits. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect) diff --git a/data/reusables/actions/about-runner-groups.md b/data/reusables/actions/about-runner-groups.md index e3c5aa373a07..124d4df4cf2d 100644 --- a/data/reusables/actions/about-runner-groups.md +++ b/data/reusables/actions/about-runner-groups.md @@ -2,8 +2,8 @@ To control access to runners at the organization{% ifversion ghec or ghes %} and When you grant access to a runner group, you can see the runner group listed in the organization's runner settings. Optionally, you can assign additional granular repository{% ifversion restrict-groups-to-workflows %} and workflow{% endif %} access policies to the runner group. -When new runners are created, they are automatically assigned to the default group unless otherwise specified. Runners can only be in one group at a time. You can move runners from one runner group to another. For more information, see "[Moving a runner to a group](#moving-a-runner-to-a-group)." +When new runners are created, they are automatically assigned to the default group unless otherwise specified. Runners can only be in one group at a time. You can move runners from one runner group to another. For more information, see [Moving a runner to a group](#moving-a-runner-to-a-group). {% ifversion target-runner-groups %} -For information on how to route jobs to runners in a specific group, see "[AUTOTITLE](/actions/using-jobs/choosing-the-runner-for-a-job#choosing-runners-in-a-group)." +For information on how to route jobs to runners in a specific group, see [AUTOTITLE](/actions/using-jobs/choosing-the-runner-for-a-job#choosing-runners-in-a-group). {% endif %} diff --git a/data/reusables/actions/about-security-hardening-for-worklows.md b/data/reusables/actions/about-security-hardening-for-worklows.md index e26dba732b1e..f8e7011b1ed6 100644 --- a/data/reusables/actions/about-security-hardening-for-worklows.md +++ b/data/reusables/actions/about-security-hardening-for-worklows.md @@ -1 +1 @@ -{% data variables.product.prodname_dotcom %} provides security features that you can use to increase the security of your workflows. You can use {% data variables.product.prodname_dotcom %}'s built-in features to ensure you are notified about vulnerabilities in the actions you consume, or to automate the process of keeping the actions in your workflows up to date. For more information, see "[AUTOTITLE](/actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions)." +{% data variables.product.prodname_dotcom %} provides security features that you can use to increase the security of your workflows. You can use {% data variables.product.prodname_dotcom %}'s built-in features to ensure you are notified about vulnerabilities in the actions you consume, or to automate the process of keeping the actions in your workflows up to date. For more information, see [AUTOTITLE](/actions/security-guides/using-githubs-security-features-to-secure-your-use-of-github-actions). diff --git a/data/reusables/actions/action-bundled-actions.md b/data/reusables/actions/action-bundled-actions.md index 5df11302d5a6..90d8c73fabcf 100644 --- a/data/reusables/actions/action-bundled-actions.md +++ b/data/reusables/actions/action-bundled-actions.md @@ -1 +1 @@ -For more information about the action, and for instructions about how to download the most recent version, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions)." +For more information about the action, and for instructions about how to download the most recent version, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions). diff --git a/data/reusables/actions/actions-activity-types.md b/data/reusables/actions/actions-activity-types.md index 79b6f089ef0e..fc71bab10683 100644 --- a/data/reusables/actions/actions-activity-types.md +++ b/data/reusables/actions/actions-activity-types.md @@ -19,4 +19,4 @@ on: - labeled ``` -For more information about each event and their activity types, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows)." +For more information about each event and their activity types, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows). diff --git a/data/reusables/actions/actions-runner-controller-about-arc.md b/data/reusables/actions/actions-runner-controller-about-arc.md index ecb1da200fd5..6ba8ea90df37 100644 --- a/data/reusables/actions/actions-runner-controller-about-arc.md +++ b/data/reusables/actions/actions-runner-controller-about-arc.md @@ -1,3 +1,3 @@ {% data variables.product.prodname_actions_runner_controller %} (ARC) is a Kubernetes operator that orchestrates and scales self-hosted runners for {% data variables.product.prodname_actions %}. For more information, see [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) in the Kubernetes documentation. -With ARC, you can create runner scale sets that automatically scale based on the number of workflows running in your repository, organization, or enterprise. Because controlled runners can be ephemeral and based on containers, new runner instances can scale up or down rapidly and cleanly. For more information about autoscaling, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners)." +With ARC, you can create runner scale sets that automatically scale based on the number of workflows running in your repository, organization, or enterprise. Because controlled runners can be ephemeral and based on containers, new runner instances can scale up or down rapidly and cleanly. For more information about autoscaling, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners). diff --git a/data/reusables/actions/actions-secrets-variables-repository-access.md b/data/reusables/actions/actions-secrets-variables-repository-access.md index e62085078305..86800fda2e21 100644 --- a/data/reusables/actions/actions-secrets-variables-repository-access.md +++ b/data/reusables/actions/actions-secrets-variables-repository-access.md @@ -2,7 +2,7 @@ {% ifversion fpt %} > [!NOTE] -> Organization-level secrets and variables are not accessible by private repositories for {% data variables.product.prodname_free_user %}. For more information about upgrading your {% data variables.product.company_short %} subscription, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)". +> Organization-level secrets and variables are not accessible by private repositories for {% data variables.product.prodname_free_user %}. For more information about upgrading your {% data variables.product.company_short %} subscription, see [AUTOTITLE](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription). {% endif %} diff --git a/data/reusables/actions/actions-tab-new-runners-note.md b/data/reusables/actions/actions-tab-new-runners-note.md index 336daa78c6ae..7fe033d8b901 100644 --- a/data/reusables/actions/actions-tab-new-runners-note.md +++ b/data/reusables/actions/actions-tab-new-runners-note.md @@ -1,7 +1,7 @@ > [!NOTE] > Enterprise and organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %} can create runners from this page. To create a new runner, click **New runner** at the top right of the list of runners to add runners to the repository. > -> For more information, see {% ifversion actions-hosted-runners %}"[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners)" and {% endif %}"[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)." +> For more information, see {% ifversion actions-hosted-runners %}[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners) and {% endif %}[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners). {% ifversion custom-org-roles %} ->For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." +>For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles). {% endif %} diff --git a/data/reusables/actions/actions-usage-metrics-not-billing-metrics.md b/data/reusables/actions/actions-usage-metrics-not-billing-metrics.md index 6607b252b664..9402fad4c976 100644 --- a/data/reusables/actions/actions-usage-metrics-not-billing-metrics.md +++ b/data/reusables/actions/actions-usage-metrics-not-billing-metrics.md @@ -1,3 +1,3 @@ {% data variables.product.prodname_actions %} usage metrics do not apply minute multipliers to the metrics displayed. While they _can_ help you understand your bill, their primary purpose is to help you understand how and where Actions minutes are being used in your organization. -For more information about minute multipliers, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#minute-multipliers)." +For more information about minute multipliers, see [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#minute-multipliers). diff --git a/data/reusables/actions/add-hosted-runner-overview.md b/data/reusables/actions/add-hosted-runner-overview.md index 1d8f7e774089..7a3194dcfd9b 100644 --- a/data/reusables/actions/add-hosted-runner-overview.md +++ b/data/reusables/actions/add-hosted-runner-overview.md @@ -1,3 +1,3 @@ You can choose an operating system and a hardware configuration from the list of available options. When new instances of this runner are deployed through autoscaling, they'll use the same operating system and hardware configuration you've defined here. -New runners are automatically assigned to the default group, or you can choose which group the runners must join during the runner creation process. In addition, you can modify the runner's group membership after you've registered the runner. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/controlling-access-to-larger-runners)." +New runners are automatically assigned to the default group, or you can choose which group the runners must join during the runner creation process. In addition, you can modify the runner's group membership after you've registered the runner. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/controlling-access-to-larger-runners). diff --git a/data/reusables/actions/allow-specific-actions-intro.md b/data/reusables/actions/allow-specific-actions-intro.md index 4147bcd251ed..5101bfd92624 100644 --- a/data/reusables/actions/allow-specific-actions-intro.md +++ b/data/reusables/actions/allow-specific-actions-intro.md @@ -8,17 +8,17 @@ When you choose {% data reusables.actions.policy-label-for-select-actions-workfl {% data reusables.repositories.settings-permissions-org-policy-note %} * **Allow actions created by {% data variables.product.prodname_dotcom %}:** You can allow all actions created by {% data variables.product.prodname_dotcom %} to be used by workflows. Actions created by {% data variables.product.prodname_dotcom %} are located in the `actions` and `github` organizations. For more information, see the [`actions`](https://github.com/actions) and [`github`](https://github.com/github) organizations. -* **Allow Marketplace actions by verified creators:** {% ifversion ghes %}This option is available if you have {% data variables.product.prodname_github_connect %} enabled and configured with {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)."{% endif %} You can allow all {% data variables.product.prodname_marketplace %} actions created by verified creators to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}. +* **Allow Marketplace actions by verified creators:** {% ifversion ghes %}This option is available if you have {% data variables.product.prodname_github_connect %} enabled and configured with {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect).{% endif %} You can allow all {% data variables.product.prodname_marketplace %} actions created by verified creators to be used by workflows. When GitHub has verified the creator of the action as a partner organization, the {% octicon "verified" aria-label="The verified badge" %} badge is displayed next to the action in {% data variables.product.prodname_marketplace %}. * **Allow specified actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}:** You can restrict workflows to use actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in specific organizations and repositories. Specified actions cannot be set to more than 1000. To restrict access to specific tags or commit SHAs of an action{% ifversion actions-workflow-policy %} or reusable workflow{% endif %}, use the same syntax used in the workflow to select the action{% ifversion actions-workflow-policy %} or reusable workflow{% endif %}. - * For an action, the syntax is `OWNER/REPOSITORY@TAG-OR-SHA`. For example, use `actions/javascript-action@v1.0.1` to select a tag or `actions/javascript-action@a824008085750b8e136effc585c3cd6082bd575f` to select a SHA. For more information, see "[AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions#using-release-management-for-your-custom-actions)." + * For an action, the syntax is `OWNER/REPOSITORY@TAG-OR-SHA`. For example, use `actions/javascript-action@v1.0.1` to select a tag or `actions/javascript-action@a824008085750b8e136effc585c3cd6082bd575f` to select a SHA. For more information, see [AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions#using-release-management-for-your-custom-actions). {%- ifversion actions-workflow-policy %} - * For a reusable workflow, the syntax is `OWNER/REPOSITORY/PATH/FILENAME@TAG-OR-SHA`. For example, `octo-org/another-repo/.github/workflows/workflow.yml@v1`. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow)." + * For a reusable workflow, the syntax is `OWNER/REPOSITORY/PATH/FILENAME@TAG-OR-SHA`. For example, `octo-org/another-repo/.github/workflows/workflow.yml@v1`. For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow). {%- endif %} - You can use the `*` wildcard character to match patterns. For example, to allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in organizations that start with `space-org`, you can specify `space-org*/*`. To allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in repositories that start with octocat, you can use `*/octocat**@*`. For more information about using the `*` wildcard, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." + You can use the `*` wildcard character to match patterns. For example, to allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in organizations that start with `space-org`, you can specify `space-org*/*`. To allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in repositories that start with octocat, you can use `*/octocat**@*`. For more information about using the `*` wildcard, see [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). Use `,` to separate patterns. For example, to allow `octocat` and `octokit`, you can specify `octocat/*, octokit/*`. diff --git a/data/reusables/actions/arc-runners-namespace.md b/data/reusables/actions/arc-runners-namespace.md index 320248b16ffe..a65e73e57896 100644 --- a/data/reusables/actions/arc-runners-namespace.md +++ b/data/reusables/actions/arc-runners-namespace.md @@ -1,2 +1,2 @@ > [!NOTE] -> Create the secret in the same namespace where the `gha-runner-scale-set` chart is installed. In this example, the namespace is `arc-runners` to match the quickstart documentation. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller#configuring-a-runner-scale-set)." +> Create the secret in the same namespace where the `gha-runner-scale-set` chart is installed. In this example, the namespace is `arc-runners` to match the quickstart documentation. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller#configuring-a-runner-scale-set). diff --git a/data/reusables/actions/artifact-attestations-step-explanation.md b/data/reusables/actions/artifact-attestations-step-explanation.md index 393fcdd3edd0..bb07276e1764 100644 --- a/data/reusables/actions/artifact-attestations-step-explanation.md +++ b/data/reusables/actions/artifact-attestations-step-explanation.md @@ -1 +1 @@ -In the last step, it generates an artifact attestation for the image, which increases supply chain security. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)." +In the last step, it generates an artifact attestation for the image, which increases supply chain security. For more information, see [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). diff --git a/data/reusables/actions/artifact-log-retention-statement.md b/data/reusables/actions/artifact-log-retention-statement.md index 677a8b7dd28c..65c0f8236f82 100644 --- a/data/reusables/actions/artifact-log-retention-statement.md +++ b/data/reusables/actions/artifact-log-retention-statement.md @@ -1 +1 @@ -By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see "[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy)." +By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy). diff --git a/data/reusables/actions/azure-vnet-about-larger-runners.md b/data/reusables/actions/azure-vnet-about-larger-runners.md index 6acb63f09b6a..1bcc96606ea1 100644 --- a/data/reusables/actions/azure-vnet-about-larger-runners.md +++ b/data/reusables/actions/azure-vnet-about-larger-runners.md @@ -1,3 +1,3 @@ -2-64 vCPU Ubuntu and Windows runners are supported with Azure VNET. For more information on these runner types, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#about-ubuntu-and-windows-larger-runners)." +2-64 vCPU Ubuntu and Windows runners are supported with Azure VNET. For more information on these runner types, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#about-ubuntu-and-windows-larger-runners). -{% data reusables.actions.static-ip-limitation-vnet %} You must use dynamic IP addresses, which is the default configuration for larger runners. For more information about networking for larger runners, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#networking-for-larger-runners)." +{% data reusables.actions.static-ip-limitation-vnet %} You must use dynamic IP addresses, which is the default configuration for larger runners. For more information about networking for larger runners, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#networking-for-larger-runners). diff --git a/data/reusables/actions/azure-vnet-configuring-overview.md b/data/reusables/actions/azure-vnet-configuring-overview.md index 0b5d423d0ea6..5a69640a9153 100644 --- a/data/reusables/actions/azure-vnet-configuring-overview.md +++ b/data/reusables/actions/azure-vnet-configuring-overview.md @@ -2,4 +2,4 @@ To use {% data variables.product.company_short %}-hosted runners with Azure VNET The following procedures will lead you through both steps. -For more information about troubleshooting common issues with using {% data variables.product.company_short %}-hosted runners with Azure VNET, see {% ifversion ghec %}"[AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-enterprise)."{% else %}"[AUTOTITLE](/organizations/managing-organization-settings/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-organization)."{% endif %} +For more information about troubleshooting common issues with using {% data variables.product.company_short %}-hosted runners with Azure VNET, see {% ifversion ghec %}[AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-enterprise).{% else %}[AUTOTITLE](/organizations/managing-organization-settings/troubleshooting-azure-private-network-configurations-for-github-hosted-runners-in-your-organization).{% endif %} diff --git a/data/reusables/actions/azure-vnet-creating-network-configuration-prereqs.md b/data/reusables/actions/azure-vnet-creating-network-configuration-prereqs.md index c46bb0dee1af..7ae6c90a5895 100644 --- a/data/reusables/actions/azure-vnet-creating-network-configuration-prereqs.md +++ b/data/reusables/actions/azure-vnet-creating-network-configuration-prereqs.md @@ -1,7 +1,7 @@ -After configuring your Azure resources, you can use an Azure Virtual Network (VNET) for private networking by creating a network configuration{% ifversion ghec %} at the enterprise or organization level{% else %} at the organization level{% endif %}. Then, you can associate that network configuration to runner groups. For more information about runner groups, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners)." +After configuring your Azure resources, you can use an Azure Virtual Network (VNET) for private networking by creating a network configuration{% ifversion ghec %} at the enterprise or organization level{% else %} at the organization level{% endif %}. Then, you can associate that network configuration to runner groups. For more information about runner groups, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners). Once the network configuration is associated with a runner group, all runners in that group will have access to the Azure VNET that has been connected to the underlying configuration. ### Prerequisites -Ensure your Azure resources have been configured _before_ adding a network configuration in {% data variables.product.company_short %}. For more information, see {% ifversion ghec %}"[AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners#configuring-your-azure-resources)."{% else %}For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization#configuring-your-azure-resources)."{% endif %} +Ensure your Azure resources have been configured _before_ adding a network configuration in {% data variables.product.company_short %}. For more information, see {% ifversion ghec %}[AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners#configuring-your-azure-resources).{% else %}[AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization#configuring-your-azure-resources).{% endif %} diff --git a/data/reusables/actions/azure-vnet-enterprise-policy.md b/data/reusables/actions/azure-vnet-enterprise-policy.md index d8286fbe75d8..13975ddc3644 100644 --- a/data/reusables/actions/azure-vnet-enterprise-policy.md +++ b/data/reusables/actions/azure-vnet-enterprise-policy.md @@ -1 +1 @@ -By default, organizations in an enterprise cannot create new network configurations and only inherit enterprise-level network configurations. Enterprise owners can set a policy that allows organizations in the enterprise to create network configurations that are independent of the enterprise. For more information, see "[AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise#enabling-creation-of-network-configurations-for-organizations)." +By default, organizations in an enterprise cannot create new network configurations and only inherit enterprise-level network configurations. Enterprise owners can set a policy that allows organizations in the enterprise to create network configurations that are independent of the enterprise. For more information, see [AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise#enabling-creation-of-network-configurations-for-organizations). diff --git a/data/reusables/actions/azure-vnet-hosted-compute-troubleshooting.md b/data/reusables/actions/azure-vnet-hosted-compute-troubleshooting.md index 7ef8f8d8ecfb..2947005dbb36 100644 --- a/data/reusables/actions/azure-vnet-hosted-compute-troubleshooting.md +++ b/data/reusables/actions/azure-vnet-hosted-compute-troubleshooting.md @@ -70,7 +70,7 @@ To fix this, either increase the size of the subnet you are using or reduce the ### Cannot delete subnet -In some cases, a subnet cannot be deleted because it has a Service Association Link (SAL) applied to it. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization#deleting-a-subnet)." +In some cases, a subnet cannot be deleted because it has a Service Association Link (SAL) applied to it. For more information, see [AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization#deleting-a-subnet). If you need to identify the network settings resource associated with the subnet, you can run the following `curl` command. To obtain an Azure Entra token, please refer to the [Azure documentation](https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli). Use the same `api-version` you used to create the resource. diff --git a/data/reusables/actions/azure-vnet-intro-capabilities.md b/data/reusables/actions/azure-vnet-intro-capabilities.md index cab3e06703fb..bc7deaab9a62 100644 --- a/data/reusables/actions/azure-vnet-intro-capabilities.md +++ b/data/reusables/actions/azure-vnet-intro-capabilities.md @@ -1,4 +1,4 @@ -You can connect multiple VNET subnets to {% data variables.product.github %} and manage private resource access for your runners via runner groups. For more information about runner groups, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners)." +You can connect multiple VNET subnets to {% data variables.product.github %} and manage private resource access for your runners via runner groups. For more information about runner groups, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners). Using {% data variables.product.company_short %}-hosted runners within Azure VNET allows you to perform the following actions. * Privately connect a runner to resources inside an Azure VNET without opening internet ports, including on-premises resources accessible from the Azure VNET. diff --git a/data/reusables/actions/azure-vnet-next-steps-links.md b/data/reusables/actions/azure-vnet-next-steps-links.md index b8d55fb5365c..38834b4c658c 100644 --- a/data/reusables/actions/azure-vnet-next-steps-links.md +++ b/data/reusables/actions/azure-vnet-next-steps-links.md @@ -2,7 +2,7 @@ To use {% data variables.product.company_short %}-hosted runners with an Azure V {% ifversion fpt %} -For procedures to configure Azure private networking at the organization level, see "[AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization)." +For procedures to configure Azure private networking at the organization level, see [AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization). {% endif %} @@ -10,8 +10,8 @@ For procedures to configure Azure private networking at the organization level, {% data reusables.actions.azure-vnet-enterprise-policy %} -For procedures to configure Azure private networking at the enterprise level, see "[AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise)." +For procedures to configure Azure private networking at the enterprise level, see [AUTOTITLE](/admin/configuration/configuring-private-networking-for-hosted-compute-products/configuring-private-networking-for-github-hosted-runners-in-your-enterprise). -For procedures to configure Azure private networking at the organization level, see "[AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization)." +For procedures to configure Azure private networking at the organization level, see [AUTOTITLE](/organizations/managing-organization-settings/configuring-private-networking-for-github-hosted-runners-in-your-organization). {% endif %} diff --git a/data/reusables/actions/azure-vnet-procedures-prereqs.md b/data/reusables/actions/azure-vnet-procedures-prereqs.md index e868838f4708..209909becde6 100644 --- a/data/reusables/actions/azure-vnet-procedures-prereqs.md +++ b/data/reusables/actions/azure-vnet-procedures-prereqs.md @@ -12,10 +12,10 @@ You will use a script to automate configuring your Azure resources. The `.bicep` file we provide contains the minimal set of rules to use {% data variables.product.company_short %}-hosted runners with Azure VNET. You may need to add rules for your specific use case. - If you use {% data variables.enterprise.data_residency %}, in the `AllowOutBoundGitHub` section, you must also include the egress IP ranges for {% data variables.enterprise.data_residency_site %}. See "[AUTOTITLE](/admin/data-residency/network-details-for-ghecom#ranges-for-egress-traffic)." + If you use {% data variables.enterprise.data_residency %}, in the `AllowOutBoundGitHub` section, you must also include the egress IP ranges for {% data variables.enterprise.data_residency_site %}. See [AUTOTITLE](/admin/data-residency/network-details-for-ghecom#ranges-for-egress-traffic). > [!NOTE] - > As an alternative to using the following file, to allow {% data variables.product.prodname_actions %} to communicate with the runners, you can allow the same firewall domains that are required for communication between self-hosted runners and {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud)." To determine the appropriate subnet IP address range, we recommend adding a 30% buffer to the maximum job concurrency you anticipate. For instance, if your network configuration's runners are set to a maximum job concurrency of 300, it's recommended to utilize a subnet IP address range that can accommodate at least 390 runners. This buffer helps ensure that your network can handle unexpected increases in VM needs to meet job concurrency without running out of IP addresses. + > As an alternative to using the following file, to allow {% data variables.product.prodname_actions %} to communicate with the runners, you can allow the same firewall domains that are required for communication between self-hosted runners and {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud). To determine the appropriate subnet IP address range, we recommend adding a 30% buffer to the maximum job concurrency you anticipate. For instance, if your network configuration's runners are set to a maximum job concurrency of 300, it's recommended to utilize a subnet IP address range that can accommodate at least 390 runners. This buffer helps ensure that your network can handle unexpected increases in VM needs to meet job concurrency without running out of IP addresses. ```bicep copy @description('NSG for outbound rules') diff --git a/data/reusables/actions/azure-vnet-supported-regions.md b/data/reusables/actions/azure-vnet-supported-regions.md index 7b7712b5bacd..5d38f727205e 100644 --- a/data/reusables/actions/azure-vnet-supported-regions.md +++ b/data/reusables/actions/azure-vnet-supported-regions.md @@ -1,6 +1,6 @@ The {% data variables.product.prodname_actions %} service supports a subset of all the regions that Azure provides. To facilitate communication between the {% data variables.product.prodname_actions %} service and your subnet, your subnet must be in one of the supported regions. -> [!NOTE] If you use {% data variables.enterprise.data_residency_short %} on {% data variables.enterprise.data_residency_site %}, the supported regions are different. See "[AUTOTITLE](/admin/data-residency/network-details-for-ghecom#supported-regions-for-azure-private-networking)." +> [!NOTE] If you use {% data variables.enterprise.data_residency_short %} on {% data variables.enterprise.data_residency_site %}, the supported regions are different. See [AUTOTITLE](/admin/data-residency/network-details-for-ghecom#supported-regions-for-azure-private-networking). The following regions are supported on {% data variables.product.prodname_dotcom_the_website %}. diff --git a/data/reusables/actions/cd-templates-actions.md b/data/reusables/actions/cd-templates-actions.md index 7e9cf34d8504..db3b02b47783 100644 --- a/data/reusables/actions/cd-templates-actions.md +++ b/data/reusables/actions/cd-templates-actions.md @@ -1,3 +1,3 @@ -{% data variables.product.product_name %} offers deployment workflow templates for several popular services, such as Azure Web App. To learn how to get started using a workflow template, see "[AUTOTITLE](/actions/learn-github-actions/using-starter-workflows)" or [browse the full list of deployment workflow templates](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as "[AUTOTITLE](/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service)." +{% data variables.product.product_name %} offers deployment workflow templates for several popular services, such as Azure Web App. To learn how to get started using a workflow template, see [AUTOTITLE](/actions/learn-github-actions/using-starter-workflows) or [browse the full list of deployment workflow templates](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as [AUTOTITLE](/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service). Many service providers also offer actions on {% data variables.product.prodname_marketplace %} for deploying to their service. For the full list, see [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?category=deployment&type=actions). diff --git a/data/reusables/actions/choose-repo.md b/data/reusables/actions/choose-repo.md index 0697e9cc6855..669cbc801168 100644 --- a/data/reusables/actions/choose-repo.md +++ b/data/reusables/actions/choose-repo.md @@ -1 +1 @@ -Choose a repository where you want to apply this project management workflow. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)." +Choose a repository where you want to apply this project management workflow. You can use an existing repository that you have write access to, or you can create a new repository. For more information about creating a repository, see [AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository). diff --git a/data/reusables/actions/commit-workflow.md b/data/reusables/actions/commit-workflow.md index e7192ed011a4..dca89c5f0386 100644 --- a/data/reusables/actions/commit-workflow.md +++ b/data/reusables/actions/commit-workflow.md @@ -1 +1 @@ -Commit your workflow file to the default branch of your repository. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." +Commit your workflow file to the default branch of your repository. For more information, see [AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files). diff --git a/data/reusables/actions/context-injection-warning.md b/data/reusables/actions/context-injection-warning.md index 74c4d3dce0ee..1d2958cbd3a9 100644 --- a/data/reusables/actions/context-injection-warning.md +++ b/data/reusables/actions/context-injection-warning.md @@ -1,2 +1,2 @@ > [!WARNING] -> When creating workflows and actions, you should always consider whether your code might execute untrusted input from possible attackers. Certain contexts should be treated as untrusted input, as an attacker could insert their own malicious content. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#understanding-the-risk-of-script-injections)." +> When creating workflows and actions, you should always consider whether your code might execute untrusted input from possible attackers. Certain contexts should be treated as untrusted input, as an attacker could insert their own malicious content. For more information, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#understanding-the-risk-of-script-injections). diff --git a/data/reusables/actions/create-azure-app-plan.md b/data/reusables/actions/create-azure-app-plan.md index 9f3bec8aed90..3fc7e779b32c 100644 --- a/data/reusables/actions/create-azure-app-plan.md +++ b/data/reusables/actions/create-azure-app-plan.md @@ -13,5 +13,5 @@ See the Azure documentation for more information on using the [Azure CLI](https://docs.microsoft.com/cli/azure/): - * For authentication, see "[Sign in with Azure CLI](https://docs.microsoft.com/cli/azure/authenticate-azure-cli)." - * If you need to create a new resource group, see "[az group](https://docs.microsoft.com/cli/azure/group?view=azure-cli-latest#az_group_create)." + * For authentication, see [Sign in with Azure CLI](https://docs.microsoft.com/cli/azure/authenticate-azure-cli). + * If you need to create a new resource group, see [az group](https://docs.microsoft.com/cli/azure/group?view=azure-cli-latest#az_group_create). diff --git a/data/reusables/actions/create-azure-publish-profile.md b/data/reusables/actions/create-azure-publish-profile.md index b2d540aa1684..a476d06f89fc 100644 --- a/data/reusables/actions/create-azure-publish-profile.md +++ b/data/reusables/actions/create-azure-publish-profile.md @@ -1,5 +1,5 @@ 1. Configure an Azure publish profile and create an `AZURE_WEBAPP_PUBLISH_PROFILE` secret. - Generate your Azure deployment credentials using a publish profile. For more information, see "[Generate deployment credentials](https://docs.microsoft.com/azure/app-service/deploy-github-actions?tabs=applevel#generate-deployment-credentials)" in the Azure documentation. + Generate your Azure deployment credentials using a publish profile. For more information, see [Generate deployment credentials](https://docs.microsoft.com/azure/app-service/deploy-github-actions?tabs=applevel#generate-deployment-credentials) in the Azure documentation. - In your {% data variables.product.prodname_dotcom %} repository, create a secret named `AZURE_WEBAPP_PUBLISH_PROFILE` that contains the contents of the publish profile. For more information on creating secrets, see "[AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)." + In your {% data variables.product.prodname_dotcom %} repository, create a secret named `AZURE_WEBAPP_PUBLISH_PROFILE` that contains the contents of the publish profile. For more information on creating secrets, see [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository). diff --git a/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md b/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md index 66f89442da0b..6b07063d03e1 100644 --- a/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md +++ b/data/reusables/actions/creating-a-runner-group-for-an-enterprise.md @@ -9,7 +9,7 @@ Always include a security admonition above this procedure. This is either one of Enterprises can add their runners to groups for access management. Enterprises can create groups of runners that are accessible to specific organizations in the enterprise account{% ifversion restrict-groups-to-workflows %} or to specific workflows{% endif %}. Organization owners can then assign additional granular repository{% ifversion restrict-groups-to-workflows %} or workflow{% endif %} access policies to the enterprise runner groups. For information about how to create a runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/actions#self-hosted-runner-groups). -If no group is specified during the registration process, runners are automatically added to a default group. You can later move the runner from the default group to a custom group. For more information, see "[Moving a runner to a group](#moving-a-runner-to-a-group)." +If no group is specified during the registration process, runners are automatically added to a default group. You can later move the runner from the default group to a custom group. For more information, see [Moving a runner to a group](#moving-a-runner-to-a-group). When creating a group, you must choose a policy that defines which organizations have access to the runner group. diff --git a/data/reusables/actions/creating-a-runner-group-for-an-organization.md b/data/reusables/actions/creating-a-runner-group-for-an-organization.md index 0061add99f36..6669be433ba3 100644 --- a/data/reusables/actions/creating-a-runner-group-for-an-organization.md +++ b/data/reusables/actions/creating-a-runner-group-for-an-organization.md @@ -8,13 +8,13 @@ Always include a security admonition above this procedure. This is either one of {% endcomment %} > [!NOTE] -> When creating a runner group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. To change which repositories and workflows can access the runner group, organization owners{% ifversion custom-org-roles %} and users with the “Manage organization runners and runner groups” permission{% endif %} can set a policy for the organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners)." +> When creating a runner group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. To change which repositories and workflows can access the runner group, organization owners{% ifversion custom-org-roles %} and users with the “Manage organization runners and runner groups” permission{% endif %} can set a policy for the organization. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners). -All organizations have a single default runner group. {% ifversion fpt %}Organization owners using the {% data variables.product.prodname_team %} plan{% else %}Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %}{% endif %} can create additional organization-level runner groups. {% ifversion custom-org-roles %}For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."{% endif %} +All organizations have a single default runner group. {% ifversion fpt %}Organization owners using the {% data variables.product.prodname_team %} plan{% else %}Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %}{% endif %} can create additional organization-level runner groups. {% ifversion custom-org-roles %}For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).{% endif %} -If no group is specified during the registration process, runners are automatically added to the default group. You can later move the runner from the default group to a custom group. For more information, see "[Moving a runner to a group](#moving-a-runner-to-a-group)." +If no group is specified during the registration process, runners are automatically added to the default group. You can later move the runner from the default group to a custom group. For more information, see [Moving a runner to a group](#moving-a-runner-to-a-group). -For information about how to create a runner group with the REST API, see "[AUTOTITLE](/rest/actions#self-hosted-runner-groups)." +For information about how to create a runner group with the REST API, see [AUTOTITLE](/rest/actions#self-hosted-runner-groups). {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} diff --git a/data/reusables/actions/dependabot-version-updates-actions-caveats.md b/data/reusables/actions/dependabot-version-updates-actions-caveats.md index 09462d310b06..9c3902afbdef 100644 --- a/data/reusables/actions/dependabot-version-updates-actions-caveats.md +++ b/data/reusables/actions/dependabot-version-updates-actions-caveats.md @@ -1,3 +1,3 @@ * {% data variables.product.prodname_dependabot %} only supports updates to {% data variables.product.prodname_actions %} using the {% data variables.product.prodname_dotcom %} repository syntax, such as `{% data reusables.actions.action-checkout %}`. {% data variables.product.prodname_dependabot %} will ignore actions or reusable workflows referenced locally (for example, `./.github/actions/foo.yml`). * Docker Hub and {% data variables.product.prodname_registry %} {% data variables.product.prodname_container_registry %} URLs are currently not supported. For example, references to Docker container actions using `docker://` syntax aren't supported. -* {% data variables.product.prodname_dependabot %} supports both public and private repositories for {% data variables.product.prodname_actions %}. For private registry configuration options, see "`git`" in "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#git)." +* {% data variables.product.prodname_dependabot %} supports both public and private repositories for {% data variables.product.prodname_actions %}. For private registry configuration options, see "`git`" in [AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#git). diff --git a/data/reusables/actions/dependabot-version-updates-for-actions.md b/data/reusables/actions/dependabot-version-updates-for-actions.md index b455eb36c9dc..3ee2df44ccba 100644 --- a/data/reusables/actions/dependabot-version-updates-for-actions.md +++ b/data/reusables/actions/dependabot-version-updates-for-actions.md @@ -1 +1 @@ -You can use {% data variables.product.prodname_dependabot %} to ensure that references to actions and reusable workflows used in your repository are kept up to date. Actions are often updated with bug fixes and new features to make automated processes faster, safer, and more reliable. {% data variables.product.prodname_dependabot %} takes the effort out of maintaining your dependencies as it does this automatically for you. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot)" and "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)." +You can use {% data variables.product.prodname_dependabot %} to ensure that references to actions and reusable workflows used in your repository are kept up to date. Actions are often updated with bug fixes and new features to make automated processes faster, safer, and more reliable. {% data variables.product.prodname_dependabot %} takes the effort out of maintaining your dependencies as it does this automatically for you. For more information, see [AUTOTITLE](/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot) and [AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates). diff --git a/data/reusables/actions/disable-selfhosted-runners-crossrefs.md b/data/reusables/actions/disable-selfhosted-runners-crossrefs.md index c5e31c92d4f9..2cc86e9ea8fb 100644 --- a/data/reusables/actions/disable-selfhosted-runners-crossrefs.md +++ b/data/reusables/actions/disable-selfhosted-runners-crossrefs.md @@ -1,5 +1,5 @@ {% ifversion ghec or ghes %}Enterprise owners and organization {% elsif fpt %}Organization {% endif %}owners can choose which repositories are allowed to create repository-level self-hosted runners. {% ifversion custom-org-roles %}Users with the “Manage organization runners and runner groups” permission can only choose which repositories are allowed to create repository-level self-hosted runners for repositories in your organization{% endif %}. -{% ifversion custom-org-roles %}For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."{% endif %} +{% ifversion custom-org-roles %}For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).{% endif %} -For more information, see {% ifversion ghec or ghes %}"[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners)" and {% endif %}"[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#limiting-the-use-of-self-hosted-runners)." +For more information, see {% ifversion ghec or ghes %}[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners) and {% endif %}[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#limiting-the-use-of-self-hosted-runners). diff --git a/data/reusables/actions/enabling-actions-metrics.md b/data/reusables/actions/enabling-actions-metrics.md index a16103819089..81f2b62b1824 100644 --- a/data/reusables/actions/enabling-actions-metrics.md +++ b/data/reusables/actions/enabling-actions-metrics.md @@ -1,3 +1,3 @@ ## Enabling access to {% data variables.product.prodname_actions %} metrics -Organization owners can create custom organization roles to allow people to view {% data variables.product.prodname_actions %} usage metrics for their organization. To provide users with access, select the "View organization Actions metrics" role when creating a custom organization role. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." +Organization owners can create custom organization roles to allow people to view {% data variables.product.prodname_actions %} usage metrics for their organization. To provide users with access, select the "View organization Actions metrics" role when creating a custom organization role. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles). diff --git a/data/reusables/actions/enterprise-common-prereqs.md b/data/reusables/actions/enterprise-common-prereqs.md index 58f1fdc84ca5..b394ba8eebc3 100644 --- a/data/reusables/actions/enterprise-common-prereqs.md +++ b/data/reusables/actions/enterprise-common-prereqs.md @@ -1,5 +1,5 @@ -* Review the hardware requirements for {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)." -* TLS must be configured for {% data variables.product.prodname_ghe_server %}'s domain. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls)." +* Review the hardware requirements for {% data variables.product.prodname_actions %}. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations). +* TLS must be configured for {% data variables.product.prodname_ghe_server %}'s domain. For more information, see [AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls). > [!NOTE] > {% data reusables.actions.enterprise-self-signed-cert %} diff --git a/data/reusables/actions/enterprise-gcp-storage-credential-fields.md b/data/reusables/actions/enterprise-gcp-storage-credential-fields.md index 75d0036d40f4..359ae1e2e719 100644 --- a/data/reusables/actions/enterprise-gcp-storage-credential-fields.md +++ b/data/reusables/actions/enterprise-gcp-storage-credential-fields.md @@ -1,3 +1,3 @@ * **Service URL:** The service URL for your bucket. This is usually `https://storage.googleapis.com`. * **Bucket Name:** The name of your bucket. -* **HMAC Access Id and HMAC Secret:** The Google Cloud access ID and secret for your storage account. For more information, see "[Manage HMAC keys for service accounts](https://cloud.google.com/storage/docs/authentication/managing-hmackeys)" in the Google Cloud documentation. +* **HMAC Access Id and HMAC Secret:** The Google Cloud access ID and secret for your storage account. For more information, see [Manage HMAC keys for service accounts](https://cloud.google.com/storage/docs/authentication/managing-hmackeys) in the Google Cloud documentation. diff --git a/data/reusables/actions/enterprise-http-proxy.md b/data/reusables/actions/enterprise-http-proxy.md index bf4cc1b6504d..e9d722a9b92b 100644 --- a/data/reusables/actions/enterprise-http-proxy.md +++ b/data/reusables/actions/enterprise-http-proxy.md @@ -3,4 +3,4 @@ If you have an **HTTP Proxy Server** configured on {% data variables.product.git * You must add `.localhost`, `127.0.0.1`, and `::1` to the **HTTP Proxy Exclusion** list (in this order). * If your external storage location is not routable, then you must also add your external storage URL to the exclusion list. -For more information on changing your proxy settings, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server)." +For more information on changing your proxy settings, see [AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server). diff --git a/data/reusables/actions/enterprise-limit-actions-use.md b/data/reusables/actions/enterprise-limit-actions-use.md index be5b024087f3..f49aed364610 100644 --- a/data/reusables/actions/enterprise-limit-actions-use.md +++ b/data/reusables/actions/enterprise-limit-actions-use.md @@ -1 +1 @@ -After you enable {% data variables.product.prodname_github_connect %}, you can use policies to restrict which public actions can be used in repositories in your enterprise. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise)." +After you enable {% data variables.product.prodname_github_connect %}, you can use policies to restrict which public actions can be used in repositories in your enterprise. For more information, see [AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise). diff --git a/data/reusables/actions/enterprise-marketplace-actions.md b/data/reusables/actions/enterprise-marketplace-actions.md index 0f11e48f4df2..07b6b0b83270 100644 --- a/data/reusables/actions/enterprise-marketplace-actions.md +++ b/data/reusables/actions/enterprise-marketplace-actions.md @@ -1,6 +1,6 @@ {% ifversion ghes %} > [!NOTE] -> {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} may have limited access to actions on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom)" and contact your {% data variables.product.prodname_enterprise %} site administrator. +> {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} may have limited access to actions on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom) and contact your {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/data/reusables/actions/enterprise-postinstall-nextsteps.md b/data/reusables/actions/enterprise-postinstall-nextsteps.md index f8a883fe09e5..382cb4f67df2 100644 --- a/data/reusables/actions/enterprise-postinstall-nextsteps.md +++ b/data/reusables/actions/enterprise-postinstall-nextsteps.md @@ -1,3 +1,3 @@ ## Next steps -After the configuration run has successfully completed, {% data variables.product.prodname_actions %} will be enabled on {% data variables.product.github %}. For your next steps, such as managing {% data variables.product.prodname_actions %} access permissions and adding self-hosted runners, return to "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#enabling-github-actions-with-your-storage-provider)." +After the configuration run has successfully completed, {% data variables.product.prodname_actions %} will be enabled on {% data variables.product.github %}. For your next steps, such as managing {% data variables.product.prodname_actions %} access permissions and adding self-hosted runners, return to [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#enabling-github-actions-with-your-storage-provider). diff --git a/data/reusables/actions/enterprise-s3-storage-credential-fields.md b/data/reusables/actions/enterprise-s3-storage-credential-fields.md index a489441ddd1d..9b66b32602b7 100644 --- a/data/reusables/actions/enterprise-s3-storage-credential-fields.md +++ b/data/reusables/actions/enterprise-s3-storage-credential-fields.md @@ -1,5 +1,5 @@ * **AWS Service URL:** The service URL for your bucket. For example, if your S3 bucket was created in the `us-west-2` region, this value should be `https://s3.us-west-2.amazonaws.com`. - For more information, see "[AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html)" in the AWS documentation. + For more information, see [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html) in the AWS documentation. * **AWS S3 Bucket:** The name of your S3 bucket. * **AWS S3 Access Key and AWS S3 Secret Key:** The AWS access key ID and secret key for your bucket. diff --git a/data/reusables/actions/enterprise-setup-prereq.md b/data/reusables/actions/enterprise-setup-prereq.md index 9ac296ad5fd8..50f8d63ce73c 100644 --- a/data/reusables/actions/enterprise-setup-prereq.md +++ b/data/reusables/actions/enterprise-setup-prereq.md @@ -2,6 +2,6 @@ ### Using self-hosted runners on {% data variables.product.prodname_ghe_server %} -When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.prodname_ghe_server %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)." +When using setup actions (such as `actions/setup-LANGUAGE`) on {% data variables.product.prodname_ghe_server %} with self-hosted runners, you might need to set up the tools cache on runners that do not have internet access. For more information, see [AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access). {% endif %} diff --git a/data/reusables/actions/enterprise-storage-about.md b/data/reusables/actions/enterprise-storage-about.md index 1340778cdff0..c914cda08b66 100644 --- a/data/reusables/actions/enterprise-storage-about.md +++ b/data/reusables/actions/enterprise-storage-about.md @@ -1,3 +1,3 @@ ## About external storage for {% data variables.product.prodname_actions %} -{% data reusables.actions.enterprise-storage-contents %} For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#external-storage-requirements)." +{% data reusables.actions.enterprise-storage-contents %} For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#external-storage-requirements). diff --git a/data/reusables/actions/forked-write-permission.md b/data/reusables/actions/forked-write-permission.md index 40385b453b5e..d79fa4fb0846 100644 --- a/data/reusables/actions/forked-write-permission.md +++ b/data/reusables/actions/forked-write-permission.md @@ -1 +1 @@ -You can use the `permissions` key to add and remove read permissions for forked repositories, but typically you can't grant write access. The exception to this behavior is where an admin user has selected the **Send write tokens to workflows from pull requests** option in the {% data variables.product.prodname_actions %} settings. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks)." +You can use the `permissions` key to add and remove read permissions for forked repositories, but typically you can't grant write access. The exception to this behavior is where an admin user has selected the **Send write tokens to workflows from pull requests** option in the {% data variables.product.prodname_actions %} settings. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#enabling-workflows-for-private-repository-forks). diff --git a/data/reusables/actions/gai-config-environment-variables.md b/data/reusables/actions/gai-config-environment-variables.md index 08754679f2e9..20bf3e178393 100644 --- a/data/reusables/actions/gai-config-environment-variables.md +++ b/data/reusables/actions/gai-config-environment-variables.md @@ -1 +1 @@ -{% data variables.product.prodname_actions_importer %} uses environment variables for its authentication configuration. These variables are set when following the configuration process using the `configure` command. For more information, see the "[Configuring credentials](#configuring-credentials)" section. +{% data variables.product.prodname_actions_importer %} uses environment variables for its authentication configuration. These variables are set when following the configuration process using the `configure` command. For more information, see the [Configuring credentials](#configuring-credentials) section. diff --git a/data/reusables/actions/gai-custom-transformers-rec.md b/data/reusables/actions/gai-custom-transformers-rec.md index 03d3206b2f4c..54f3d3bec34c 100644 --- a/data/reusables/actions/gai-custom-transformers-rec.md +++ b/data/reusables/actions/gai-custom-transformers-rec.md @@ -1 +1 @@ -If there is anything that {% data variables.product.prodname_actions_importer %} was not able to convert automatically, such as unknown build steps or a partially successful pipeline, you might want to create custom transformers to further customize the conversion process. For more information, see "[AUTOTITLE](/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers)." +If there is anything that {% data variables.product.prodname_actions_importer %} was not able to convert automatically, such as unknown build steps or a partially successful pipeline, you might want to create custom transformers to further customize the conversion process. For more information, see [AUTOTITLE](/actions/migrating-to-github-actions/automated-migrations/extending-github-actions-importer-with-custom-transformers). diff --git a/data/reusables/actions/gai-inspect-audit.md b/data/reusables/actions/gai-inspect-audit.md index 3281c5bc7f3e..b08333fef458 100644 --- a/data/reusables/actions/gai-inspect-audit.md +++ b/data/reusables/actions/gai-inspect-audit.md @@ -37,7 +37,7 @@ The "Manual tasks" section contains an overview of tasks that {% data variables. Listed below are some key terms that can appear in the "Manual tasks" section: -* A **secret** is a repository or organization-level secret that is used in the converted pipelines. These secrets must be created manually in {% data variables.product.prodname_actions %} for these pipelines to function properly. For more information, see "[AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions)." +* A **secret** is a repository or organization-level secret that is used in the converted pipelines. These secrets must be created manually in {% data variables.product.prodname_actions %} for these pipelines to function properly. For more information, see [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions). * A **self-hosted runner** refers to a label of a runner that is referenced in a converted pipeline that is not a {% data variables.product.prodname_dotcom %}-hosted runner. You will need to manually define these runners for these pipelines to function properly. #### Files diff --git a/data/reusables/actions/general-security-hardening.md b/data/reusables/actions/general-security-hardening.md index d978bee46b02..b9d9a85bc65b 100644 --- a/data/reusables/actions/general-security-hardening.md +++ b/data/reusables/actions/general-security-hardening.md @@ -1,3 +1,3 @@ ## General security hardening for {% data variables.product.prodname_actions %} -If you want to learn more about security practices for {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions)." +If you want to learn more about security practices for {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions). diff --git a/data/reusables/actions/github-hosted-runners-check-concurrency.md b/data/reusables/actions/github-hosted-runners-check-concurrency.md index 3f5363640633..ecb3f5854348 100644 --- a/data/reusables/actions/github-hosted-runners-check-concurrency.md +++ b/data/reusables/actions/github-hosted-runners-check-concurrency.md @@ -1 +1 @@ -To identify any constraints with concurrency or queuing, you can check how many jobs are currently being processed on the {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/monitoring-your-current-jobs)." +To identify any constraints with concurrency or queuing, you can check how many jobs are currently being processed on the {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/monitoring-your-current-jobs). diff --git a/data/reusables/actions/github-token-permissions.md b/data/reusables/actions/github-token-permissions.md index 11d2ada1c33d..46f61bc10bed 100644 --- a/data/reusables/actions/github-token-permissions.md +++ b/data/reusables/actions/github-token-permissions.md @@ -1 +1 @@ -The `GITHUB_TOKEN` secret is set to an access token for the repository each time a job in a workflow begins. You should set the permissions for this access token in the workflow file to grant read access for the `contents` permission and write access for the `packages` permission. For more information, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication)." +The `GITHUB_TOKEN` secret is set to an access token for the repository each time a job in a workflow begins. You should set the permissions for this access token in the workflow file to grant read access for the `contents` permission and write access for the `packages` permission. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). diff --git a/data/reusables/actions/github-token-scope-descriptions.md b/data/reusables/actions/github-token-scope-descriptions.md index cd759c2c22e8..cfb25b3a4329 100644 --- a/data/reusables/actions/github-token-scope-descriptions.md +++ b/data/reusables/actions/github-token-scope-descriptions.md @@ -4,23 +4,23 @@ Available permissions and details of what each allows an action to do: | Permission | Allows an action using `GITHUB_TOKEN` to | | --- | --- | -| `actions` | Work with GitHub Actions. For example, `actions: write` permits an action to cancel a workflow run. For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-actions)." | +| `actions` | Work with GitHub Actions. For example, `actions: write` permits an action to cancel a workflow run. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-actions). | | {% ifversion artifact-attestations %} | -| `attestations` | Work with artifact attestations. For example, `attestations: write` permits an action to generate an artifact attestation for a build. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)" | +| `attestations` | Work with artifact attestations. For example, `attestations: write` permits an action to generate an artifact attestation for a build. For more information, see [AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds) | | {% endif %} | -| `checks` | Work with check runs and check suites. For example, `checks: write` permits an action to create a check run. For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-checks)." | -| `contents` | Work with the contents of the repository. For example, `contents: read` permits an action to list the commits, and `contents: write` allows the action to create a release. For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-contents)." | -| `deployments` | Work with deployments. For example, `deployments: write` permits an action to create a new deployment. For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-deployments)." | +| `checks` | Work with check runs and check suites. For example, `checks: write` permits an action to create a check run. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-checks). | +| `contents` | Work with the contents of the repository. For example, `contents: read` permits an action to list the commits, and `contents: write` allows the action to create a release. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-contents). | +| `deployments` | Work with deployments. For example, `deployments: write` permits an action to create a new deployment. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-deployments). | | {% ifversion discussions %} | -| `discussions` | Work with GitHub Discussions. For example, `discussions: write` permits an action to close or delete a discussion. For more information, see "[AUTOTITLE](/graphql/guides/using-the-graphql-api-for-discussions)." | +| `discussions` | Work with GitHub Discussions. For example, `discussions: write` permits an action to close or delete a discussion. For more information, see [AUTOTITLE](/graphql/guides/using-the-graphql-api-for-discussions). | | {% endif %} | | {% ifversion fpt or ghec %} | -| `id-token` | Fetch an OpenID Connect (OIDC) token. This requires `id-token: write`. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#updating-your-actions-for-oidc)" | +| `id-token` | Fetch an OpenID Connect (OIDC) token. This requires `id-token: write`. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#updating-your-actions-for-oidc) | | {% endif %} | -| `issues` | Work with issues. For example, `issues: write` permits an action to add a comment to an issue. For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-issues)." | -| `packages` | Work with GitHub Packages. For example, `packages: write` permits an action to upload and publish packages on GitHub Packages. For more information, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)." | -| `pages` | Work with GitHub Pages. For example, `pages: write` permits an action to request a GitHub Pages build. For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-pages)." | -| `pull-requests` | Work with pull requests. For example, `pull-requests: write` permits an action to add a label to a pull request. For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-pull-requests)." | -| `repository-projects` | Work with GitHub projects (classic). For example, `repository-projects: write` permits an action to add a column to a project (classic). For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-projects)." | -| `security-events` | Work with GitHub code scanning and Dependabot alerts. For example, `security-events: read` permits an action to list the Dependabot alerts for the repository, and `security-events: write` allows an action to update the status of a code scanning alert. For more information, see "[Repository permissions for 'Code scanning alerts'](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-code-scanning-alerts)" and "[Repository permissions for 'Dependabot alerts'](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-dependabot-alerts)" in "Permissions required for GitHub Apps." | -| `statuses` | Work with commit statuses. For example, `statuses:read` permits an action to list the commit statuses for a given reference. For more information, see "[AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-commit-statuses)." | +| `issues` | Work with issues. For example, `issues: write` permits an action to add a comment to an issue. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-issues). | +| `packages` | Work with GitHub Packages. For example, `packages: write` permits an action to upload and publish packages on GitHub Packages. For more information, see [AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries). | +| `pages` | Work with GitHub Pages. For example, `pages: write` permits an action to request a GitHub Pages build. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-pages). | +| `pull-requests` | Work with pull requests. For example, `pull-requests: write` permits an action to add a label to a pull request. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-pull-requests). | +| `repository-projects` | Work with GitHub projects (classic). For example, `repository-projects: write` permits an action to add a column to a project (classic). For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-projects). | +| `security-events` | Work with GitHub code scanning and Dependabot alerts. For example, `security-events: read` permits an action to list the Dependabot alerts for the repository, and `security-events: write` allows an action to update the status of a code scanning alert. For more information, see [Repository permissions for 'Code scanning alerts'](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-code-scanning-alerts) and [Repository permissions for 'Dependabot alerts'](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-dependabot-alerts) in "Permissions required for GitHub Apps." | +| `statuses` | Work with commit statuses. For example, `statuses:read` permits an action to list the commit statuses for a given reference. For more information, see [AUTOTITLE](/rest/overview/permissions-required-for-github-apps?apiVersion=2022-11-28#repository-permissions-for-commit-statuses). | diff --git a/data/reusables/actions/github_sha_description.md b/data/reusables/actions/github_sha_description.md index 80388d0ae8be..e12ca87925e4 100644 --- a/data/reusables/actions/github_sha_description.md +++ b/data/reusables/actions/github_sha_description.md @@ -1 +1 @@ -The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows)." For example, `ffac537e6cbbf934b08745a378932722df287a53`. +The commit SHA that triggered the workflow. The value of this commit SHA depends on the event that triggered the workflow. For more information, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows). For example, `ffac537e6cbbf934b08745a378932722df287a53`. diff --git a/data/reusables/actions/if-supported-contexts.md b/data/reusables/actions/if-supported-contexts.md index 100fdcde3663..a804cb5a23fd 100644 --- a/data/reusables/actions/if-supported-contexts.md +++ b/data/reusables/actions/if-supported-contexts.md @@ -1 +1 @@ -You can use any supported context and expression to create a conditional. For more information on which contexts are supported in this key, see "[AUTOTITLE](/actions/learn-github-actions/contexts#context-availability)." +You can use any supported context and expression to create a conditional. For more information on which contexts are supported in this key, see [AUTOTITLE](/actions/learn-github-actions/contexts#context-availability). diff --git a/data/reusables/actions/internal-actions-summary.md b/data/reusables/actions/internal-actions-summary.md index 9d4a6bfa4972..7a28a150627b 100644 --- a/data/reusables/actions/internal-actions-summary.md +++ b/data/reusables/actions/internal-actions-summary.md @@ -1,3 +1,3 @@ {% ifversion internal-actions %} -To share actions across your enterprise without publishing the actions publicly, you can store the actions in an internal repository, then configure the repository to allow access to {% data variables.product.prodname_actions %} workflows in other repositories owned by the same organization or by any organization in the enterprise. For more information, see "[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)." +To share actions across your enterprise without publishing the actions publicly, you can store the actions in an internal repository, then configure the repository to allow access to {% data variables.product.prodname_actions %} workflows in other repositories owned by the same organization or by any organization in the enterprise. For more information, see [AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise). {% endif %} diff --git a/data/reusables/actions/introducing-enterprise.md b/data/reusables/actions/introducing-enterprise.md index 19479ed3bf1e..ff371e61719a 100644 --- a/data/reusables/actions/introducing-enterprise.md +++ b/data/reusables/actions/introducing-enterprise.md @@ -1 +1 @@ -Before you get started, you should make a plan for how you'll introduce {% data variables.product.prodname_actions %} to your enterprise. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise)." +Before you get started, you should make a plan for how you'll introduce {% data variables.product.prodname_actions %} to your enterprise. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise). diff --git a/data/reusables/actions/ip-allow-list-self-hosted-runners.md b/data/reusables/actions/ip-allow-list-self-hosted-runners.md index 66c042b14853..3282b0f1d08d 100644 --- a/data/reusables/actions/ip-allow-list-self-hosted-runners.md +++ b/data/reusables/actions/ip-allow-list-self-hosted-runners.md @@ -1,4 +1,4 @@ > [!WARNING] -> If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners{% ifversion actions-hosted-runners %} or {% data variables.product.prodname_dotcom %}-hosted larger runners with static IP address ranges{% endif %}. When using [Azure private networking](/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise), IPs from your Azure subnet must be used. To reduce the number of required IPs, we recommend creating a load balancer to provide a single IP range for the GitHub allow list. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" {% ifversion actions-hosted-runners %} or "[AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners)"{% endif %}. +> If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners{% ifversion actions-hosted-runners %} or {% data variables.product.prodname_dotcom %}-hosted larger runners with static IP address ranges{% endif %}. When using [Azure private networking](/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise), IPs from your Azure subnet must be used. To reduce the number of required IPs, we recommend creating a load balancer to provide a single IP range for the GitHub allow list. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) {% ifversion actions-hosted-runners %} or [AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners){% endif %}. To allow your self-hosted {% ifversion actions-hosted-runners %}or larger hosted{% endif %} runners to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your runners to the IP allow list that you have configured for your enterprise. diff --git a/data/reusables/actions/jobs/choosing-runner-github-hosted.md b/data/reusables/actions/jobs/choosing-runner-github-hosted.md index 143e84c867a9..a89a1284afb5 100644 --- a/data/reusables/actions/jobs/choosing-runner-github-hosted.md +++ b/data/reusables/actions/jobs/choosing-runner-github-hosted.md @@ -6,11 +6,11 @@ If you use a {% data variables.product.prodname_dotcom %}-hosted runner, each jo The value for runs-on, when you are using a {% data variables.product.prodname_dotcom %}-hosted runner, is a runner label or the name of a runner group. The labels for the standard {% data variables.product.prodname_dotcom %}-hosted runners are shown in the following tables. -For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners)." +For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners). {% data reusables.actions.supported-github-runners %} -In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.product.prodname_dotcom %} offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of managed virtual machines with advanced features - for example, more cores and disk space, GPU-powered machines, and ARM-powered machines. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners)." +In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.product.prodname_dotcom %} offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of managed virtual machines with advanced features - for example, more cores and disk space, GPU-powered machines, and ARM-powered machines. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners). > [!NOTE] > The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. @@ -24,6 +24,6 @@ In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runs-on: ubuntu-latest ``` -For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners)." +For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners). {% endif %} diff --git a/data/reusables/actions/jobs/choosing-runner-overview.md b/data/reusables/actions/jobs/choosing-runner-overview.md index c4c386ac5cbd..c0914974bfe5 100644 --- a/data/reusables/actions/jobs/choosing-runner-overview.md +++ b/data/reusables/actions/jobs/choosing-runner-overview.md @@ -15,7 +15,7 @@ Use `jobs..runs-on` to define the type of machine to run the job on. runs-on: [self-hosted, linux, x64, gpu] ``` - For more information, see "[Choosing self-hosted runners](#choosing-self-hosted-runners)." + For more information, see [Choosing self-hosted runners](#choosing-self-hosted-runners). * You can mix strings and variables in an array. For example: {% raw %} diff --git a/data/reusables/actions/jobs/choosing-runner-self-hosted.md b/data/reusables/actions/jobs/choosing-runner-self-hosted.md index 9903fdb415f9..6632240cf0c6 100644 --- a/data/reusables/actions/jobs/choosing-runner-self-hosted.md +++ b/data/reusables/actions/jobs/choosing-runner-self-hosted.md @@ -6,4 +6,4 @@ runs-on: [self-hosted, linux] ``` -For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow)." +For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners) and [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow). diff --git a/data/reusables/actions/jobs/matrix-from-context.md b/data/reusables/actions/jobs/matrix-from-context.md index c6d8eebad588..6a787303be84 100644 --- a/data/reusables/actions/jobs/matrix-from-context.md +++ b/data/reusables/actions/jobs/matrix-from-context.md @@ -1,6 +1,6 @@ -You can use contexts to create matrices. For more information about contexts, see "[AUTOTITLE](/actions/learn-github-actions/contexts)." +You can use contexts to create matrices. For more information about contexts, see [AUTOTITLE](/actions/learn-github-actions/contexts). -For example, the following workflow triggers on the `repository_dispatch` event and uses information from the event payload to build the matrix. When a repository dispatch event is created with a payload like the one below, the matrix `version` variable will have a value of `[12, 14, 16]`. For more information about the `repository_dispatch` trigger, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#repository_dispatch)." +For example, the following workflow triggers on the `repository_dispatch` event and uses information from the event payload to build the matrix. When a repository dispatch event is created with a payload like the one below, the matrix `version` variable will have a value of `[12, 14, 16]`. For more information about the `repository_dispatch` trigger, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#repository_dispatch). ```json { diff --git a/data/reusables/actions/jobs/section-assigning-permissions-to-jobs-specific.md b/data/reusables/actions/jobs/section-assigning-permissions-to-jobs-specific.md index 0b862c0319b3..0743ff4545f3 100644 --- a/data/reusables/actions/jobs/section-assigning-permissions-to-jobs-specific.md +++ b/data/reusables/actions/jobs/section-assigning-permissions-to-jobs-specific.md @@ -1,3 +1,3 @@ -For a specific job, you can use `jobs..permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)." +For a specific job, you can use `jobs..permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token). By specifying the permission within a job definition, you can configure a different set of permissions for the `GITHUB_TOKEN` for each job, if required. Alternatively, you can specify the permissions for all jobs in the workflow. For information on defining permissions at the workflow level, see [`permissions`](/actions/using-workflows/workflow-syntax-for-github-actions#permissions). diff --git a/data/reusables/actions/jobs/section-assigning-permissions-to-jobs.md b/data/reusables/actions/jobs/section-assigning-permissions-to-jobs.md index d039bf637c7e..d3b06fd0b72c 100644 --- a/data/reusables/actions/jobs/section-assigning-permissions-to-jobs.md +++ b/data/reusables/actions/jobs/section-assigning-permissions-to-jobs.md @@ -1,4 +1,4 @@ -You can use `permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)." +You can use `permissions` to modify the default permissions granted to the `GITHUB_TOKEN`, adding or removing access as required, so that you only allow the minimum required access. For more information, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token). You can use `permissions` either as a top-level key, to apply to all jobs in the workflow, or within specific jobs. When you add the `permissions` key within a specific job, all actions and run commands within that job that use the `GITHUB_TOKEN` gain the access rights you specify. For more information, see [`jobs..permissions`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idpermissions). diff --git a/data/reusables/actions/jobs/section-defining-outputs-for-jobs.md b/data/reusables/actions/jobs/section-defining-outputs-for-jobs.md index cea54e513404..114ef1a9d0b4 100644 --- a/data/reusables/actions/jobs/section-defining-outputs-for-jobs.md +++ b/data/reusables/actions/jobs/section-defining-outputs-for-jobs.md @@ -6,7 +6,7 @@ Job outputs containing expressions are evaluated on the runner at the end of eac If an output is skipped because it may contain a secret, you will see the following warning message: "Skip output `{output.Key}` since it may contain secret." For more information on how to handle secrets, please refer to the [Example: Masking and passing a secret between jobs or workflows](/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#example-masking-and-passing-a-secret-between-jobs-or-workflows). -To use job outputs in a dependent job, you can use the `needs` context. For more information, see "[AUTOTITLE](/actions/learn-github-actions/contexts#needs-context)." +To use job outputs in a dependent job, you can use the `needs` context. For more information, see [AUTOTITLE](/actions/learn-github-actions/contexts#needs-context). ### Example: Defining outputs for a job diff --git a/data/reusables/actions/jobs/section-running-jobs-in-a-container-options.md b/data/reusables/actions/jobs/section-running-jobs-in-a-container-options.md index 6f67d9f38203..aaa329d00631 100644 --- a/data/reusables/actions/jobs/section-running-jobs-in-a-container-options.md +++ b/data/reusables/actions/jobs/section-running-jobs-in-a-container-options.md @@ -1,4 +1,4 @@ -Use `jobs..container.options` to configure additional Docker container resource options. For a list of options, see "[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)." +Use `jobs..container.options` to configure additional Docker container resource options. For a list of options, see [`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options). > [!WARNING] > The `--network` and `--entrypoint` options are not supported. diff --git a/data/reusables/actions/jobs/section-using-concurrency-jobs.md b/data/reusables/actions/jobs/section-using-concurrency-jobs.md index 9bda5ba7d4e6..71620124d1a9 100644 --- a/data/reusables/actions/jobs/section-using-concurrency-jobs.md +++ b/data/reusables/actions/jobs/section-using-concurrency-jobs.md @@ -1,4 +1,4 @@ -You can use `jobs..concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), and [`matrix`](/actions/learn-github-actions/contexts#matrix-context). For more information about expressions, see "[AUTOTITLE](/actions/learn-github-actions/expressions)." +You can use `jobs..concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), and [`matrix`](/actions/learn-github-actions/contexts#matrix-context). For more information about expressions, see [AUTOTITLE](/actions/learn-github-actions/expressions). You can also specify `concurrency` at the workflow level. For more information, see [`concurrency`](/actions/using-workflows/workflow-syntax-for-github-actions#concurrency). diff --git a/data/reusables/actions/jobs/section-using-concurrency.md b/data/reusables/actions/jobs/section-using-concurrency.md index 2a253f86be3f..f700f04430c7 100644 --- a/data/reusables/actions/jobs/section-using-concurrency.md +++ b/data/reusables/actions/jobs/section-using-concurrency.md @@ -1,4 +1,4 @@ -Use `concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context) and [`vars`](/actions/learn-github-actions/contexts#vars-context) contexts. For more information about expressions, see "[AUTOTITLE](/actions/learn-github-actions/expressions)." +Use `concurrency` to ensure that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can only use [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context) and [`vars`](/actions/learn-github-actions/contexts#vars-context) contexts. For more information about expressions, see [AUTOTITLE](/actions/learn-github-actions/expressions). You can also specify `concurrency` at the job level. For more information, see [`jobs..concurrency`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idconcurrency). diff --git a/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md b/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md index 813c8d772a74..277f46b94620 100644 --- a/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md +++ b/data/reusables/actions/jobs/section-using-conditions-to-control-job-execution.md @@ -3,7 +3,7 @@ You can use the `jobs..if` conditional to prevent a job from running unl > [!NOTE] > The `jobs..if` condition is evaluated before [`jobs..strategy.matrix`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) is applied. -{% data reusables.actions.expression-syntax-if %} For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions)." +{% data reusables.actions.expression-syntax-if %} For more information, see [AUTOTITLE](/actions/learn-github-actions/expressions). ### Example: Only run job for specific repository diff --git a/data/reusables/actions/jobs/section-using-environments-for-jobs.md b/data/reusables/actions/jobs/section-using-environments-for-jobs.md index 06492566e15a..c00afc34ea35 100644 --- a/data/reusables/actions/jobs/section-using-environments-for-jobs.md +++ b/data/reusables/actions/jobs/section-using-environments-for-jobs.md @@ -1,9 +1,9 @@ Use `jobs..environment` to define the environment that the job references. -You can provide the environment as only the environment `name`, or as an environment object with the `name` and `url`. The URL maps to `environment_url` in the deployments API. For more information about the deployments API, see "[AUTOTITLE](/rest/repos#deployments)." +You can provide the environment as only the environment `name`, or as an environment object with the `name` and `url`. The URL maps to `environment_url` in the deployments API. For more information about the deployments API, see [AUTOTITLE](/rest/repos#deployments). > [!NOTE] -> All deployment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment)." +> All deployment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment). ### Example: Using a single environment name @@ -23,7 +23,7 @@ environment: url: https://github.com ``` -The value of `url` can be an expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), [`matrix`](/actions/learn-github-actions/contexts#matrix-context), [`job`](/actions/learn-github-actions/contexts#job-context), [`runner`](/actions/learn-github-actions/contexts#runner-context), [`env`](/actions/learn-github-actions/contexts#env-context), and [`steps`](/actions/learn-github-actions/contexts#steps-context). For more information about expressions, see "[AUTOTITLE](/actions/learn-github-actions/expressions)." +The value of `url` can be an expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), [`matrix`](/actions/learn-github-actions/contexts#matrix-context), [`job`](/actions/learn-github-actions/contexts#job-context), [`runner`](/actions/learn-github-actions/contexts#runner-context), [`env`](/actions/learn-github-actions/contexts#env-context), and [`steps`](/actions/learn-github-actions/contexts#steps-context). For more information about expressions, see [AUTOTITLE](/actions/learn-github-actions/expressions). ### Example: Using output as URL @@ -37,7 +37,7 @@ environment: {% endraw %} -The value of `name` can be an expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), and [`matrix`](/actions/learn-github-actions/contexts#matrix-context). For more information about expressions, see "[AUTOTITLE](/actions/learn-github-actions/expressions)." +The value of `name` can be an expression. Allowed expression contexts: [`github`](/actions/learn-github-actions/contexts#github-context), [`inputs`](/actions/learn-github-actions/contexts#inputs-context), [`vars`](/actions/learn-github-actions/contexts#vars-context), [`needs`](/actions/learn-github-actions/contexts#needs-context), [`strategy`](/actions/learn-github-actions/contexts#strategy-context), and [`matrix`](/actions/learn-github-actions/contexts#matrix-context). For more information about expressions, see [AUTOTITLE](/actions/learn-github-actions/expressions). ### Example: Using an expression as environment name diff --git a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md index ca2221dc5d1f..f18cc1d3e831 100644 --- a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md +++ b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow-needs.md @@ -31,4 +31,4 @@ jobs: needs: [job1, job2] ``` -In this example, `job3` uses the `always()` conditional expression so that it always runs after `job1` and `job2` have completed, regardless of whether they were successful. For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions#status-check-functions)." +In this example, `job3` uses the `always()` conditional expression so that it always runs after `job1` and `job2` have completed, regardless of whether they were successful. For more information, see [AUTOTITLE](/actions/learn-github-actions/expressions#status-check-functions). diff --git a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow.md b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow.md index 048ad31d2151..6fc377b96374 100644 --- a/data/reusables/actions/jobs/section-using-jobs-in-a-workflow.md +++ b/data/reusables/actions/jobs/section-using-jobs-in-a-workflow.md @@ -2,6 +2,6 @@ A workflow run is made up of one or more `jobs`, which run in parallel by defaul Each job runs in a runner environment specified by `runs-on`. -You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see "[AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration)" for {% data variables.product.prodname_dotcom %}-hosted runners and "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#usage-limits)" for self-hosted runner usage limits. +You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration) for {% data variables.product.prodname_dotcom %}-hosted runners and [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#usage-limits) for self-hosted runner usage limits. -If you need to find the unique identifier of a job running in a workflow run, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. For more information, see "[AUTOTITLE](/rest/actions#workflow-jobs)." +If you need to find the unique identifier of a job running in a workflow run, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. For more information, see [AUTOTITLE](/rest/actions#workflow-jobs). diff --git a/data/reusables/actions/jobs/using-matrix-strategy.md b/data/reusables/actions/jobs/using-matrix-strategy.md index cc96b6e80a3b..de7dd27df5e4 100644 --- a/data/reusables/actions/jobs/using-matrix-strategy.md +++ b/data/reusables/actions/jobs/using-matrix-strategy.md @@ -22,4 +22,4 @@ By default, {% data variables.product.product_name %} will maximize the number o A matrix will generate a maximum of 256 jobs per workflow run. This limit applies to both {% data variables.product.product_name %}-hosted and self-hosted runners. -The variables that you define become properties in the `matrix` context, and you can reference the property in other areas of your workflow file. In this example, you can use `matrix.version` and `matrix.os` to access the current value of `version` and `os` that the job is using. For more information, see "[AUTOTITLE](/actions/learn-github-actions/contexts)." +The variables that you define become properties in the `matrix` context, and you can reference the property in other areas of your workflow file. In this example, you can use `matrix.version` and `matrix.os` to access the current value of `version` and `os` that the job is using. For more information, see [AUTOTITLE](/actions/learn-github-actions/contexts). diff --git a/data/reusables/actions/larger-runner-name-note.md b/data/reusables/actions/larger-runner-name-note.md index 7c78d5d5f929..6a310f9b0581 100644 --- a/data/reusables/actions/larger-runner-name-note.md +++ b/data/reusables/actions/larger-runner-name-note.md @@ -1,2 +1,2 @@ > [!NOTE] -> The names of {% data variables.actions.hosted_runners %} can dictate their functionality. For example, to use a {% data variables.actions.hosted_runner %} for {% data variables.product.prodname_code_scanning %} default setup, the runner must be named `code-scanning`. For more information on {% data variables.product.prodname_code_scanning %} with {% data variables.actions.hosted_runners %}, see "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup)." +> The names of {% data variables.actions.hosted_runners %} can dictate their functionality. For example, to use a {% data variables.actions.hosted_runner %} for {% data variables.product.prodname_code_scanning %} default setup, the runner must be named `code-scanning`. For more information on {% data variables.product.prodname_code_scanning %} with {% data variables.actions.hosted_runners %}, see [AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/configuring-larger-runners-for-default-setup). diff --git a/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md b/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md index e6f4f9ae0e42..675d813825c9 100644 --- a/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md +++ b/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md @@ -1,8 +1,8 @@ If you notice the jobs that target your {% data variables.actions.hosted_runner %}s are delayed or not running, there are several factors that may be causing this. -* **Concurrency settings:** You may have reached your maximum concurrency limit. If you would like to enable more jobs to run in parallel, you can update your autoscaling settings to a larger number. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#configuring-autoscaling-for-larger-runners)." -* **Repository permissions:** Ensure you have the appropriate repository permissions enabled for your {% data variables.actions.hosted_runner %}s. By default, enterprise runners are not available at the repository level and must be manually enabled by an organization administrator. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-larger-runners)." -* **Billing information:** You must have a valid credit card on file in order to use {% data variables.actions.hosted_runner %}s. After adding a credit card to your account, it can take up to 10 minutes to enable the use of your {% data variables.actions.hosted_runner %}s. For more information, see "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)." -* **Spending limit:** Your {% data variables.product.prodname_actions %} spending limit must be set to a value greater than zero. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions)." +* **Concurrency settings:** You may have reached your maximum concurrency limit. If you would like to enable more jobs to run in parallel, you can update your autoscaling settings to a larger number. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#configuring-autoscaling-for-larger-runners). +* **Repository permissions:** Ensure you have the appropriate repository permissions enabled for your {% data variables.actions.hosted_runner %}s. By default, enterprise runners are not available at the repository level and must be manually enabled by an organization administrator. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-larger-runners). +* **Billing information:** You must have a valid credit card on file in order to use {% data variables.actions.hosted_runner %}s. After adding a credit card to your account, it can take up to 10 minutes to enable the use of your {% data variables.actions.hosted_runner %}s. For more information, see [AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method). +* **Spending limit:** Your {% data variables.product.prodname_actions %} spending limit must be set to a value greater than zero. For more information, see [AUTOTITLE](/billing/managing-billing-for-github-actions/managing-your-spending-limit-for-github-actions). * **Fair use policy:** {% data variables.product.company_short %} has a fair use policy that begins to throttle jobs based on several factors, such as how many jobs you are running or how many jobs are running across the entirety of {% data variables.product.prodname_actions %}. * **Job queue to assign time:** Job queue to assign time refers to the time between a job request and {% data variables.product.company_short %} assigning a VM to execute the job. Standard {% data variables.product.company_short %}-hosted runners utilizing prescribed YAML workflow labels (such as `ubuntu-latest`) are always in a "warm" state. With larger runners, a warm machine may not be ready to pick up a job on first request as the pools for these machines are smaller. As a result, {% data variables.product.company_short %} may need to create a new VM, which increases the queue to assign time. Once a runner is in use, VMs are readily for subsequent workflow runs, reducing the queue to assign time for future workflow runs over the next 24 hours. diff --git a/data/reusables/actions/learn-more-about-yaml.md b/data/reusables/actions/learn-more-about-yaml.md index bb9997103e8e..71fbf771f2dc 100644 --- a/data/reusables/actions/learn-more-about-yaml.md +++ b/data/reusables/actions/learn-more-about-yaml.md @@ -1 +1 @@ -If you're new to YAML and want to learn more, see "[Learn YAML in Y minutes](https://learnxinyminutes.com/docs/yaml/)." +If you're new to YAML and want to learn more, see [Learn YAML in Y minutes](https://learnxinyminutes.com/docs/yaml/). diff --git a/data/reusables/actions/make-workflow-file.md b/data/reusables/actions/make-workflow-file.md index 3e5008ceb5b7..55824e63d8ae 100644 --- a/data/reusables/actions/make-workflow-file.md +++ b/data/reusables/actions/make-workflow-file.md @@ -1 +1 @@ -In your repository, create a file called `.github/workflows/YOUR_WORKFLOW.yml`, replacing `YOUR_WORKFLOW` with a name of your choice. This is a workflow file. For more information about creating new files on GitHub, see "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)." +In your repository, create a file called `.github/workflows/YOUR_WORKFLOW.yml`, replacing `YOUR_WORKFLOW` with a name of your choice. This is a workflow file. For more information about creating new files on GitHub, see [AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files). diff --git a/data/reusables/actions/migrating-enterprise.md b/data/reusables/actions/migrating-enterprise.md index a9e2f07ec675..94f5e5c2f666 100644 --- a/data/reusables/actions/migrating-enterprise.md +++ b/data/reusables/actions/migrating-enterprise.md @@ -1 +1 @@ -If you're migrating your enterprise to {% data variables.product.prodname_actions %} from another provider, there are additional considerations. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions)." +If you're migrating your enterprise to {% data variables.product.prodname_actions %} from another provider, there are additional considerations. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/migrating-your-enterprise-to-github-actions). diff --git a/data/reusables/actions/more-resources-for-ghes.md b/data/reusables/actions/more-resources-for-ghes.md index 7e210b31480a..d25fe8bb594f 100644 --- a/data/reusables/actions/more-resources-for-ghes.md +++ b/data/reusables/actions/more-resources-for-ghes.md @@ -5,4 +5,4 @@ If you plan to enable {% data variables.product.prodname_actions %} or {% data v These adjustments should be applied to the base requirements for each user tier. We recommend monitoring all changes to your resources, as further increases may be needed. -For more information about these requirements, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)." +For more information about these requirements, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations). diff --git a/data/reusables/actions/oidc-deployment-protection-rules.md b/data/reusables/actions/oidc-deployment-protection-rules.md index 98d137b1506c..f49b4e575133 100644 --- a/data/reusables/actions/oidc-deployment-protection-rules.md +++ b/data/reusables/actions/oidc-deployment-protection-rules.md @@ -1,2 +1,2 @@ > [!NOTE] -> When environments are used in workflows or in OIDC policies, we recommend adding protection rules to the environment for additional security. For example, you can configure deployment rules on an environment to restrict which branches and tags can deploy to the environment or access environment secrets. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-protection-rules)." +> When environments are used in workflows or in OIDC policies, we recommend adding protection rules to the environment for additional security. For example, you can configure deployment rules on an environment to restrict which branches and tags can deploy to the environment or access environment secrets. For more information, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-protection-rules). diff --git a/data/reusables/actions/oidc-link-to-intro.md b/data/reusables/actions/oidc-link-to-intro.md index 642802d3a5c2..ce45cea7412c 100644 --- a/data/reusables/actions/oidc-link-to-intro.md +++ b/data/reusables/actions/oidc-link-to-intro.md @@ -1 +1 @@ -* To learn the basic concepts of how {% data variables.product.prodname_dotcom %} uses OpenID Connect (OIDC), and its architecture and benefits, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)." +* To learn the basic concepts of how {% data variables.product.prodname_dotcom %} uses OpenID Connect (OIDC), and its architecture and benefits, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect). diff --git a/data/reusables/actions/oidc-on-ghecom.md b/data/reusables/actions/oidc-on-ghecom.md index fdada2d3c5eb..5a6a175a8526 100644 --- a/data/reusables/actions/oidc-on-ghecom.md +++ b/data/reusables/actions/oidc-on-ghecom.md @@ -1,3 +1,3 @@ {%- ifversion ghec %} -* If you're following this guide on {% data variables.enterprise.data_residency_site %}, understand that you must substitute certain values in the following documentation. See "[AUTOTITLE](/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#following-these-guides-on-ghecom)." +* If you're following this guide on {% data variables.enterprise.data_residency_site %}, understand that you must substitute certain values in the following documentation. See [AUTOTITLE](/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#following-these-guides-on-ghecom). {%- endif %} diff --git a/data/reusables/actions/oidc-permissions-token.md b/data/reusables/actions/oidc-permissions-token.md index 35f6bc51a846..e8b2eac810e2 100644 --- a/data/reusables/actions/oidc-permissions-token.md +++ b/data/reusables/actions/oidc-permissions-token.md @@ -1,4 +1,4 @@ -The job or workflow run requires a `permissions` setting with [`id-token: write`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) to allow {% data variables.product.prodname_dotcom %}'s OIDC provider to create a JSON Web Token for every run. You won't be able to request the OIDC JWT ID token if the `permissions` for `id-token` is not set to `write`, however this value doesn't imply granting write access to any resources, only being able to fetch and set the OIDC token for an action or step to enable authenticating with a short-lived access token. Any actual trust setting is defined using OIDC claims, for more information see "[AUTOTITLE](/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud)." +The job or workflow run requires a `permissions` setting with [`id-token: write`](/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token) to allow {% data variables.product.prodname_dotcom %}'s OIDC provider to create a JSON Web Token for every run. You won't be able to request the OIDC JWT ID token if the `permissions` for `id-token` is not set to `write`, however this value doesn't imply granting write access to any resources, only being able to fetch and set the OIDC token for an action or step to enable authenticating with a short-lived access token. Any actual trust setting is defined using OIDC claims, for more information see [AUTOTITLE](/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud). The `id-token: write` setting allows the JWT to be requested from {% data variables.product.prodname_dotcom %}'s OIDC provider using one of these approaches: @@ -27,5 +27,5 @@ For reusable workflows that are owned by the same user, organization, or enterpr For reusable workflows outside your enterprise or organization, the `permissions` setting for `id-token` should be explicitly set to `write` at the caller workflow level or in the specific job that calls the reusable workflow. This ensures that the OIDC token generated in the reusable workflow is only allowed to be consumed in the caller workflows when intended. -For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)." +For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows). {% endif %} diff --git a/data/reusables/actions/oidc-security-notice.md b/data/reusables/actions/oidc-security-notice.md index 0988ba5df18b..0c591bb12f88 100644 --- a/data/reusables/actions/oidc-security-notice.md +++ b/data/reusables/actions/oidc-security-notice.md @@ -1 +1 @@ -* Before proceeding, you must plan your security strategy to ensure that access tokens are only allocated in a predictable way. To control how your cloud provider issues access tokens, you **must** define at least one condition, so that untrusted repositories can’t request access tokens for your cloud resources. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud)." +* Before proceeding, you must plan your security strategy to ensure that access tokens are only allocated in a predictable way. To control how your cloud provider issues access tokens, you **must** define at least one condition, so that untrusted repositories can’t request access tokens for your cloud resources. For more information, see [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud). diff --git a/data/reusables/actions/onboarding-next-steps.md b/data/reusables/actions/onboarding-next-steps.md index 73a11ebe04e1..b360e8842329 100644 --- a/data/reusables/actions/onboarding-next-steps.md +++ b/data/reusables/actions/onboarding-next-steps.md @@ -1,9 +1,9 @@ {% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_actions %}: -* To create a {% data variables.product.prodname_actions %} workflow, see "[AUTOTITLE](/actions/learn-github-actions/using-starter-workflows)." -* For continuous integration (CI) workflows, see "[AUTOTITLE](/actions/automating-builds-and-tests)." -* For building and publishing packages, see "[AUTOTITLE](/actions/publishing-packages)." -* For deploying projects, see "[AUTOTITLE](/actions/deployment)." -* For automating tasks and processes on {% data variables.product.prodname_dotcom %}, see "[AUTOTITLE](/actions/managing-issues-and-pull-requests)." -* For examples that demonstrate more complex features of {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/examples)." These detailed examples explain how to test your code on a runner, access the {% data variables.product.prodname_dotcom %} CLI, and use advanced features such as concurrency and test matrices.{% ifversion github-certification %} -* To certify your proficiency in automating workflows and accelerating development with {% data variables.product.prodname_actions %}, earn a {% data variables.product.prodname_actions %} certificate with {% data variables.product.prodname_certifications %}. For more information, see "[AUTOTITLE](/get-started/showcase-your-expertise-with-github-certifications/about-github-certifications)."{% endif %} +* To create a {% data variables.product.prodname_actions %} workflow, see [AUTOTITLE](/actions/learn-github-actions/using-starter-workflows). +* For continuous integration (CI) workflows, see [AUTOTITLE](/actions/automating-builds-and-tests). +* For building and publishing packages, see [AUTOTITLE](/actions/publishing-packages). +* For deploying projects, see [AUTOTITLE](/actions/deployment). +* For automating tasks and processes on {% data variables.product.prodname_dotcom %}, see [AUTOTITLE](/actions/managing-issues-and-pull-requests). +* For examples that demonstrate more complex features of {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions/examples). These detailed examples explain how to test your code on a runner, access the {% data variables.product.prodname_dotcom %} CLI, and use advanced features such as concurrency and test matrices.{% ifversion github-certification %} +* To certify your proficiency in automating workflows and accelerating development with {% data variables.product.prodname_actions %}, earn a {% data variables.product.prodname_actions %} certificate with {% data variables.product.prodname_certifications %}. For more information, see [AUTOTITLE](/get-started/showcase-your-expertise-with-github-certifications/about-github-certifications).{% endif %} diff --git a/data/reusables/actions/org-access-to-github-hosted-runners.md b/data/reusables/actions/org-access-to-github-hosted-runners.md index e015821eed24..a0faf838a7cc 100644 --- a/data/reusables/actions/org-access-to-github-hosted-runners.md +++ b/data/reusables/actions/org-access-to-github-hosted-runners.md @@ -1 +1 @@ -1. To allow organizations to access your {% data variables.actions.hosted_runner %}, specify which organizations can use the runner group the runner is assigned to. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners#changing-which-organizations-can-access-a-runner-group)." +1. To allow organizations to access your {% data variables.actions.hosted_runner %}, specify which organizations can use the runner group the runner is assigned to. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/controlling-access-to-larger-runners#changing-which-organizations-can-access-a-runner-group). diff --git a/data/reusables/actions/org-to-enterprise-actions-permissions.md b/data/reusables/actions/org-to-enterprise-actions-permissions.md index 8b5d08ffb11f..93a7fbbc0514 100644 --- a/data/reusables/actions/org-to-enterprise-actions-permissions.md +++ b/data/reusables/actions/org-to-enterprise-actions-permissions.md @@ -1 +1 @@ -If the organization has write permissions for {% data variables.product.prodname_actions %}, you must manually set write permissions for the enterprise. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository)." For more information about managing organization-level permissions for {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization)." +If the organization has write permissions for {% data variables.product.prodname_actions %}, you must manually set write permissions for the enterprise. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository). For more information about managing organization-level permissions for {% data variables.product.prodname_actions %}, see [AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization). diff --git a/data/reusables/actions/partial-reruns-with-reusable.md b/data/reusables/actions/partial-reruns-with-reusable.md index 15e3342db8c9..1fba9efa3f0d 100644 --- a/data/reusables/actions/partial-reruns-with-reusable.md +++ b/data/reusables/actions/partial-reruns-with-reusable.md @@ -1,6 +1,6 @@ -Reusable workflows from public repositories can be referenced using a SHA, a release tag, or a branch name. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow)." +Reusable workflows from public repositories can be referenced using a SHA, a release tag, or a branch name. For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows#calling-a-reusable-workflow). When you re-run a workflow that uses a reusable workflow and the reference is not a SHA, there are some behaviors to be aware of: -* Re-running all jobs in a workflow will use the reusable workflow from the specified reference. For more information about re-running all jobs in a workflow, see "[AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow)." -* Re-running failed jobs or a specific job in a workflow will use the reusable workflow from the same commit SHA of the first attempt. For more information about re-running failed jobs in a workflow, see "[AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-failed-jobs-in-a-workflow)." For more information about re-running a specific job in a workflow, see "[AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-a-specific-job-in-a-workflow)." +* Re-running all jobs in a workflow will use the reusable workflow from the specified reference. For more information about re-running all jobs in a workflow, see [AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-all-the-jobs-in-a-workflow). +* Re-running failed jobs or a specific job in a workflow will use the reusable workflow from the same commit SHA of the first attempt. For more information about re-running failed jobs in a workflow, see [AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-failed-jobs-in-a-workflow). For more information about re-running a specific job in a workflow, see [AUTOTITLE](/actions/managing-workflow-runs/re-running-workflows-and-jobs#re-running-a-specific-job-in-a-workflow). diff --git a/data/reusables/actions/permissions-statement-secrets-and-variables-organization.md b/data/reusables/actions/permissions-statement-secrets-and-variables-organization.md index 92c2c50131ec..930527c4ba55 100644 --- a/data/reusables/actions/permissions-statement-secrets-and-variables-organization.md +++ b/data/reusables/actions/permissions-statement-secrets-and-variables-organization.md @@ -1,3 +1,3 @@ Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization Actions variables" or "Manage organization Actions secrets" permissions{% endif %} can create secrets or variables at the organization level.{% ifversion custom-org-roles %} -For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."{% endif %} +For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).{% endif %} diff --git a/data/reusables/actions/permissions-statement-secrets-environment.md b/data/reusables/actions/permissions-statement-secrets-environment.md index 2454550cbfa6..720019e740cb 100644 --- a/data/reusables/actions/permissions-statement-secrets-environment.md +++ b/data/reusables/actions/permissions-statement-secrets-environment.md @@ -1 +1 @@ -To create secrets or variables for an environment in a personal account repository, you must be the repository owner. To create secrets or variables for an environment in an organization repository, you must have `admin` access. For more information on environments, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment)." +To create secrets or variables for an environment in a personal account repository, you must be the repository owner. To create secrets or variables for an environment in an organization repository, you must have `admin` access. For more information on environments, see [AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment). diff --git a/data/reusables/actions/postgres-environment-variables.md b/data/reusables/actions/postgres-environment-variables.md index 2e1f481b5860..ed7fe1b4ff31 100644 --- a/data/reusables/actions/postgres-environment-variables.md +++ b/data/reusables/actions/postgres-environment-variables.md @@ -1 +1 @@ -The _client.js_ script looks for the `POSTGRES_HOST` and `POSTGRES_PORT` environment variables to create the client. The workflow sets those two environment variables as part of the "Connect to PostgreSQL" step to make them available to the _client.js_ script. For more information about the script, see "[Testing the PostgreSQL service container](#testing-the-postgresql-service-container)." +The _client.js_ script looks for the `POSTGRES_HOST` and `POSTGRES_PORT` environment variables to create the client. The workflow sets those two environment variables as part of the "Connect to PostgreSQL" step to make them available to the _client.js_ script. For more information about the script, see [Testing the PostgreSQL service container](#testing-the-postgresql-service-container). diff --git a/data/reusables/actions/pull-request-target-permissions-warning.md b/data/reusables/actions/pull-request-target-permissions-warning.md index 6fd6aaa8d7a2..019b53f520eb 100644 --- a/data/reusables/actions/pull-request-target-permissions-warning.md +++ b/data/reusables/actions/pull-request-target-permissions-warning.md @@ -1,2 +1,2 @@ > [!WARNING] -> For workflows that are triggered by the `pull_request_target` event, the `GITHUB_TOKEN` is granted read/write repository permission unless the `permissions` key is specified and the workflow can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the GitHub Security Lab website. +> For workflows that are triggered by the `pull_request_target` event, the `GITHUB_TOKEN` is granted read/write repository permission unless the `permissions` key is specified and the workflow can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see [Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests) on the GitHub Security Lab website. diff --git a/data/reusables/actions/redis-environment-variables.md b/data/reusables/actions/redis-environment-variables.md index 5b6d26ba54fd..fd3c8b6c5e5e 100644 --- a/data/reusables/actions/redis-environment-variables.md +++ b/data/reusables/actions/redis-environment-variables.md @@ -1 +1 @@ -The _client.js_ script looks for the `REDIS_HOST` and `REDIS_PORT` environment variables to create the client. The workflow sets those two environment variables as part of the "Connect to Redis" step to make them available to the _client.js_ script. For more information about the script, see "[Testing the Redis service container](#testing-the-redis-service-container)." +The _client.js_ script looks for the `REDIS_HOST` and `REDIS_PORT` environment variables to create the client. The workflow sets those two environment variables as part of the "Connect to Redis" step to make them available to the _client.js_ script. For more information about the script, see [Testing the Redis service container](#testing-the-redis-service-container). diff --git a/data/reusables/actions/reusable-keyword.md b/data/reusables/actions/reusable-keyword.md index a91ec70ae60c..c60145126799 100644 --- a/data/reusables/actions/reusable-keyword.md +++ b/data/reusables/actions/reusable-keyword.md @@ -1 +1 @@ -This keyword can reference several contexts. For more information, see "[Contexts](/actions/learn-github-actions/contexts#context-availability)." +This keyword can reference several contexts. For more information, see [Contexts](/actions/learn-github-actions/contexts#context-availability). diff --git a/data/reusables/actions/reusable-workflow-calling-syntax.md b/data/reusables/actions/reusable-workflow-calling-syntax.md index ddda9da4e2f7..44d887b3313c 100644 --- a/data/reusables/actions/reusable-workflow-calling-syntax.md +++ b/data/reusables/actions/reusable-workflow-calling-syntax.md @@ -1,6 +1,6 @@ * `{owner}/{repo}/.github/workflows/{filename}@{ref}` for reusable workflows in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, internal and private{% else %}public and internal{% endif %} repositories. * `./.github/workflows/{filename}` for reusable workflows in the same repository. -In the first option, `{ref}` can be a SHA, a release tag, or a branch name. If a release tag and a branch have the same name, the release tag takes precedence over the branch name. Using the commit SHA is the safest option for stability and security. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows)." +In the first option, `{ref}` can be a SHA, a release tag, or a branch name. If a release tag and a branch have the same name, the release tag takes precedence over the branch name. Using the commit SHA is the safest option for stability and security. For more information, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#reusing-third-party-workflows). If you use the second syntax option (without `{owner}/{repo}` and `@{ref}`) the called workflow is from the same commit as the caller workflow. Ref prefixes such as `refs/heads` and `refs/tags` are not allowed. You cannot use contexts or expressions in this keyword. diff --git a/data/reusables/actions/reusable-workflows.md b/data/reusables/actions/reusable-workflows.md index 05d929131532..e0260bfea1c2 100644 --- a/data/reusables/actions/reusable-workflows.md +++ b/data/reusables/actions/reusable-workflows.md @@ -1 +1 @@ -{% ifversion ghes or ghec %}You can share workflows with your organization, publicly or privately, by calling{% else %} You can call{% endif %} one workflow from within another workflow. This allows you to reuse workflows, avoiding duplication and making your workflows easier to maintain. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)." +{% ifversion ghes or ghec %}You can share workflows with your organization, publicly or privately, by calling{% else %} You can call{% endif %} one workflow from within another workflow. This allows you to reuse workflows, avoiding duplication and making your workflows easier to maintain. For more information, see [AUTOTITLE](/actions/using-workflows/reusing-workflows). diff --git a/data/reusables/actions/run-jobs-larger-runners.md b/data/reusables/actions/run-jobs-larger-runners.md index 4e3c29fd90b0..8da9ee884809 100644 --- a/data/reusables/actions/run-jobs-larger-runners.md +++ b/data/reusables/actions/run-jobs-larger-runners.md @@ -3,4 +3,4 @@ Once your runner type has been defined, you can update your workflow YAML files > [!NOTE] > {% data variables.actions.hosted_runner_caps %}s are automatically assigned a default label that corresponds to the runner name. You cannot add custom labels to {% data variables.actions.hosted_runner %}s, but you can use the default labels or the runner's group to send jobs to specific types of runners. -Only owner or administrator accounts can see the runner settings. Non-administrative users can contact the organization owner to find out which runners are enabled. Your organization owner can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-a-runner-group)." +Only owner or administrator accounts can see the runner settings. Non-administrative users can contact the organization owner to find out which runners are enabled. Your organization owner can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-a-runner-group). diff --git a/data/reusables/actions/runner-labels.md b/data/reusables/actions/runner-labels.md index 85e52dcf7f55..9c2abe473623 100644 --- a/data/reusables/actions/runner-labels.md +++ b/data/reusables/actions/runner-labels.md @@ -1 +1 @@ -Anyone with write access to an Actions-enabled repository can find out the labels for the runners that are available in that repository. See "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/running-jobs-on-larger-runners#viewing-available-runners-for-a-repository)." +Anyone with write access to an Actions-enabled repository can find out the labels for the runners that are available in that repository. See [AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/running-jobs-on-larger-runners#viewing-available-runners-for-a-repository). diff --git a/data/reusables/actions/runner-tool-cache-description.md b/data/reusables/actions/runner-tool-cache-description.md index f9334c510866..b63c9cd7a5ef 100644 --- a/data/reusables/actions/runner-tool-cache-description.md +++ b/data/reusables/actions/runner-tool-cache-description.md @@ -1 +1 @@ -The path to the directory containing preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software)". +The path to the directory containing preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-software). diff --git a/data/reusables/actions/secrets-and-variables-org-permissions.md b/data/reusables/actions/secrets-and-variables-org-permissions.md index f529580cd1a1..9e5731c29bc0 100644 --- a/data/reusables/actions/secrets-and-variables-org-permissions.md +++ b/data/reusables/actions/secrets-and-variables-org-permissions.md @@ -1,6 +1,6 @@ {% ifversion custom-org-roles %} > [!NOTE] -> The "Actions secrets and variables" page may not show distinct tabs for secrets and variables depending on your permissions. Organization owners and users with both the "Manage organization Actions variables" and "Manage organization Actions secrets" permissions will see the **Variables** and **Secrets** tabs. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." +> The "Actions secrets and variables" page may not show distinct tabs for secrets and variables depending on your permissions. Organization owners and users with both the "Manage organization Actions variables" and "Manage organization Actions secrets" permissions will see the **Variables** and **Secrets** tabs. For more information, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles). {% endif %} diff --git a/data/reusables/actions/self-hosted-runner-configure.md b/data/reusables/actions/self-hosted-runner-configure.md index 991e416c7406..d85e538e8189 100644 --- a/data/reusables/actions/self-hosted-runner-configure.md +++ b/data/reusables/actions/self-hosted-runner-configure.md @@ -12,5 +12,5 @@ The instructions walk you through completing these tasks: * Downloading and extracting the self-hosted runner application. * Running the `config` script to configure the self-hosted runner application and register it with {% data variables.product.prodname_actions %}. The `config` script requires the destination URL and an automatically-generated time-limited token to authenticate the request. The token expires after one hour. - * On Windows, the `config` script also asks if you would like to install the self-hosted runner application as a service. For Linux and macOS, you can install a service after you finish adding the runner. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/configuring-the-self-hosted-runner-application-as-a-service)." + * On Windows, the `config` script also asks if you would like to install the self-hosted runner application as a service. For Linux and macOS, you can install a service after you finish adding the runner. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/configuring-the-self-hosted-runner-application-as-a-service). * Running the self-hosted runner application to connect the machine to {% data variables.product.prodname_actions %}. diff --git a/data/reusables/actions/self-hosted-runner-networking-to-dotcom.md b/data/reusables/actions/self-hosted-runner-networking-to-dotcom.md index 118e94189451..80249f862627 100644 --- a/data/reusables/actions/self-hosted-runner-networking-to-dotcom.md +++ b/data/reusables/actions/self-hosted-runner-networking-to-dotcom.md @@ -1 +1 @@ -To use actions from {% data variables.product.prodname_dotcom_the_website %},{% ifversion ghes %} both {% data variables.product.prodname_ghe_server %} and{% endif %} your self-hosted runners must be able to make outbound connections to {% data variables.product.prodname_dotcom_the_website %}. No inbound connections from {% data variables.product.prodname_dotcom_the_website %} are required. For more information. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-betweens-self-hosted-runners-and-githubcom)." +To use actions from {% data variables.product.prodname_dotcom_the_website %},{% ifversion ghes %} both {% data variables.product.prodname_ghe_server %} and{% endif %} your self-hosted runners must be able to make outbound connections to {% data variables.product.prodname_dotcom_the_website %}. No inbound connections from {% data variables.product.prodname_dotcom_the_website %} are required. For more information. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-betweens-self-hosted-runners-and-githubcom). diff --git a/data/reusables/actions/self-hosted-runner-ports-protocols.md b/data/reusables/actions/self-hosted-runner-ports-protocols.md index cd7b596bce0a..cf0ca083fb00 100644 --- a/data/reusables/actions/self-hosted-runner-ports-protocols.md +++ b/data/reusables/actions/self-hosted-runner-ports-protocols.md @@ -1 +1 @@ -The connection between self-hosted runners and {% data variables.product.product_name %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/admin/configuration/hardening-security-for-your-enterprise/configuring-tls)."{% endif %} +The connection between self-hosted runners and {% data variables.product.product_name %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/admin/configuration/hardening-security-for-your-enterprise/configuring-tls).{% endif %} diff --git a/data/reusables/actions/self-hosted-runner-public-repo-access.md b/data/reusables/actions/self-hosted-runner-public-repo-access.md index 11ba5f36e9e9..86af4df0e63d 100644 --- a/data/reusables/actions/self-hosted-runner-public-repo-access.md +++ b/data/reusables/actions/self-hosted-runner-public-repo-access.md @@ -1,2 +1,2 @@ > [!NOTE] -> For security reasons, public repositories can't use runners in a runner group by default, but you can override this in the runner group's settings. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)." +> For security reasons, public repositories can't use runners in a runner group by default, but you can override this in the runner group's settings. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group). diff --git a/data/reusables/actions/self-hosted-runner-reqs-docker.md b/data/reusables/actions/self-hosted-runner-reqs-docker.md index 4f7cb3106e28..d8c8a0a90696 100644 --- a/data/reusables/actions/self-hosted-runner-reqs-docker.md +++ b/data/reusables/actions/self-hosted-runner-reqs-docker.md @@ -1 +1 @@ -Self-hosted runners must use a Linux operating system and have Docker installed to run Docker container actions. For more information about the requirements of self-hosted runners, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#requirements-for-self-hosted-runner-machines)." +Self-hosted runners must use a Linux operating system and have Docker installed to run Docker container actions. For more information about the requirements of self-hosted runners, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#requirements-for-self-hosted-runner-machines). diff --git a/data/reusables/actions/self-hosted-runner-security-admonition.md b/data/reusables/actions/self-hosted-runner-security-admonition.md index 777e46d3e06f..d5e9f7eaa109 100644 --- a/data/reusables/actions/self-hosted-runner-security-admonition.md +++ b/data/reusables/actions/self-hosted-runner-security-admonition.md @@ -1,4 +1,4 @@ > [!WARNING] > {% data reusables.actions.self-hosted-runner-security %} > -> For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." +> For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories). diff --git a/data/reusables/actions/self-hosted-runners-prerequisites.md b/data/reusables/actions/self-hosted-runners-prerequisites.md index 300620e727a7..e9d74bcecfb4 100644 --- a/data/reusables/actions/self-hosted-runners-prerequisites.md +++ b/data/reusables/actions/self-hosted-runners-prerequisites.md @@ -1,5 +1,5 @@ {%- ifversion ghes %} -* {% data variables.product.prodname_actions %} must be enabled for {% data variables.product.product_name %}. A site administrator can enable and configure {% data variables.product.prodname_actions %} for your instance. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server)." +* {% data variables.product.prodname_actions %} must be enabled for {% data variables.product.product_name %}. A site administrator can enable and configure {% data variables.product.prodname_actions %} for your instance. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server). {%- endif %} * You must have access to the machine you will use as a self-hosted runner in your environment. diff --git a/data/reusables/actions/service-container-prereqs.md b/data/reusables/actions/service-container-prereqs.md index d79761db860e..244a3e6a0452 100644 --- a/data/reusables/actions/service-container-prereqs.md +++ b/data/reusables/actions/service-container-prereqs.md @@ -1 +1 @@ -You should be familiar with how service containers work with {% data variables.product.prodname_actions %} and the networking differences between running jobs directly on the runner or in a container. For more information, see "[AUTOTITLE](/actions/using-containerized-services/about-service-containers)." +You should be familiar with how service containers work with {% data variables.product.prodname_actions %} and the networking differences between running jobs directly on the runner or in a container. For more information, see [AUTOTITLE](/actions/using-containerized-services/about-service-containers). diff --git a/data/reusables/actions/settings-ui/settings-actions-pages-custom-workflow.md b/data/reusables/actions/settings-ui/settings-actions-pages-custom-workflow.md index 84dec7bb6e8b..3e39e360fded 100644 --- a/data/reusables/actions/settings-ui/settings-actions-pages-custom-workflow.md +++ b/data/reusables/actions/settings-ui/settings-actions-pages-custom-workflow.md @@ -1 +1 @@ -{% ifversion ghes %}To use {% data variables.product.prodname_actions %} as a publishing source for {% data variables.product.prodname_pages %}, a site administrator must enable {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}. For more information, see "[AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server)."{% endif %} +{% ifversion ghes %}To use {% data variables.product.prodname_actions %} as a publishing source for {% data variables.product.prodname_pages %}, a site administrator must enable {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/admin/github-actions/enabling-github-actions-for-github-enterprise-server).{% endif %} diff --git a/data/reusables/actions/supported-github-runners.md b/data/reusables/actions/supported-github-runners.md index ed162ef2aa6f..0cf6d12a0c77 100644 --- a/data/reusables/actions/supported-github-runners.md +++ b/data/reusables/actions/supported-github-runners.md @@ -63,7 +63,7 @@ For public repositories, jobs using the workflow labels shown in the table below ### Standard {% data variables.product.prodname_dotcom %}-hosted runners for {% ifversion ghec %}internal and{% endif %} private repositories -For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using the workflow labels shown in the table below will run on virtual machines with the associated specifications. These runners use your {% data variables.product.prodname_dotcom %} account's allotment of free minutes, and are then charged at the per minute rates. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)." +For {% ifversion ghec %}internal and{% endif %} private repositories, jobs using the workflow labels shown in the table below will run on virtual machines with the associated specifications. These runners use your {% data variables.product.prodname_dotcom %} account's allotment of free minutes, and are then charged at the per minute rates. For more information, see [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates). diff --git a/data/reusables/actions/third-party-actions.md b/data/reusables/actions/third-party-actions.md index 8334791cf626..607d37b529b4 100644 --- a/data/reusables/actions/third-party-actions.md +++ b/data/reusables/actions/third-party-actions.md @@ -1,3 +1,3 @@ > [!NOTE] > * This workflow template contains an action that is not certified by {% data variables.product.prodname_dotcom %}. Actions provided by third parties are governed by separate terms of service, privacy policy, and support documentation. -> * If you use actions from third parties you should use a version specified by a commit SHA. If the action is revised and you want to use the newer version, you will need to update the SHA. You can specify a version by referencing a tag or a branch, however the action may change without warning. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)." +> * If you use actions from third parties you should use a version specified by a commit SHA. If the action is revised and you want to use the newer version, you will need to update the SHA. You can specify a version by referencing a tag or a branch, however the action may change without warning. For more information, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions). diff --git a/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md b/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md index 6e47ddaf209c..eb183f330281 100644 --- a/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md +++ b/data/reusables/actions/upgrade-runners-before-upgrade-ghes.md @@ -1 +1 @@ -If you use ephemeral runners and have disabled automatic updates, before you upgrade {% data variables.product.prodname_ghe_server %}, you should first upgrade your self-hosted runners to the version of the runner application that your upgraded instance will run. Upgrading {% data variables.product.prodname_ghe_server %} before you upgrade ephemeral runners may result in your runners going offline. For more information, see "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process)." +If you use ephemeral runners and have disabled automatic updates, before you upgrade {% data variables.product.prodname_ghe_server %}, you should first upgrade your self-hosted runners to the version of the runner application that your upgraded instance will run. Upgrading {% data variables.product.prodname_ghe_server %} before you upgrade ephemeral runners may result in your runners going offline. For more information, see [AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process). diff --git a/data/reusables/actions/use-request-body-api.md b/data/reusables/actions/use-request-body-api.md index 1eddd91765d6..65fd3fdd47e8 100644 --- a/data/reusables/actions/use-request-body-api.md +++ b/data/reusables/actions/use-request-body-api.md @@ -1 +1 @@ -To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see "[AUTOTITLE](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization)," and for repositories, see "[AUTOTITLE](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository)." +To apply this configuration, submit a request to the API endpoint and include the required configuration in the request body. For organizations, see [AUTOTITLE](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-an-organization), and for repositories, see [AUTOTITLE](/rest/actions/oidc#set-the-customization-template-for-an-oidc-subject-claim-for-a-repository). diff --git a/data/reusables/actions/viewing-actions-metrics.md b/data/reusables/actions/viewing-actions-metrics.md index a54bf32f5018..765dea68c5a3 100644 --- a/data/reusables/actions/viewing-actions-metrics.md +++ b/data/reusables/actions/viewing-actions-metrics.md @@ -1,6 +1,6 @@ 1. In the "Insights" navigation menu, click **Actions Usage Metrics** or click **Actions Performance Metrics**. -1. Optionally, to select a time period to view usage metrics for, choose an option from the **Period** drop down menu at the top right of the page. For more information, see "[Understanding {% data variables.product.prodname_actions %} metrics aggregation](#understanding-github-actions-metrics-aggregation)." -1. Click on the tab that contains the metrics you would like to view. For more information, see "[About {% data variables.product.prodname_actions %} usage metrics](#about-github-actions-usage-metrics) or "[About {% data variables.product.prodname_actions %} performance metrics](#about-github-actions-performance-metrics)." +1. Optionally, to select a time period to view usage metrics for, choose an option from the **Period** drop down menu at the top right of the page. For more information, see [Understanding {% data variables.product.prodname_actions %} metrics aggregation](#understanding-github-actions-metrics-aggregation). +1. Click on the tab that contains the metrics you would like to view. For more information, see "[About {% data variables.product.prodname_actions %} usage metrics](#about-github-actions-usage-metrics) or [About {% data variables.product.prodname_actions %} performance metrics](#about-github-actions-performance-metrics). 1. Optionally, to filter the data displayed in a tab, create a filter. 1. Click on the **{% octicon "filter" aria-hidden="true" %} Filter** button. 1. Click **{% octicon "plus" aria-hidden="true" %} Add a filter**. diff --git a/data/reusables/actions/workflow-basic-example-and-explanation.md b/data/reusables/actions/workflow-basic-example-and-explanation.md index bd18afd193fb..5b13d6d031c5 100644 --- a/data/reusables/actions/workflow-basic-example-and-explanation.md +++ b/data/reusables/actions/workflow-basic-example-and-explanation.md @@ -25,7 +25,7 @@ You can create an example workflow in your repository that automatically trigger 1. Commit these changes and push them to your {% data variables.product.prodname_dotcom %} repository. -Your new {% data variables.product.prodname_actions %} workflow file is now installed in your repository and will run automatically each time someone pushes a change to the repository. To see the details about a workflow's execution history, see "[Viewing the activity for a workflow run](#viewing-the-activity-for-a-workflow-run)." +Your new {% data variables.product.prodname_actions %} workflow file is now installed in your repository and will run automatically each time someone pushes a change to the repository. To see the details about a workflow's execution history, see [Viewing the activity for a workflow run](#viewing-the-activity-for-a-workflow-run). ## Understanding the workflow file @@ -70,7 +70,7 @@ jobs: ### Visualizing the workflow file -In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see "[AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions)." +In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell script. Steps 1 and 2 run actions, while steps 3 and 4 run shell scripts. To find more prebuilt actions for your workflows, see [AUTOTITLE](/actions/learn-github-actions/finding-and-customizing-actions). ![Diagram showing the trigger, runner, and job of a workflow. The job is broken into 4 steps.](/assets/images/help/actions/overview-actions-event.png) diff --git a/data/reusables/actions/workflow-permissions-intro.md b/data/reusables/actions/workflow-permissions-intro.md index d4ab67e7adc5..5ded31dd0706 100644 --- a/data/reusables/actions/workflow-permissions-intro.md +++ b/data/reusables/actions/workflow-permissions-intro.md @@ -1 +1 @@ -You can set the default permissions granted to the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication)." You can choose a restricted set of permissions as the default, or apply permissive settings. +You can set the default permissions granted to the `GITHUB_TOKEN`. For more information about the `GITHUB_TOKEN`, see [AUTOTITLE](/actions/security-guides/automatic-token-authentication). You can choose a restricted set of permissions as the default, or apply permissive settings. diff --git a/data/reusables/actions/workflow-run-approve-link.md b/data/reusables/actions/workflow-run-approve-link.md index 6693d7ee174f..5682f2e1c5c6 100644 --- a/data/reusables/actions/workflow-run-approve-link.md +++ b/data/reusables/actions/workflow-run-approve-link.md @@ -1 +1 @@ -For more information about approving workflow runs that this policy applies to, see "[AUTOTITLE](/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." +For more information about approving workflow runs that this policy applies to, see [AUTOTITLE](/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks). diff --git a/data/reusables/actions/workflow-run-approve-public-fork.md b/data/reusables/actions/workflow-run-approve-public-fork.md index cbf9a90fef85..e18d1c990a16 100644 --- a/data/reusables/actions/workflow-run-approve-public-fork.md +++ b/data/reusables/actions/workflow-run-approve-public-fork.md @@ -7,6 +7,6 @@ To help prevent this, workflows on pull requests to public repositories from som By default, all first-time contributors require approval to run workflows. -Workflows triggered by `pull_request_target` events are run in the context of the base branch. Since the base branch is considered trusted, workflows triggered by these events will always run, regardless of approval settings. For more information about the `pull_request_target` event, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request_target)." +Workflows triggered by `pull_request_target` events are run in the context of the base branch. Since the base branch is considered trusted, workflows triggered by these events will always run, regardless of approval settings. For more information about the `pull_request_target` event, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request_target). ->[!WARNING] These workflow approval policies are intended to restrict the set of users that can execute workflows in {% data variables.product.prodname_actions %} runners that could lead to unexpected resource and compute consumption when using {% data variables.product.prodname_dotcom %}-hosted runners. If you are using self-hosted runners, potentially malicious user-controlled workflow code will execute automatically if the user is allowed to bypass approval in the set approval policy or if the pull request is approved. You must consider the risk of executing this code in your infrastructure and should review and follow the self-hosted runner security recommendations regardless of the approval settings utilized. See "[AUTOTITLE](/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)." +>[!WARNING] These workflow approval policies are intended to restrict the set of users that can execute workflows in {% data variables.product.prodname_actions %} runners that could lead to unexpected resource and compute consumption when using {% data variables.product.prodname_dotcom %}-hosted runners. If you are using self-hosted runners, potentially malicious user-controlled workflow code will execute automatically if the user is allowed to bypass approval in the set approval policy or if the pull request is approved. You must consider the risk of executing this code in your infrastructure and should review and follow the self-hosted runner security recommendations regardless of the approval settings utilized. See [AUTOTITLE](/actions/security-for-github-actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners). diff --git a/data/reusables/actions/workflow-runs-dependabot-note.md b/data/reusables/actions/workflow-runs-dependabot-note.md index 6f57cbd51987..1adde2b7df61 100644 --- a/data/reusables/actions/workflow-runs-dependabot-note.md +++ b/data/reusables/actions/workflow-runs-dependabot-note.md @@ -1 +1 @@ -Workflow runs triggered by {% data variables.product.prodname_dependabot %} pull requests run as if they are from a forked repository, and therefore use a read-only `GITHUB_TOKEN`. These workflow runs cannot access any secrets. For information about strategies to keep these workflows secure, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions)." +Workflow runs triggered by {% data variables.product.prodname_dependabot %} pull requests run as if they are from a forked repository, and therefore use a read-only `GITHUB_TOKEN`. These workflow runs cannot access any secrets. For information about strategies to keep these workflows secure, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions). diff --git a/data/reusables/actions/workflow-templates-categories.md b/data/reusables/actions/workflow-templates-categories.md index 488dc489e6c3..7a558345d300 100644 --- a/data/reusables/actions/workflow-templates-categories.md +++ b/data/reusables/actions/workflow-templates-categories.md @@ -1,5 +1,5 @@ {% data variables.product.prodname_dotcom %} provides ready-to-use workflow templates for the following high level categories: -* **Deployment (CD)**. For more information, see "[AUTOTITLE](/actions/deployment/about-deployments/about-continuous-deployment)." -{% ifversion fpt or ghec %}- **Security**. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-actions)."{% endif %} -* **Continuous Integration (CI)**. For more information, see "[AUTOTITLE](/actions/automating-builds-and-tests/about-continuous-integration)." +* **Deployment (CD)**. For more information, see [AUTOTITLE](/actions/deployment/about-deployments/about-continuous-deployment). +{% ifversion fpt or ghec %}- **Security**. For more information, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-code-scanning-using-third-party-actions).{% endif %} +* **Continuous Integration (CI)**. For more information, see [AUTOTITLE](/actions/automating-builds-and-tests/about-continuous-integration). * **Automation**. Automation workflow templates offer solutions for automating workflows, such as triaging pull requests and applying a label based on the paths that are modified in the pull request, or greeting users who are first time contributors to the repository. diff --git a/data/reusables/actions/workflow-templates-for-more-information.md b/data/reusables/actions/workflow-templates-for-more-information.md index adcfc6cb2a7a..73a952076334 100644 --- a/data/reusables/actions/workflow-templates-for-more-information.md +++ b/data/reusables/actions/workflow-templates-for-more-information.md @@ -1 +1 @@ -To get started with preconfigured workflows, browse through the list of templates in the [actions/starter-workflows](https://github.com/actions/starter-workflows) repository. For more information, see "[AUTOTITLE](/actions/writing-workflows/using-starter-workflows)." +To get started with preconfigured workflows, browse through the list of templates in the [actions/starter-workflows](https://github.com/actions/starter-workflows) repository. For more information, see [AUTOTITLE](/actions/writing-workflows/using-starter-workflows). diff --git a/data/reusables/actions/workflow-templates-repo-link.md b/data/reusables/actions/workflow-templates-repo-link.md index af9cd445217e..94490a2a0974 100644 --- a/data/reusables/actions/workflow-templates-repo-link.md +++ b/data/reusables/actions/workflow-templates-repo-link.md @@ -1 +1 @@ -Use these workflows as a starting place to build your custom workflow or use them as-is. You can browse the full list of workflow templates in the [actions/starter-workflows](https://github.com/actions/starter-workflows) repository. For more information, see "[AUTOTITLE](/actions/writing-workflows/using-starter-workflows)." +Use these workflows as a starting place to build your custom workflow or use them as-is. You can browse the full list of workflow templates in the [actions/starter-workflows](https://github.com/actions/starter-workflows) repository. For more information, see [AUTOTITLE](/actions/writing-workflows/using-starter-workflows). diff --git a/data/reusables/actions/workflows-from-public-fork-setting.md b/data/reusables/actions/workflows-from-public-fork-setting.md index c4fd50cbe560..23cbb867a379 100644 --- a/data/reusables/actions/workflows-from-public-fork-setting.md +++ b/data/reusables/actions/workflows-from-public-fork-setting.md @@ -1,4 +1,4 @@ -1. Under **Approval for running fork pull request workflows from contributors**, choose which subset of users will require approval before running workflows on their pull requests. Both the pull request author and the actor of the pull request event triggering the workflow will be checked to determine if approval is required. If approval is required, a user with write access to the repository must approve the pull request workflow to be run. See "[AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks)." +1. Under **Approval for running fork pull request workflows from contributors**, choose which subset of users will require approval before running workflows on their pull requests. Both the pull request author and the actor of the pull request event triggering the workflow will be checked to determine if approval is required. If approval is required, a user with write access to the repository must approve the pull request workflow to be run. See [AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/approving-workflow-runs-from-public-forks). >[!WARNING] When requiring approvals only for first-time contributors (the first two settings), a user that has had any commit or pull request merged into the repository will not require approval. A malicious user could meet this requirement by getting a simple typo or other innocuous change accepted by a maintainer, either as part of a pull request they have authored or as part of another user's pull request. diff --git a/data/reusables/actions/workflows/required-workflow-beta.md b/data/reusables/actions/workflows/required-workflow-beta.md index 46d1231aeed6..bd056b400862 100644 --- a/data/reusables/actions/workflows/required-workflow-beta.md +++ b/data/reusables/actions/workflows/required-workflow-beta.md @@ -1,6 +1,6 @@ > [!NOTE] > {% data variables.product.company_short %} no longer supports required workflows for {% data variables.product.prodname_actions %}. To require workflows to pass before merging, upgrade {% data variables.product.prodname_ghe_server %} to the latest version and use repository rulesets instead. > -> For more information about upgrading {% data variables.product.prodname_ghe_server %}, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)." +> For more information about upgrading {% data variables.product.prodname_ghe_server %}, see [AUTOTITLE](/admin/overview/about-upgrades-to-new-releases). > -> For more information about repository rulesets, see "[AUTOTITLE](/enterprise-server@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)." +> For more information about repository rulesets, see [AUTOTITLE](/enterprise-server@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging). diff --git a/data/reusables/actions/workflows/required-workflow-prerequisites.md b/data/reusables/actions/workflows/required-workflow-prerequisites.md index d61322cdd692..d35f1ba419c3 100644 --- a/data/reusables/actions/workflows/required-workflow-prerequisites.md +++ b/data/reusables/actions/workflows/required-workflow-prerequisites.md @@ -1,8 +1,8 @@ -* {% data variables.product.prodname_actions %} must be enabled for a repository in the organization's settings in order for required workflows to run. Once enabled at an organization-level, required workflows will run even when {% data variables.product.prodname_actions %} is disabled in the repository's settings. For more information on managing {% data variables.product.prodname_actions %} in your organization's repositories, see "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization)." -* Required workflows are available for organizations and only in repositories where the organization's plan supports required status checks. If required status checks are not supported, the workflow will still run, but it will not be a required check and will not block merging. For more information about support for required status checks, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)." -* The repository's default branch must match the organization's default branch setting in order for required workflows to run as required status checks. If the default branch names do not match, the workflow will still run, but it will not be a required check. For more information about managing default branch names, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization)" and "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch)." +* {% data variables.product.prodname_actions %} must be enabled for a repository in the organization's settings in order for required workflows to run. Once enabled at an organization-level, required workflows will run even when {% data variables.product.prodname_actions %} is disabled in the repository's settings. For more information on managing {% data variables.product.prodname_actions %} in your organization's repositories, see [AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#managing-github-actions-permissions-for-your-organization). +* Required workflows are available for organizations and only in repositories where the organization's plan supports required status checks. If required status checks are not supported, the workflow will still run, but it will not be a required check and will not block merging. For more information about support for required status checks, see [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches). +* The repository's default branch must match the organization's default branch setting in order for required workflows to run as required status checks. If the default branch names do not match, the workflow will still run, but it will not be a required check. For more information about managing default branch names, see [AUTOTITLE](/organizations/managing-organization-settings/managing-the-default-branch-name-for-repositories-in-your-organization) and [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/changing-the-default-branch). * For required workflows to run, the pull request's source repository must be in the same organization as the target repository. {% data variables.product.product_name %} will source the required workflow from {% ifversion actions-required-workflow-improvements %}a specified branch, tag, or commit SHA {% else %}the HEAD commit of the default branch {% endif %}from the repository containing the workflow. * Secrets used in a required workflow should be created at either the organization level or in the target repositories. * Secrets in the source repository will not be fetched when a workflow runs in the target repository. -{% ifversion actions-required-workflow-improvements %}* When a workflow is run as a required workflow it will ignore all the filters in the `on:` section, for example: `branches`, `branches-ignore`, `paths`, `types` etc. The required workflow will run only for the `pull_request` and `pull_request_target` default events. For more information on default activity types, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request)."{% endif %} +{% ifversion actions-required-workflow-improvements %}* When a workflow is run as a required workflow it will ignore all the filters in the `on:` section, for example: `branches`, `branches-ignore`, `paths`, `types` etc. The required workflow will run only for the `pull_request` and `pull_request_target` default events. For more information on default activity types, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#pull_request).{% endif %} * Required workflows are not automatically triggered on already existing pull requests even though they automatically appear as expected checks. To trigger required workflows for an already existing pull request, push a new change to that pull request. diff --git a/data/reusables/actions/workflows/required-workflow-source-notes.md b/data/reusables/actions/workflows/required-workflow-source-notes.md index 679cea203030..cf3ad2c3767a 100644 --- a/data/reusables/actions/workflows/required-workflow-source-notes.md +++ b/data/reusables/actions/workflows/required-workflow-source-notes.md @@ -1,7 +1,7 @@ * Required workflows can be stored in any repository folder and are not restricted to the `.github/workflows` folder like normal workflows. If a required workflow calls a reusable workflow, the reusable workflow must be stored in the `.github/workflows` folder. When calling a reusable workflow, a required workflow must use the full path and ref to the reusable workflow. For example, `{owner}/{repo}/.github/workflows/{filename}@{ref}`. -* If the required workflow is contained in a private {% ifversion ghes or ghec %}or internal {% endif %}repository, you must ensure that workflows within the repository are accessible by other repositories in your organization. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-access-for-a-private-repository){% ifversion ghes or ghec %}" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository){% endif %}." +* If the required workflow is contained in a private {% ifversion ghes or ghec %}or internal {% endif %}repository, you must ensure that workflows within the repository are accessible by other repositories in your organization. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-access-for-a-private-repository){% ifversion ghes or ghec %} and [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository){% endif %}. * Workflows stored in a public repository can be configured as required workflows for any repository in your organization. Workflows stored in a private repository can only be configured as required workflows for other private repositories in your organization. {% ifversion ghes or ghec %} Workflows stored in internal repositories can be configured as required workflows for internal and private repositories in your organization.{% endif %} -* {% data variables.product.prodname_codeql %} is not supported in required workflows because {% data variables.product.prodname_codeql %} requires configuration at the repository level. For information on configuring code scanning, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning)." +* {% data variables.product.prodname_codeql %} is not supported in required workflows because {% data variables.product.prodname_codeql %} requires configuration at the repository level. For information on configuring code scanning, see [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning). {% ifversion actions-required-workflow-improvements %} {% ifversion fpt or ghec %} * To push to a branch where required workflows are enforced at the organizational level, create a pull request to make the necessary changes. You cannot push directly to branches with required workflow enforcements. diff --git a/data/reusables/actions/workflows/run-on-specific-branches-or-tags1.md b/data/reusables/actions/workflows/run-on-specific-branches-or-tags1.md index f2b429913054..d08d59adf887 100644 --- a/data/reusables/actions/workflows/run-on-specific-branches-or-tags1.md +++ b/data/reusables/actions/workflows/run-on-specific-branches-or-tags1.md @@ -7,4 +7,4 @@ Use the `tags` filter when you want to include tag name patterns or when you wan If you define only `tags`/`tags-ignore` or only `branches`/`branches-ignore`, the workflow won't run for events affecting the undefined Git ref. If you define neither `tags`/`tags-ignore` or `branches`/`branches-ignore`, the workflow will run for events affecting either branches or tags. If you define both `branches`/`branches-ignore` and [`paths`/`paths-ignore`](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied. -The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." +The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). diff --git a/data/reusables/actions/workflows/section-specifying-branches.md b/data/reusables/actions/workflows/section-specifying-branches.md index f5f495e1874c..2107a3329f6e 100644 --- a/data/reusables/actions/workflows/section-specifying-branches.md +++ b/data/reusables/actions/workflows/section-specifying-branches.md @@ -1,7 +1,7 @@ When using the `workflow_run` event, you can specify what branches the triggering workflow must run on in order to trigger your workflow. -The `branches` and `branches-ignore` filters accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." +The `branches` and `branches-ignore` filters accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). For example, a workflow with the following trigger will only run when the workflow named `Build` runs on a branch whose name starts with `releases/`: diff --git a/data/reusables/actions/workflows/section-triggering-a-workflow-schedule.md b/data/reusables/actions/workflows/section-triggering-a-workflow-schedule.md index 1f16c55c2fa1..779461ef0390 100644 --- a/data/reusables/actions/workflows/section-triggering-a-workflow-schedule.md +++ b/data/reusables/actions/workflows/section-triggering-a-workflow-schedule.md @@ -1,3 +1,3 @@ You can use `on.schedule` to define a time schedule for your workflows. {% data reusables.repositories.actions-scheduled-workflow-example %} -For more information about cron syntax, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#scheduled-events)." +For more information about cron syntax, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#scheduled-events). diff --git a/data/reusables/actions/workflows/section-triggering-a-workflow-types.md b/data/reusables/actions/workflows/section-triggering-a-workflow-types.md index 05b719abc969..2b3e57fcd1d8 100644 --- a/data/reusables/actions/workflows/section-triggering-a-workflow-types.md +++ b/data/reusables/actions/workflows/section-triggering-a-workflow-types.md @@ -1,6 +1,6 @@ Use `on..types` to define the type of activity that will trigger a workflow run. Most GitHub events are triggered by more than one type of activity. For example, the `label` is triggered when a label is `created`, `edited`, or `deleted`. The `types` keyword enables you to narrow down activity that causes the workflow to run. When only one activity type triggers a webhook event, the `types` keyword is unnecessary. -You can use an array of event `types`. For more information about each event and their activity types, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#available-events)." +You can use an array of event `types`. For more information about each event and their activity types, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows#available-events). ```yaml on: diff --git a/data/reusables/actions/workflows/section-triggering-a-workflow.md b/data/reusables/actions/workflows/section-triggering-a-workflow.md index 386fbf4ffc18..6e9a613a8f1c 100644 --- a/data/reusables/actions/workflows/section-triggering-a-workflow.md +++ b/data/reusables/actions/workflows/section-triggering-a-workflow.md @@ -1,5 +1,5 @@ -To automatically trigger a workflow, use `on` to define which events can cause the workflow to run. For a list of available events, see "[AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows)." +To automatically trigger a workflow, use `on` to define which events can cause the workflow to run. For a list of available events, see [AUTOTITLE](/actions/using-workflows/events-that-trigger-workflows). You can define single or multiple events that can trigger a workflow, or set a time schedule. You can also restrict the execution of a workflow to only occur for specific files, tags, or branch changes. These options are described in the following sections. diff --git a/data/reusables/actions/workflows/triggering-a-workflow-paths1.md b/data/reusables/actions/workflows/triggering-a-workflow-paths1.md index 454eedbdc59f..6fc9ec1cca2a 100644 --- a/data/reusables/actions/workflows/triggering-a-workflow-paths1.md +++ b/data/reusables/actions/workflows/triggering-a-workflow-paths1.md @@ -10,4 +10,4 @@ Use the `paths` filter when you want to include file path patterns or when you w If you define both `branches`/`branches-ignore` and `paths`/`paths-ignore`, the workflow will only run when both filters are satisfied. -The `paths` and `paths-ignore` keywords accept glob patterns that use the `*` and `**` wildcard characters to match more than one path name. For more information, see the "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." +The `paths` and `paths-ignore` keywords accept glob patterns that use the `*` and `**` wildcard characters to match more than one path name. For more information, see the [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet). diff --git a/data/reusables/actions/workflows/triggering-a-workflow-paths5.md b/data/reusables/actions/workflows/triggering-a-workflow-paths5.md index 5cf3803708d7..4b8330a6faba 100644 --- a/data/reusables/actions/workflows/triggering-a-workflow-paths5.md +++ b/data/reusables/actions/workflows/triggering-a-workflow-paths5.md @@ -10,4 +10,4 @@ The filter determines if a workflow should run by evaluating the changed files a Diffs are limited to 300 files. If there are files changed that aren't matched in the first 300 files returned by the filter, the workflow will not run. You may need to create more specific filters so that the workflow will run automatically. -For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests)." +For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests). diff --git a/data/reusables/actions/workflows/triggering-workflow-branches1.md b/data/reusables/actions/workflows/triggering-workflow-branches1.md index d544dcbb0a24..83fabf7a068a 100644 --- a/data/reusables/actions/workflows/triggering-workflow-branches1.md +++ b/data/reusables/actions/workflows/triggering-workflow-branches1.md @@ -4,4 +4,4 @@ Use the `branches` filter when you want to include branch name patterns or when If you define both `branches`/`branches-ignore` and [`paths`/`paths-ignore`](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied. -The `branches` and `branches-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to escape each of these special characters with `\`. For more information about glob patterns, see the "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." +The `branches` and `branches-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to escape each of these special characters with `\`. For more information about glob patterns, see the [AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet).