diff --git a/data/reusables/accounts/marketing-emails.md b/data/reusables/accounts/marketing-emails.md index d81900ae9c..4f4e0ba208 100644 --- a/data/reusables/accounts/marketing-emails.md +++ b/data/reusables/accounts/marketing-emails.md @@ -1,5 +1,5 @@ {% data variables.product.product_name %} occasionally sends the following types of marketing emails: -- Tips and tricks for getting started with your account -- Customized information about engaging projects or new features -- Newsletters that you've subscribed to +* Tips and tricks for getting started with your account +* Customized information about engaging projects or new features +* Newsletters that you've subscribed to diff --git a/data/reusables/accounts/unlinking-email-address.md b/data/reusables/accounts/unlinking-email-address.md index 2ecfab9fad..522ee82a88 100644 --- a/data/reusables/accounts/unlinking-email-address.md +++ b/data/reusables/accounts/unlinking-email-address.md @@ -1,7 +1,7 @@ 1. To begin unlinking an email address from the locked account, click **Start unlinking email**. 1. On the "Unlink Email" screen, click **Continue**. 1. In the inbox of the email account you want to unlink, open the email with the subject "[{% data variables.product.company_short %}] Unlink this email." - - Optionally, to unlink multiple email accounts, in the inbox of each account you want to unlink, open the email with the subject "[{% data variables.product.company_short %}] Unlink this email," then complete the following steps. + * Optionally, to unlink multiple email accounts, in the inbox of each account you want to unlink, open the email with the subject "[{% data variables.product.company_short %}] Unlink this email," then complete the following steps. 1. In the email, click **Unlink this email**. diff --git a/data/reusables/actions/about-actions-usage-metrics.md b/data/reusables/actions/about-actions-usage-metrics.md index 9abc7362a5..a9f7cb12b6 100644 --- a/data/reusables/actions/about-actions-usage-metrics.md +++ b/data/reusables/actions/about-actions-usage-metrics.md @@ -1,7 +1,7 @@ {% data variables.product.prodname_actions %} usage metrics enable you to analyze how your organization is using Actions minutes. You can view usage information related to: -- **Workflows**. View usage data for each workflow in your organization, and use this information to identify opportunities for optimization, such as refactoring a workflow or using a {% data variables.actions.hosted_runner %}. -- **Jobs**. See which jobs are the most resource-intensive and where they are running. -- **Repositories**. Get a high-level snapshot of each repository in your organization and their volume of Actions minutes usage. -- **Runtime OS**. Understand how runners for each operating system are using Actions minutes and what types of operating systems your workflows are running on most often. -- **Runner type**. Compare how your self-hosted runners and GitHub-hosted runners use Actions minutes and the volume of workflow runs for each type of runner. +* **Workflows**. View usage data for each workflow in your organization, and use this information to identify opportunities for optimization, such as refactoring a workflow or using a {% data variables.actions.hosted_runner %}. +* **Jobs**. See which jobs are the most resource-intensive and where they are running. +* **Repositories**. Get a high-level snapshot of each repository in your organization and their volume of Actions minutes usage. +* **Runtime OS**. Understand how runners for each operating system are using Actions minutes and what types of operating systems your workflows are running on most often. +* **Runner type**. Compare how your self-hosted runners and GitHub-hosted runners use Actions minutes and the volume of workflow runs for each type of runner. diff --git a/data/reusables/actions/about-artifact-attestations.md b/data/reusables/actions/about-artifact-attestations.md index eb3f3cc977..0860a19048 100644 --- a/data/reusables/actions/about-artifact-attestations.md +++ b/data/reusables/actions/about-artifact-attestations.md @@ -2,8 +2,8 @@ Artifact attestations enable you to create unfalsifiable provenance and integrit When you generate artifact attestations with your software, you create cryptographically signed claims that establish your build's provenance and include the following information: -- 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)." +* 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)." 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-artifact-log-retention.md b/data/reusables/actions/about-artifact-log-retention.md index 5cfff1f2ff..cf8d842621 100644 --- a/data/reusables/actions/about-artifact-log-retention.md +++ b/data/reusables/actions/about-artifact-log-retention.md @@ -3,8 +3,8 @@ By default, the artifacts and log files generated by workflows are retained for {%- ifversion fpt or ghec %} You can adjust the retention period, depending on the type of repository: -- For public repositories: you can change this retention period to anywhere between 1 day or 90 days. -- For private{% ifversion ghec %} and internal{% endif %} repositories: you can change this retention period to anywhere between 1 day or 400 days. +* For public repositories: you can change this retention period to anywhere between 1 day or 90 days. +* For private{% ifversion ghec %} and internal{% endif %} repositories: you can change this retention period to anywhere between 1 day or 400 days. {%- else %} You can change this retention period to anywhere between 1 day or 400 days. {%- endif %} diff --git a/data/reusables/actions/about-larger-runners.md b/data/reusables/actions/about-larger-runners.md index 7a0034973d..2875aecba2 100644 --- a/data/reusables/actions/about-larger-runners.md +++ b/data/reusables/actions/about-larger-runners.md @@ -1,9 +1,9 @@ Customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans can choose from a range of managed virtual machines that have more resources than the [standard {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources). These machines are referred to as "{% data variables.actions.hosted_runner %}." They offer the following advanced features: -- More RAM, CPU, and disk space -- Static IP addresses -- The ability to group runners -- Autoscaling to support concurrent workflows -- GPU-powered and ARM-powered runners +* More RAM, CPU, and disk space +* Static IP addresses +* The ability to group runners +* Autoscaling to support concurrent workflows +* GPU-powered and ARM-powered runners These {% data variables.actions.hosted_runners %} are hosted by {% data variables.product.prodname_dotcom %} and have the runner application and other tools preinstalled. diff --git a/data/reusables/actions/about-triggers.md b/data/reusables/actions/about-triggers.md index f5b729bb61..f4946cd226 100644 --- a/data/reusables/actions/about-triggers.md +++ b/data/reusables/actions/about-triggers.md @@ -1,8 +1,8 @@ Workflow triggers are events that cause a workflow to run. These events can be: -- Events that occur in your workflow's repository -- Events that occur outside of {% data variables.product.product_name %} and trigger a `repository_dispatch` event on {% data variables.product.product_name %} -- Scheduled times -- Manual +* Events that occur in your workflow's repository +* Events that occur outside of {% data variables.product.product_name %} and trigger a `repository_dispatch` event on {% data variables.product.product_name %} +* Scheduled times +* Manual For example, you can configure your workflow to run when a push is made to the default branch of your repository, when a release is created, or when an issue is opened. diff --git a/data/reusables/actions/actions-group-concurrency.md b/data/reusables/actions/actions-group-concurrency.md index c494cae99f..566ff431a6 100644 --- a/data/reusables/actions/actions-group-concurrency.md +++ b/data/reusables/actions/actions-group-concurrency.md @@ -6,8 +6,8 @@ To also cancel any currently running job or workflow in the same concurrency gro **Notes:** -- The concurrency group name is case insensitive. For example, `prod` and `Prod` will be treated as the same concurrency group. -- Ordering is not guaranteed for jobs or workflow runs using concurrency groups. Jobs or workflow runs in the same concurrency group are handled in an arbitrary order. +* The concurrency group name is case insensitive. For example, `prod` and `Prod` will be treated as the same concurrency group. +* Ordering is not guaranteed for jobs or workflow runs using concurrency groups. Jobs or workflow runs in the same concurrency group are handled in an arbitrary order. {% endnote %} diff --git a/data/reusables/actions/actions-importer-prerequisites.md b/data/reusables/actions/actions-importer-prerequisites.md index e9897faa8f..debc1aead0 100644 --- a/data/reusables/actions/actions-importer-prerequisites.md +++ b/data/reusables/actions/actions-importer-prerequisites.md @@ -1,6 +1,6 @@ -- An environment where you can run Linux-based containers, and can install the necessary tools. - - Docker is [installed](https://docs.docker.com/get-docker/) and running. - - [{% data variables.product.prodname_dotcom %} CLI](https://cli.github.com) is installed. +* An environment where you can run Linux-based containers, and can install the necessary tools. + * Docker is [installed](https://docs.docker.com/get-docker/) and running. + * [{% data variables.product.prodname_dotcom %} CLI](https://cli.github.com) is installed. {% note %} diff --git a/data/reusables/actions/actions-multiple-types.md b/data/reusables/actions/actions-multiple-types.md index 0a904faa5c..0b77f7ac2a 100644 --- a/data/reusables/actions/actions-multiple-types.md +++ b/data/reusables/actions/actions-multiple-types.md @@ -2,9 +2,9 @@ If you specify activity types or filters for an event and your workflow triggers For example, a workflow with the following `on` value will run when: -- A label is created -- A push is made to the `main` branch in the repository -- A push is made to a {% data variables.product.prodname_pages %}-enabled branch +* A label is created +* A push is made to the `main` branch in the repository +* A push is made to a {% data variables.product.prodname_pages %}-enabled branch ```yaml on: diff --git a/data/reusables/actions/actions-secrets-and-variables-naming.md b/data/reusables/actions/actions-secrets-and-variables-naming.md index f355e4abf7..0f79d2753b 100644 --- a/data/reusables/actions/actions-secrets-and-variables-naming.md +++ b/data/reusables/actions/actions-secrets-and-variables-naming.md @@ -1,5 +1,5 @@ -- Names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. -- Names must not start with the `GITHUB_` prefix. -- Names must not start with a number. -- Names are case insensitive. -- Names must be unique at the level they are created at. +* Names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. +* Names must not start with the `GITHUB_` prefix. +* Names must not start with a number. +* Names are case insensitive. +* Names must be unique at the level they are created at. diff --git a/data/reusables/actions/add-hosted-runner.md b/data/reusables/actions/add-hosted-runner.md index e142626fb4..c7d7c23485 100644 --- a/data/reusables/actions/add-hosted-runner.md +++ b/data/reusables/actions/add-hosted-runner.md @@ -1,15 +1,15 @@ 1. Click **New runner**, then click **{% octicon "mark-github" aria-label="New hosted runner" %} New {% data variables.product.prodname_dotcom %}-hosted runner**. 1. Complete the required details to configure your new runner: - - **Name**: Enter a name for your new runner. For easier identification, this should indicate its hardware and operating configuration, such as `ubuntu-20.04-16core`. - - **Platform**: Choose a platform from the available options. Once you've selected a platform, you will be able to choose a specific image. - - **Image**: Choose an image from the available options. Once you've selected an image, you will be able to choose a specific size. - - **GitHub-owned**: For images managed by GitHub, select an image under this tab. - - **Partner**: For images managed by a partner, select an image under this tab. Windows 11 desktop and GPU-optimized images are located under this tab. - - **Size**: Choose a hardware configuration from the list of available options. The available sizes depend on the image that you selected in a previous step. For GPU runners, select a size under the **GPU-powered** tab. - - **Maximum concurrency**: Choose the maximum number of jobs that can be active at any time. - - **Runner group**: Choose the group that your runner will be a member of. This group will host multiple instances of your runner, as they scale up and down to suit demand. {% ifversion ghec %} - - **Networking**: Choose whether static IP address ranges will be assigned to instances of the {% data variables.actions.hosted_runner %}. You can use up to 10 {% data variables.actions.hosted_runner %}s with static IP addresses in total. {% endif %} + * **Name**: Enter a name for your new runner. For easier identification, this should indicate its hardware and operating configuration, such as `ubuntu-20.04-16core`. + * **Platform**: Choose a platform from the available options. Once you've selected a platform, you will be able to choose a specific image. + * **Image**: Choose an image from the available options. Once you've selected an image, you will be able to choose a specific size. + * **GitHub-owned**: For images managed by GitHub, select an image under this tab. + * **Partner**: For images managed by a partner, select an image under this tab. Windows 11 desktop and GPU-optimized images are located under this tab. + * **Size**: Choose a hardware configuration from the list of available options. The available sizes depend on the image that you selected in a previous step. For GPU runners, select a size under the **GPU-powered** tab. + * **Maximum concurrency**: Choose the maximum number of jobs that can be active at any time. + * **Runner group**: Choose the group that your runner will be a member of. This group will host multiple instances of your runner, as they scale up and down to suit demand. {% ifversion ghec %} + * **Networking**: Choose whether static IP address ranges will be assigned to instances of the {% data variables.actions.hosted_runner %}. You can use up to 10 {% data variables.actions.hosted_runner %}s with static IP addresses in total. {% endif %} {% data reusables.actions.larger-runner-name-note %} diff --git a/data/reusables/actions/allow-specific-actions-intro.md b/data/reusables/actions/allow-specific-actions-intro.md index 114439f0ba..d4a2718d41 100644 --- a/data/reusables/actions/allow-specific-actions-intro.md +++ b/data/reusables/actions/allow-specific-actions-intro.md @@ -7,15 +7,15 @@ 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 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. +* **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 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)." diff --git a/data/reusables/actions/artifact-attestations-step-for-container-images.md b/data/reusables/actions/artifact-attestations-step-for-container-images.md index 8a0683b3af..b48ce30773 100644 --- a/data/reusables/actions/artifact-attestations-step-for-container-images.md +++ b/data/reusables/actions/artifact-attestations-step-for-container-images.md @@ -1,4 +1,4 @@ -- name: Generate artifact attestation +* name: Generate artifact attestation uses: actions/attest-build-provenance@v1 with: subject-name: {% raw %}${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}{% endraw %} diff --git a/data/reusables/actions/azure-vnet-actions-service-permissions.md b/data/reusables/actions/azure-vnet-actions-service-permissions.md index 448abff0ff..f7b4d39341 100644 --- a/data/reusables/actions/azure-vnet-actions-service-permissions.md +++ b/data/reusables/actions/azure-vnet-actions-service-permissions.md @@ -1,40 +1,40 @@ In order to successfully deploy a NIC and join a NIC to a subnet, the {% data variables.product.prodname_actions %} service maintains the following Azure role-based access control (RBAC) permissions in your Azure subscription. For more information about fine-grained access management of Azure resources, see [Azure RBAC](https://learn.microsoft.com/en-us/azure/role-based-access-control/) in the Azure documentation. -- `GitHub.Network/operations/read` -- `GitHub.Network/networkSettings/read` -- `GitHub.Network/networkSettings/write` -- `GitHub.Network/networkSettings/delete` -- `Microsoft.Network/locations/operations/read` -- `Microsoft.Network/locations/operationResults/read` -- `Microsoft.Network/locations/usages/read` -- `Microsoft.Network/networkInterfaces/read` -- `Microsoft.Network/networkInterfaces/write` -- `Microsoft.Network/networkInterfaces/delete` -- `Microsoft.Network/networkInterfaces/join/action` -- `Microsoft.Network/networkSecurityGroups/join/action` -- `Microsoft.Network/networkSecurityGroups/read` -- `Microsoft.Network/publicIpAddresses/read` -- `Microsoft.Network/publicIpAddresses/write` -- `Microsoft.Network/publicIPAddresses/join/action` -- `Microsoft.Network/routeTables/join/action` -- `Microsoft.Network/virtualNetworks/read` -- `Microsoft.Network/virtualNetworks/subnets/join/action` -- `Microsoft.Network/virtualNetworks/subnets/read` -- `Microsoft.Network/virtualNetworks/subnets/write` -- `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/delete` -- `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/read` -- `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/write` -- `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/details/read` -- `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/validate/action` -- `Microsoft.Resources/subscriptions/resourceGroups/read` -- `Microsoft.Resources/subscriptions/resourcegroups/deployments/read` -- `Microsoft.Resources/subscriptions/resourcegroups/deployments/write` -- `Microsoft.Resources/subscriptions/resourcegroups/deployments/operations/read` -- `Microsoft.Resources/deployments/read` -- `Microsoft.Resources/deployments/write` -- `Microsoft.Resources/deployments/operationStatuses/read` +* `GitHub.Network/operations/read` +* `GitHub.Network/networkSettings/read` +* `GitHub.Network/networkSettings/write` +* `GitHub.Network/networkSettings/delete` +* `Microsoft.Network/locations/operations/read` +* `Microsoft.Network/locations/operationResults/read` +* `Microsoft.Network/locations/usages/read` +* `Microsoft.Network/networkInterfaces/read` +* `Microsoft.Network/networkInterfaces/write` +* `Microsoft.Network/networkInterfaces/delete` +* `Microsoft.Network/networkInterfaces/join/action` +* `Microsoft.Network/networkSecurityGroups/join/action` +* `Microsoft.Network/networkSecurityGroups/read` +* `Microsoft.Network/publicIpAddresses/read` +* `Microsoft.Network/publicIpAddresses/write` +* `Microsoft.Network/publicIPAddresses/join/action` +* `Microsoft.Network/routeTables/join/action` +* `Microsoft.Network/virtualNetworks/read` +* `Microsoft.Network/virtualNetworks/subnets/join/action` +* `Microsoft.Network/virtualNetworks/subnets/read` +* `Microsoft.Network/virtualNetworks/subnets/write` +* `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/delete` +* `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/read` +* `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/write` +* `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/details/read` +* `Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks/validate/action` +* `Microsoft.Resources/subscriptions/resourceGroups/read` +* `Microsoft.Resources/subscriptions/resourcegroups/deployments/read` +* `Microsoft.Resources/subscriptions/resourcegroups/deployments/write` +* `Microsoft.Resources/subscriptions/resourcegroups/deployments/operations/read` +* `Microsoft.Resources/deployments/read` +* `Microsoft.Resources/deployments/write` +* `Microsoft.Resources/deployments/operationStatuses/read` The following permissions will be present on two enterprise applications in your Azure tenant. You will see the enterprise applications your Azure tenant after configuring Azure private networking. -- `GitHub CPS Network Service` id: `85c49807-809d-4249-86e7-192762525474` -- `GitHub Actions API` id: `4435c199-c3da-46b9-a61d-76de3f2c9f82` +* `GitHub CPS Network Service` id: `85c49807-809d-4249-86e7-192762525474` +* `GitHub Actions API` id: `4435c199-c3da-46b9-a61d-76de3f2c9f82` diff --git a/data/reusables/actions/azure-vnet-configure-azure-resources-script.md b/data/reusables/actions/azure-vnet-configure-azure-resources-script.md index 8d17c9f5bf..4e8be8216f 100644 --- a/data/reusables/actions/azure-vnet-configure-azure-resources-script.md +++ b/data/reusables/actions/azure-vnet-configure-azure-resources-script.md @@ -8,10 +8,10 @@ To use the script, fill in the placeholder environment variable values with the **Notes**: -- Run the following script in the same directory where you saved the `actions-nsg-deployment.bicep` file. -- When setting the `YOUR_AZURE_LOCATION` environment variable, use your region’s name. This value is different than your region’s display name. To see a list of names and display names, use `az account list-locations -o table`. -- When you create the network settings resource, a service association link is applied to the subnet that you provide. This link prevents accidental deletion of the subnet while in use by the {% data variables.product.prodname_actions %} service. -- If you customize this script to use network resources in existing subnets, you must ensure any existing network interfaces (NICs) connected to the subnet are deleted before the subnet is delegated to the {% data variables.product.prodname_actions %} service. Otherwise, the service will fail to apply the service association link to the subnet. +* Run the following script in the same directory where you saved the `actions-nsg-deployment.bicep` file. +* When setting the `YOUR_AZURE_LOCATION` environment variable, use your region’s name. This value is different than your region’s display name. To see a list of names and display names, use `az account list-locations -o table`. +* When you create the network settings resource, a service association link is applied to the subnet that you provide. This link prevents accidental deletion of the subnet while in use by the {% data variables.product.prodname_actions %} service. +* If you customize this script to use network resources in existing subnets, you must ensure any existing network interfaces (NICs) connected to the subnet are deleted before the subnet is delegated to the {% data variables.product.prodname_actions %} service. Otherwise, the service will fail to apply the service association link to the subnet. {% endnote %} diff --git a/data/reusables/actions/azure-vnet-intro-capabilities.md b/data/reusables/actions/azure-vnet-intro-capabilities.md index 28fb0705d0..9f6bd97141 100644 --- a/data/reusables/actions/azure-vnet-intro-capabilities.md +++ b/data/reusables/actions/azure-vnet-intro-capabilities.md @@ -1,6 +1,6 @@ You can connect multiple VNET subnets to {% data variables.location.product_location %} 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. -- Restrict what {% data variables.product.company_short %}-hosted runners can access or connect to with full control over outbound network policies. -- Monitor network logs for {% data variables.product.company_short %}-hosted runners and view all connectivity to and from a runner. +* Privately connect a runner to resources inside an Azure VNET without opening internet ports, including on-premises resources accessible from the Azure VNET. +* Restrict what {% data variables.product.company_short %}-hosted runners can access or connect to with full control over outbound network policies. +* Monitor network logs for {% data variables.product.company_short %}-hosted runners and view all connectivity to and from a runner. diff --git a/data/reusables/actions/azure-vnet-procedures-prereqs.md b/data/reusables/actions/azure-vnet-procedures-prereqs.md index fefaeb7d47..8624517c20 100644 --- a/data/reusables/actions/azure-vnet-procedures-prereqs.md +++ b/data/reusables/actions/azure-vnet-procedures-prereqs.md @@ -2,13 +2,13 @@ You will use a script to automate configuring your Azure resources. ### Prerequisites -- Use an Azure account with the Subscription Contributor role and the Network Contributor role. These roles enable you to register the `GitHub.Network` resource provider and delegate the subnet. For more information, see [Azure built-in roles](https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles) on Microsoft Learn. +* Use an Azure account with the Subscription Contributor role and the Network Contributor role. These roles enable you to register the `GitHub.Network` resource provider and delegate the subnet. For more information, see [Azure built-in roles](https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles) on Microsoft Learn. -- To correctly associate the subnets with the right user, Azure `NetworkSettings` resources must be created in the same subscriptions where virtual networks are created. +* To correctly associate the subnets with the right user, Azure `NetworkSettings` resources must be created in the same subscriptions where virtual networks are created. -- To ensure resource availability/data residency, resources must be created in the same Azure region. +* To ensure resource availability/data residency, resources must be created in the same Azure region. -- Save the following `.bicep` file. Name the file `actions-nsg-deployment.bicep`. +* Save the following `.bicep` file. Name the file `actions-nsg-deployment.bicep`. {% note %} diff --git a/data/reusables/actions/azure-vnet-supported-regions.md b/data/reusables/actions/azure-vnet-supported-regions.md index a4b1b52849..ff285ac9f7 100644 --- a/data/reusables/actions/azure-vnet-supported-regions.md +++ b/data/reusables/actions/azure-vnet-supported-regions.md @@ -22,18 +22,18 @@ The {% data variables.product.prodname_actions %} service supports a subset of a Azure private networking supports GPU runners in the following regions. -- `EastUs` -- `WestUs` -- `NorthCentralUs` -- `SouthCentralUs` +* `EastUs` +* `WestUs` +* `NorthCentralUs` +* `SouthCentralUs` Azure private networking supports arm64 runners in the following regions. -- `EastUs` -- `EastUs2` -- `WestUs2` -- `NorthCentralUs` -- `SouthCentralUs` +* `EastUs` +* `EastUs2` +* `WestUs2` +* `NorthCentralUs` +* `SouthCentralUs` > [!NOTE] > GPU and arm64 runners are currently in beta and subject to change. diff --git a/data/reusables/actions/comparing-artifacts-caching.md b/data/reusables/actions/comparing-artifacts-caching.md index 99946f772c..b63c55d9ed 100644 --- a/data/reusables/actions/comparing-artifacts-caching.md +++ b/data/reusables/actions/comparing-artifacts-caching.md @@ -2,5 +2,5 @@ Artifacts and caching are similar because they provide the ability to store files on {% data variables.product.prodname_dotcom %}, but each feature offers different use cases and cannot be used interchangeably. -- Use caching when you want to reuse files that don't change often between jobs or workflow runs, such as build dependencies from a package management system. -- Use artifacts when you want to save files produced by a job to view after a workflow run has ended, such as built binaries or build logs. +* Use caching when you want to reuse files that don't change often between jobs or workflow runs, such as build dependencies from a package management system. +* Use artifacts when you want to save files produced by a job to view after a workflow run has ended, such as built binaries or build logs. diff --git a/data/reusables/actions/configure-storage-provider-platform-commands.md b/data/reusables/actions/configure-storage-provider-platform-commands.md index cfbbf10dd3..5799a22b88 100644 --- a/data/reusables/actions/configure-storage-provider-platform-commands.md +++ b/data/reusables/actions/configure-storage-provider-platform-commands.md @@ -1,17 +1,17 @@ -- Azure Blob Storage: +* Azure Blob Storage: ```shell copy ghe-config secrets.actions.storage.blob-provider "azure" ``` -- Amazon S3: +* Amazon S3: ```shell copy ghe-config secrets.actions.storage.blob-provider "s3" ``` {%- ifversion actions-ghes-gcp-storage %} -- Google Cloud Storage: +* Google Cloud Storage: ```shell copy ghe-config secrets.actions.storage.blob-provider "gcs" diff --git a/data/reusables/actions/configure-storage-provider.md b/data/reusables/actions/configure-storage-provider.md index b319babb1c..09a86c9373 100644 --- a/data/reusables/actions/configure-storage-provider.md +++ b/data/reusables/actions/configure-storage-provider.md @@ -1,12 +1,12 @@ 1. Configure the external storage connection by entering the following commands, replacing the placeholder values with actual values for your connection. - - Azure Blob Storage: + * Azure Blob Storage: ```shell copy ghe-config secrets.actions.storage.azure.connection-string "CONNECTION STRING" ``` - - Amazon S3: + * Amazon S3: ```shell copy ghe-config secrets.actions.storage.s3.bucket-name "S3 BUCKET NAME" @@ -22,7 +22,7 @@ ``` {%- ifversion actions-ghes-gcp-storage %} - - Google Cloud Storage: + * Google Cloud Storage: ```shell copy ghe-config secrets.actions.storage.gcs.service-url "SERVICE URL" diff --git a/data/reusables/actions/create-azure-app-plan.md b/data/reusables/actions/create-azure-app-plan.md index 15c7e488e2..9f3bec8aed 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/dependabot-version-updates-actions-caveats.md b/data/reusables/actions/dependabot-version-updates-actions-caveats.md index bce1cadbb9..a8eb2c49f4 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/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#git)." +* {% 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/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#git)." diff --git a/data/reusables/actions/docker-container-os-support.md b/data/reusables/actions/docker-container-os-support.md index f17611d90b..e334bce18c 100644 --- a/data/reusables/actions/docker-container-os-support.md +++ b/data/reusables/actions/docker-container-os-support.md @@ -2,7 +2,7 @@ **Note:** If your workflows use Docker container actions, job containers, or service containers, then you must use a Linux runner: -- If you are using {% data variables.product.prodname_dotcom %}-hosted runners, you must use an Ubuntu runner. -- If you are using self-hosted runners, you must use a Linux machine as your runner and Docker must be installed. +* If you are using {% data variables.product.prodname_dotcom %}-hosted runners, you must use an Ubuntu runner. +* If you are using self-hosted runners, you must use a Linux machine as your runner and Docker must be installed. {% endnote %} diff --git a/data/reusables/actions/enterprise-common-prereqs.md b/data/reusables/actions/enterprise-common-prereqs.md index 8b04e33b14..b8ba2191fa 100644 --- a/data/reusables/actions/enterprise-common-prereqs.md +++ b/data/reusables/actions/enterprise-common-prereqs.md @@ -1,9 +1,9 @@ -- 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.location.product_location %}'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.location.product_location %}'s domain. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls)." {% note %} **Note:** {% data reusables.actions.enterprise-self-signed-cert %} {% endnote %} -- {% data reusables.actions.enterprise-http-proxy %} +* {% data reusables.actions.enterprise-http-proxy %} diff --git a/data/reusables/actions/enterprise-gcp-storage-credential-fields.md b/data/reusables/actions/enterprise-gcp-storage-credential-fields.md index 783684bcd8..67b93bef48 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. +* **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. diff --git a/data/reusables/actions/enterprise-http-proxy.md b/data/reusables/actions/enterprise-http-proxy.md index 06566a5d39..d2ce163532 100644 --- a/data/reusables/actions/enterprise-http-proxy.md +++ b/data/reusables/actions/enterprise-http-proxy.md @@ -1,6 +1,6 @@ If you have an **HTTP Proxy Server** configured on {% data variables.location.product_location %}: -- 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. +* 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)." diff --git a/data/reusables/actions/enterprise-minio-storage-credential-fields.md b/data/reusables/actions/enterprise-minio-storage-credential-fields.md index 0f759e38b1..5915bb671e 100644 --- a/data/reusables/actions/enterprise-minio-storage-credential-fields.md +++ b/data/reusables/actions/enterprise-minio-storage-credential-fields.md @@ -1,3 +1,3 @@ -- **AWS Service URL**: The URL to your MinIO service. For example, `https://my-minio.example:9000`. -- **AWS S3 Bucket**: The name of your S3 bucket. -- **AWS S3 Access Key** and **AWS S3 Secret Key**: The `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` used for your MinIO instance. +* **AWS Service URL**: The URL to your MinIO service. For example, `https://my-minio.example:9000`. +* **AWS S3 Bucket**: The name of your S3 bucket. +* **AWS S3 Access Key** and **AWS S3 Secret Key**: The `MINIO_ACCESS_KEY` and `MINIO_SECRET_KEY` used for your MinIO instance. diff --git a/data/reusables/actions/enterprise-oidc-prereqs.md b/data/reusables/actions/enterprise-oidc-prereqs.md index 97801475f5..e959373c64 100644 --- a/data/reusables/actions/enterprise-oidc-prereqs.md +++ b/data/reusables/actions/enterprise-oidc-prereqs.md @@ -1,5 +1,5 @@ {% ifversion ghes-actions-storage-oidc %} -- If you are using OIDC for the connection to your storage provider, you must expose the following OIDC token service URLs on {% data variables.location.product_location_enterprise %} to the public internet: +* If you are using OIDC for the connection to your storage provider, you must expose the following OIDC token service URLs on {% data variables.location.product_location_enterprise %} to the public internet: ```text https://HOSTNAME/_services/token/.well-known/openid-configuration diff --git a/data/reusables/actions/enterprise-s3-permission.md b/data/reusables/actions/enterprise-s3-permission.md index e7cf706ff6..a06ebb6c26 100644 --- a/data/reusables/actions/enterprise-s3-permission.md +++ b/data/reusables/actions/enterprise-s3-permission.md @@ -1,10 +1,10 @@ {% data variables.product.prodname_actions %} requires the following permissions for the access key that will access the bucket: -- `s3:PutObject` -- `s3:GetObject` -- `s3:ListBucketMultipartUploads` -- `s3:ListMultipartUploadParts` -- `s3:AbortMultipartUpload` -- `s3:DeleteObject` -- `s3:ListBucket` -- `kms:GenerateDataKey` (if Key Management Service (KMS) encryption has been enabled) +* `s3:PutObject` +* `s3:GetObject` +* `s3:ListBucketMultipartUploads` +* `s3:ListMultipartUploadParts` +* `s3:AbortMultipartUpload` +* `s3:DeleteObject` +* `s3:ListBucket` +* `kms:GenerateDataKey` (if Key Management Service (KMS) encryption has been enabled) diff --git a/data/reusables/actions/enterprise-s3-storage-credential-fields.md b/data/reusables/actions/enterprise-s3-storage-credential-fields.md index 81f3c79859..2ec8c89eb7 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`. +* **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. -- **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. +* **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-storage-about-oidc.md b/data/reusables/actions/enterprise-storage-about-oidc.md index a606ba1a2a..8196d22fc8 100644 --- a/data/reusables/actions/enterprise-storage-about-oidc.md +++ b/data/reusables/actions/enterprise-storage-about-oidc.md @@ -1,6 +1,6 @@ There are two options for configuring {% data variables.product.prodname_ghe_server %} to connect to your external storage provider: -- OpenID Connect (OIDC) -- Traditional credentials-based authentication using secrets +* OpenID Connect (OIDC) +* Traditional credentials-based authentication using secrets We recommend using OIDC where possible, as you won't need create or manage sensitive and long-lived credential secrets for your storage provider, and risk them being exposed. After defining a trust with OIDC, your cloud storage provider automatically issues short-lived access tokens to {% data variables.location.product_location_enterprise %}, which automatically expire. diff --git a/data/reusables/actions/gai-inspect-audit.md b/data/reusables/actions/gai-inspect-audit.md index c51b816b3c..b1c94e2a31 100644 --- a/data/reusables/actions/gai-inspect-audit.md +++ b/data/reusables/actions/gai-inspect-audit.md @@ -8,13 +8,13 @@ The "Pipelines" section contains a high-level statistics regarding the conversio Listed below are some key terms that can appear in the "Pipelines" section: -- **Successful** pipelines had 100% of the pipeline constructs and individual items converted automatically to their {% data variables.product.prodname_actions %} equivalent. -- **Partially successful** pipelines had all of the pipeline constructs converted, however, there were some individual items that were not converted automatically to their {% data variables.product.prodname_actions %} equivalent. -- **Unsupported** pipelines are definition types that are not supported by {% data variables.product.prodname_actions_importer %}. -- **Failed** pipelines encountered a fatal error when being converted. This can occur for one of three reasons: - - The pipeline was misconfigured and not valid in Bamboo. - - {% data variables.product.prodname_actions_importer %} encountered an internal error when converting it. - - There was an unsuccessful network response that caused the pipeline to be inaccessible, which is often due to invalid credentials. +* **Successful** pipelines had 100% of the pipeline constructs and individual items converted automatically to their {% data variables.product.prodname_actions %} equivalent. +* **Partially successful** pipelines had all of the pipeline constructs converted, however, there were some individual items that were not converted automatically to their {% data variables.product.prodname_actions %} equivalent. +* **Unsupported** pipelines are definition types that are not supported by {% data variables.product.prodname_actions_importer %}. +* **Failed** pipelines encountered a fatal error when being converted. This can occur for one of three reasons: + * The pipeline was misconfigured and not valid in Bamboo. + * {% data variables.product.prodname_actions_importer %} encountered an internal error when converting it. + * There was an unsuccessful network response that caused the pipeline to be inaccessible, which is often due to invalid credentials. #### Build steps @@ -22,14 +22,14 @@ The "Build steps" section contains an overview of individual build steps that ar Listed below are some key terms that can appear in the "Build steps" section: -- A **known** build step is a step that was automatically converted to an equivalent action. -- An **unknown** build step is a step that was not automatically converted to an equivalent action. -- An **unsupported** build step is a step that is either: - - Fundamentally not supported by {% data variables.product.prodname_actions %}. - - Configured in a way that is incompatible with {% data variables.product.prodname_actions %}. -- An **action** is a list of the actions that were used in the converted workflows. This can be important for: - - If you use {% data variables.product.prodname_ghe_server %}, gathering the list of actions to sync to your instance. - - Defining an organization-level allowlist of actions that are used. This list of actions is a comprehensive list of actions that your security or compliance teams may need to review. +* A **known** build step is a step that was automatically converted to an equivalent action. +* An **unknown** build step is a step that was not automatically converted to an equivalent action. +* An **unsupported** build step is a step that is either: + * Fundamentally not supported by {% data variables.product.prodname_actions %}. + * Configured in a way that is incompatible with {% data variables.product.prodname_actions %}. +* An **action** is a list of the actions that were used in the converted workflows. This can be important for: + * If you use {% data variables.product.prodname_ghe_server %}, gathering the list of actions to sync to your instance. + * Defining an organization-level allowlist of actions that are used. This list of actions is a comprehensive list of actions that your security or compliance teams may need to review. #### Manual tasks @@ -37,8 +37,8 @@ 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 **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. +* 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 @@ -46,9 +46,9 @@ The final section of the audit report provides a manifest of all the files that Each pipeline file has a variety of files included in the audit, including: -- The original pipeline as it was defined in {% data variables.product.prodname_dotcom %}. -- Any network responses used to convert the pipeline. -- The converted workflow file. -- Stack traces that can be used to troubleshoot a failed pipeline conversion. +* The original pipeline as it was defined in {% data variables.product.prodname_dotcom %}. +* Any network responses used to convert the pipeline. +* The converted workflow file. +* Stack traces that can be used to troubleshoot a failed pipeline conversion. Additionally, the `workflow_usage.csv` file contains a comma-separated list of all actions, secrets, and runners that are used by each successfully converted pipeline. This can be useful for determining which workflows use which actions, secrets, or runners, and can be useful for performing security reviews. diff --git a/data/reusables/actions/gai-inspect-pull-request.md b/data/reusables/actions/gai-inspect-pull-request.md index fb5a091cd6..916a7b79e1 100644 --- a/data/reusables/actions/gai-inspect-pull-request.md +++ b/data/reusables/actions/gai-inspect-pull-request.md @@ -4,7 +4,7 @@ The output from a successful run of the `migrate` command contains a link to the Some important elements of the pull request include: -- In the pull request description, a section called **Manual steps**, which lists steps that you must manually complete before you can finish migrating your pipelines to {% data variables.product.prodname_actions %}. For example, this section might tell you to create any secrets used in your workflows. -- The converted workflows file. Select the **Files changed** tab in the pull request to view the workflow file that will be added to your {% data variables.product.product_name %} repository. +* In the pull request description, a section called **Manual steps**, which lists steps that you must manually complete before you can finish migrating your pipelines to {% data variables.product.prodname_actions %}. For example, this section might tell you to create any secrets used in your workflows. +* The converted workflows file. Select the **Files changed** tab in the pull request to view the workflow file that will be added to your {% data variables.product.product_name %} repository. When you are finished inspecting the pull request, you can merge it to add the workflow to your {% data variables.product.product_name %} repository. diff --git a/data/reusables/actions/github-hosted-runners-navigate-to-repo-org-enterprise.md b/data/reusables/actions/github-hosted-runners-navigate-to-repo-org-enterprise.md index 11853fd408..47b2b94754 100644 --- a/data/reusables/actions/github-hosted-runners-navigate-to-repo-org-enterprise.md +++ b/data/reusables/actions/github-hosted-runners-navigate-to-repo-org-enterprise.md @@ -4,9 +4,9 @@ 1. In the left sidebar, click **Actions**, then click **Runners**. {% elsif ghec %} 1. Navigate to your runner settings: - - **In an organization or repository**: Navigate to the main page, then click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. - - **If using an enterprise account**: Navigate to your enterprise account by clicking your profile photo in the top-right corner of {% data variables.product.prodname_dotcom_the_website %}, then clicking **Your enterprises**, then clicking the enterprise. + * **In an organization or repository**: Navigate to the main page, then click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. + * **If using an enterprise account**: Navigate to your enterprise account by clicking your profile photo in the top-right corner of {% data variables.product.prodname_dotcom_the_website %}, then clicking **Your enterprises**, then clicking the enterprise. 1. Navigate to the {% data variables.product.prodname_actions %} settings: - - **In an organization or repository**: Click **Actions** in the left sidebar, then click **Runners**. - - **If using an enterprise account**: In the left sidebar, click **"{% octicon "law" aria-hidden="true" %} Policies"**, then click **Actions**, then click the **Runners** tab. + * **In an organization or repository**: Click **Actions** in the left sidebar, then click **Runners**. + * **If using an enterprise account**: In the left sidebar, click **"{% octicon "law" aria-hidden="true" %} Policies"**, then click **Actions**, then click the **Runners** tab. {% endif %} diff --git a/data/reusables/actions/inputs-vs-github-event-inputs.md b/data/reusables/actions/inputs-vs-github-event-inputs.md index 4d6fc3d06f..8756da238a 100644 --- a/data/reusables/actions/inputs-vs-github-event-inputs.md +++ b/data/reusables/actions/inputs-vs-github-event-inputs.md @@ -4,9 +4,9 @@ **Notes**: -- The workflow will also receive the inputs in the `github.event.inputs` context. The information in the `inputs` context and `github.event.inputs` context is identical except that the `inputs` context preserves Boolean values as Booleans instead of converting them to strings. The `choice` type resolves to a string and is a single selectable option. -- The maximum number of top-level properties for `inputs` is 10. -- The maximum payload for `inputs` is 65,535 characters. +* The workflow will also receive the inputs in the `github.event.inputs` context. The information in the `inputs` context and `github.event.inputs` context is identical except that the `inputs` context preserves Boolean values as Booleans instead of converting them to strings. The `choice` type resolves to a string and is a single selectable option. +* The maximum number of top-level properties for `inputs` is 10. +* The maximum payload for `inputs` is 65,535 characters. {% endnote %} {% endif %} diff --git a/data/reusables/actions/jobs/choosing-runner-overview.md b/data/reusables/actions/jobs/choosing-runner-overview.md index a717b7267b..7943fc62a1 100644 --- a/data/reusables/actions/jobs/choosing-runner-overview.md +++ b/data/reusables/actions/jobs/choosing-runner-overview.md @@ -1,22 +1,22 @@ Use `jobs..runs-on` to define the type of machine to run the job on. {% ifversion fpt or ghec %}- The destination machine can be either a [{% data variables.product.prodname_dotcom %}-hosted runner](#choosing-github-hosted-runners), [{% data variables.actions.hosted_runner %}](#choosing-runners-in-a-group), or a [self-hosted runner](#choosing-self-hosted-runners).{% else %} -- The destination machine can be a [self-hosted runner](#choosing-self-hosted-runners).{% endif %} +* The destination machine can be a [self-hosted runner](#choosing-self-hosted-runners).{% endif %} {% ifversion target-runner-groups %}- You can target runners based on the labels assigned to them, or their group membership, or a combination of these.{% else %} -- You can target runners based on the labels assigned to them.{% endif %} -- You can provide `runs-on` as: - - A single string - - A single variable containing a string - - An array of strings, variables containing strings, or a combination of both - - A `key: value` pair using the `group` or `labels` keys -- If you specify an array of strings or variables, your workflow will execute on any runner that matches all of the specified `runs-on` values. For example, here the job will only run on a self-hosted runner that has the labels `linux`, `x64`, and `gpu`: +* You can target runners based on the labels assigned to them.{% endif %} +* You can provide `runs-on` as: + * A single string + * A single variable containing a string + * An array of strings, variables containing strings, or a combination of both + * A `key: value` pair using the `group` or `labels` keys +* If you specify an array of strings or variables, your workflow will execute on any runner that matches all of the specified `runs-on` values. For example, here the job will only run on a self-hosted runner that has the labels `linux`, `x64`, and `gpu`: ```yaml runs-on: [self-hosted, linux, x64, gpu] ``` For more information, see "[Choosing self-hosted runners](#choosing-self-hosted-runners)." -- You can mix strings and variables in an array. For example: +* You can mix strings and variables in an array. For example: {% raw %} @@ -40,7 +40,7 @@ Use `jobs..runs-on` to define the type of machine to run the job on. {% endraw %} -- If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategy). +* If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategy). {% note %} diff --git a/data/reusables/actions/jobs/matrix-include.md b/data/reusables/actions/jobs/matrix-include.md index cf5e4b1a5d..89d4d466ba 100644 --- a/data/reusables/actions/jobs/matrix-include.md +++ b/data/reusables/actions/jobs/matrix-include.md @@ -22,17 +22,17 @@ strategy: will result in six jobs with the following matrix combinations: -- `{fruit: apple, animal: cat, color: pink, shape: circle}` -- `{fruit: apple, animal: dog, color: green, shape: circle}` -- `{fruit: pear, animal: cat, color: pink}` -- `{fruit: pear, animal: dog, color: green}` -- `{fruit: banana}` -- `{fruit: banana, animal: cat}` +* `{fruit: apple, animal: cat, color: pink, shape: circle}` +* `{fruit: apple, animal: dog, color: green, shape: circle}` +* `{fruit: pear, animal: cat, color: pink}` +* `{fruit: pear, animal: dog, color: green}` +* `{fruit: banana}` +* `{fruit: banana, animal: cat}` following this logic: -- `{color: green}` is added to all of the original matrix combinations because it can be added without overwriting any part of the original combinations. -- `{color: pink, animal: cat}` adds `color:pink` only to the original matrix combinations that include `animal: cat`. This overwrites the `color: green` that was added by the previous `include` entry. -- `{fruit: apple, shape: circle}` adds `shape: circle` only to the original matrix combinations that include `fruit: apple`. -- `{fruit: banana}` cannot be added to any original matrix combination without overwriting a value, so it is added as an additional matrix combination. -- `{fruit: banana, animal: cat}` cannot be added to any original matrix combination without overwriting a value, so it is added as an additional matrix combination. It does not add to the `{fruit: banana}` matrix combination because that combination was not one of the original matrix combinations. +* `{color: green}` is added to all of the original matrix combinations because it can be added without overwriting any part of the original combinations. +* `{color: pink, animal: cat}` adds `color:pink` only to the original matrix combinations that include `animal: cat`. This overwrites the `color: green` that was added by the previous `include` entry. +* `{fruit: apple, shape: circle}` adds `shape: circle` only to the original matrix combinations that include `fruit: apple`. +* `{fruit: banana}` cannot be added to any original matrix combination without overwriting a value, so it is added as an additional matrix combination. +* `{fruit: banana, animal: cat}` cannot be added to any original matrix combination without overwriting a value, so it is added as an additional matrix combination. It does not add to the `{fruit: banana}` matrix combination because that combination was not one of the original matrix combinations. diff --git a/data/reusables/actions/jobs/multi-dimension-matrix.md b/data/reusables/actions/jobs/multi-dimension-matrix.md index 87255ac563..caac5dbc6a 100644 --- a/data/reusables/actions/jobs/multi-dimension-matrix.md +++ b/data/reusables/actions/jobs/multi-dimension-matrix.md @@ -2,8 +2,8 @@ You can specify multiple variables to create a multi-dimensional matrix. A job w For example, the following workflow specifies two variables: -- Two operating systems specified in the `os` variable -- Three Node.js versions specified in the `version` variable +* Two operating systems specified in the `os` variable +* Three Node.js versions specified in the `version` variable The workflow will run six jobs, one for each combination of the `os` and `version` variables. Each job will set the `runs-on` value to the current `os` value and will pass the current `version` value to the `actions/setup-node` action. diff --git a/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md b/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md index 0f250906ae..ac4e197086 100644 --- a/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md +++ b/data/reusables/actions/jobs/section-choosing-the-runner-for-a-job.md @@ -1,22 +1,22 @@ Use `jobs..runs-on` to define the type of machine to run the job on. {% ifversion fpt or ghec %}- The destination machine can be either a [{% data variables.product.prodname_dotcom %}-hosted runner](#choosing-github-hosted-runners), [{% data variables.actions.hosted_runner %}](#choosing-runners-in-a-group), or a [self-hosted runner](#choosing-self-hosted-runners).{% else %} -- The destination machine can be a [self-hosted runner](#choosing-self-hosted-runners).{% endif %} +* The destination machine can be a [self-hosted runner](#choosing-self-hosted-runners).{% endif %} {% ifversion target-runner-groups %}- You can target runners based on the labels assigned to them, or their group membership, or a combination of these.{% else %} -- You can target runners based on the labels assigned to them.{% endif %} -- You can provide `runs-on` as: - - a single string - - a single variable containing a string - - an array of strings, variables containing strings, or a combination of both - - a `key: value` pair using the `group` or `labels` keys -- If you specify an array of strings or variables, your workflow will execute on any runner that matches all of the specified `runs-on` values. For example, here the job will only run on a self-hosted runner that has the labels `linux`, `x64`, and `gpu`: +* You can target runners based on the labels assigned to them.{% endif %} +* You can provide `runs-on` as: + * a single string + * a single variable containing a string + * an array of strings, variables containing strings, or a combination of both + * a `key: value` pair using the `group` or `labels` keys +* If you specify an array of strings or variables, your workflow will execute on any runner that matches all of the specified `runs-on` values. For example, here the job will only run on a self-hosted runner that has the labels `linux`, `x64`, and `gpu`: ```yaml runs-on: [self-hosted, linux, x64, gpu] ``` For more information, see "[Choosing self-hosted runners](#choosing-self-hosted-runners)." -- You can mix strings and variables in an array. For example: +* You can mix strings and variables in an array. For example: {% raw %} @@ -40,7 +40,7 @@ Use `jobs..runs-on` to define the type of machine to run the job on. {% endraw %} -- If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategy). +* If you would like to run your workflow on multiple machines, use [`jobs..strategy`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategy). {% note %} diff --git a/data/reusables/actions/jobs/using-matrix-strategy.md b/data/reusables/actions/jobs/using-matrix-strategy.md index 96a611fa11..cc96b6e80a 100644 --- a/data/reusables/actions/jobs/using-matrix-strategy.md +++ b/data/reusables/actions/jobs/using-matrix-strategy.md @@ -13,12 +13,12 @@ A job will run for each possible combination of the variables. In this example, By default, {% data variables.product.product_name %} will maximize the number of jobs run in parallel depending on runner availability. The order of the variables in the matrix determines the order in which the jobs are created. The first variable you define will be the first job that is created in your workflow run. For example, the above matrix will create the jobs in the following order: -- `{version: 10, os: ubuntu-latest}` -- `{version: 10, os: windows-latest}` -- `{version: 12, os: ubuntu-latest}` -- `{version: 12, os: windows-latest}` -- `{version: 14, os: ubuntu-latest}` -- `{version: 14, os: windows-latest}` +* `{version: 10, os: ubuntu-latest}` +* `{version: 10, os: windows-latest}` +* `{version: 12, os: ubuntu-latest}` +* `{version: 12, os: windows-latest}` +* `{version: 14, os: ubuntu-latest}` +* `{version: 14, os: windows-latest}` 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. diff --git a/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md b/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md index 5ae7d3b369..3f409f39ed 100644 --- a/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md +++ b/data/reusables/actions/larger-runners-troubleshooting-linux-windows.md @@ -1,7 +1,7 @@ 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)." -- **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 %}. +* **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 %}. diff --git a/data/reusables/actions/learning-actions.md b/data/reusables/actions/learning-actions.md index 1a7eb48301..634553d97b 100644 --- a/data/reusables/actions/learning-actions.md +++ b/data/reusables/actions/learning-actions.md @@ -1,4 +1,4 @@ -- To learn about {% data variables.product.prodname_actions %} concepts, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions)." -- For more step-by-step guide for creating a basic workflow, see "[AUTOTITLE](/actions/quickstart)." -- If you're comfortable with the basics of {% data variables.product.prodname_actions %}, you can learn about workflows and their features at "[AUTOTITLE](/actions/using-workflows/about-workflows)." +* To learn about {% data variables.product.prodname_actions %} concepts, see "[AUTOTITLE](/actions/learn-github-actions/understanding-github-actions)." +* For more step-by-step guide for creating a basic workflow, see "[AUTOTITLE](/actions/quickstart)." +* If you're comfortable with the basics of {% data variables.product.prodname_actions %}, you can learn about workflows and their features at "[AUTOTITLE](/actions/using-workflows/about-workflows)." diff --git a/data/reusables/actions/macos-runner-limitations.md b/data/reusables/actions/macos-runner-limitations.md index a3cae4c3f2..aa4a2fc511 100644 --- a/data/reusables/actions/macos-runner-limitations.md +++ b/data/reusables/actions/macos-runner-limitations.md @@ -1,4 +1,4 @@ -- All actions provided by {% data variables.product.prodname_dotcom %} are compatible with arm64 {% data variables.product.prodname_dotcom %}-hosted runners. However, community actions may not be compatible with arm64 and need to be manually installed at runtime. -- Nested-virtualization and Metal Performance Shaders (MPS) are not supported due to the limitation of Apple's Virtualization Framework. -- Networking capabilities such as Azure private networking and assigning static IPs are not currently available for macOS larger runners. -- The arm64 macOS runners do not have a static UUID/UDID assigned to them because Apple does not support this feature. However, Intel MacOS runners are assigned a static UDID, specifically `4203018E-580F-C1B5-9525-B745CECA79EB`. If you are building and signing on the same host you plan to test the build on, you can sign with a [development provisioning profile](https://developer.apple.com/help/account/manage-profiles/create-a-development-provisioning-profile/). If you do require a static UDID, you can use Intel runners and add their UDID to your Apple Developer account. +* All actions provided by {% data variables.product.prodname_dotcom %} are compatible with arm64 {% data variables.product.prodname_dotcom %}-hosted runners. However, community actions may not be compatible with arm64 and need to be manually installed at runtime. +* Nested-virtualization and Metal Performance Shaders (MPS) are not supported due to the limitation of Apple's Virtualization Framework. +* Networking capabilities such as Azure private networking and assigning static IPs are not currently available for macOS larger runners. +* The arm64 macOS runners do not have a static UUID/UDID assigned to them because Apple does not support this feature. However, Intel MacOS runners are assigned a static UDID, specifically `4203018E-580F-C1B5-9525-B745CECA79EB`. If you are building and signing on the same host you plan to test the build on, you can sign with a [development provisioning profile](https://developer.apple.com/help/account/manage-profiles/create-a-development-provisioning-profile/). If you do require a static UDID, you can use Intel runners and add their UDID to your Apple Developer account. diff --git a/data/reusables/actions/oidc-endpoints.md b/data/reusables/actions/oidc-endpoints.md index 005015a1fe..7f5d14bca9 100644 --- a/data/reusables/actions/oidc-endpoints.md +++ b/data/reusables/actions/oidc-endpoints.md @@ -1,3 +1,3 @@ -- You must ensure the following OIDC endpoints are accessible by your cloud provider: - - `https://HOSTNAME/_services/token/.well-known/openid-configuration` - - `https://HOSTNAME/_services/token/.well-known/jwks` +* You must ensure the following OIDC endpoints are accessible by your cloud provider: + * `https://HOSTNAME/_services/token/.well-known/openid-configuration` + * `https://HOSTNAME/_services/token/.well-known/jwks` diff --git a/data/reusables/actions/oidc-further-reading.md b/data/reusables/actions/oidc-further-reading.md index 97c80e40fc..d9db3f4a05 100644 --- a/data/reusables/actions/oidc-further-reading.md +++ b/data/reusables/actions/oidc-further-reading.md @@ -1,4 +1,4 @@ -- [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows) +* [AUTOTITLE](/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows) {% ifversion fpt %}- [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github){% endif %} {% ifversion ghec %}- [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud){% endif %} {% ifversion ghes %}- [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-server){% endif %} diff --git a/data/reusables/actions/oidc-link-to-intro.md b/data/reusables/actions/oidc-link-to-intro.md index d6641e363e..642802d3a5 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-permissions-token.md b/data/reusables/actions/oidc-permissions-token.md index 7766ca14d1..2a70c56f2b 100644 --- a/data/reusables/actions/oidc-permissions-token.md +++ b/data/reusables/actions/oidc-permissions-token.md @@ -2,8 +2,8 @@ The job or workflow run requires a `permissions` setting with [`id-token: write` 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: -- Using environment variables on the runner (`ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN`). -- Using `getIDToken()` from the Actions toolkit. +* Using environment variables on the runner (`ACTIONS_ID_TOKEN_REQUEST_URL` and `ACTIONS_ID_TOKEN_REQUEST_TOKEN`). +* Using `getIDToken()` from the Actions toolkit. If you need to fetch an OIDC token for a workflow, then the permission can be set at the workflow level. For example: diff --git a/data/reusables/actions/oidc-security-notice.md b/data/reusables/actions/oidc-security-notice.md index 420171c7ce..0988ba5df1 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 3b178b70aa..af086de89b 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 %}: -- For a quick way to create a {% data variables.product.prodname_actions %} workflow, see "[AUTOTITLE](/actions/learn-github-actions/using-starter-workflows)." -- For continuous integration (CI) workflows to build and test your code, 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 %}, including many of the above use cases, see "[AUTOTITLE](/actions/examples)." You can see detailed examples that 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 %} -- If you want to certify your proficiency in automating workflows and accelerating development with {% data variables.product.prodname_actions %}, you can 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 %} +* For a quick way to create a {% data variables.product.prodname_actions %} workflow, see "[AUTOTITLE](/actions/learn-github-actions/using-starter-workflows)." +* For continuous integration (CI) workflows to build and test your code, 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 %}, including many of the above use cases, see "[AUTOTITLE](/actions/examples)." You can see detailed examples that 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 %} +* If you want to certify your proficiency in automating workflows and accelerating development with {% data variables.product.prodname_actions %}, you can 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-roles-for-gh-actions.md b/data/reusables/actions/org-roles-for-gh-actions.md index 93a4550aac..ba6be335f2 100644 --- a/data/reusables/actions/org-roles-for-gh-actions.md +++ b/data/reusables/actions/org-roles-for-gh-actions.md @@ -1,6 +1,6 @@ For {% data variables.product.prodname_actions %}, you can enable any of the following permissions for individuals or teams in your organization. -- **Manage organization Actions policies:** Access to manage all settings on the "Actions General" settings page, except for self-hosted runners settings. -- **Manage organization runners and runner groups:** Access to create and manage GitHub-hosted runners, self-hosted runners, and runner groups, and control where self-hosted runners can be created. -- **Manage organization Actions secrets**: Access to create and manage Actions organization secrets. -- **Manage organization Actions variables**: Access to create and manage Actions organization variables. +* **Manage organization Actions policies:** Access to manage all settings on the "Actions General" settings page, except for self-hosted runners settings. +* **Manage organization runners and runner groups:** Access to create and manage GitHub-hosted runners, self-hosted runners, and runner groups, and control where self-hosted runners can be created. +* **Manage organization Actions secrets**: Access to create and manage Actions organization secrets. +* **Manage organization Actions variables**: Access to create and manage Actions organization variables. diff --git a/data/reusables/actions/partial-reruns-with-reusable.md b/data/reusables/actions/partial-reruns-with-reusable.md index 57e4fe147c..15e3342db8 100644 --- a/data/reusables/actions/partial-reruns-with-reusable.md +++ b/data/reusables/actions/partial-reruns-with-reusable.md @@ -2,5 +2,5 @@ Reusable workflows from public repositories can be referenced using a SHA, a rel 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/private-repository-forks-options.md b/data/reusables/actions/private-repository-forks-options.md index 7e7219bd70..bb458ff401 100644 --- a/data/reusables/actions/private-repository-forks-options.md +++ b/data/reusables/actions/private-repository-forks-options.md @@ -1,4 +1,4 @@ -- **Run workflows from fork pull requests** - Allows users to run workflows from fork pull requests, using a `GITHUB_TOKEN` with read-only permission, and with no access to secrets. -- **Send write tokens to workflows from pull requests** - Allows pull requests from forks to use a `GITHUB_TOKEN` with write permission. -- **Send secrets to workflows from pull requests** - Makes all secrets available to the pull request.{% ifversion actions-private-fork-workflow-approvals %} -- **Require approval for fork pull request workflows** - Workflow runs on pull requests from collaborators without write permission will require approval from someone with write permission before they will run.{% endif %} +* **Run workflows from fork pull requests** - Allows users to run workflows from fork pull requests, using a `GITHUB_TOKEN` with read-only permission, and with no access to secrets. +* **Send write tokens to workflows from pull requests** - Allows pull requests from forks to use a `GITHUB_TOKEN` with write permission. +* **Send secrets to workflows from pull requests** - Makes all secrets available to the pull request.{% ifversion actions-private-fork-workflow-approvals %} +* **Require approval for fork pull request workflows** - Workflow runs on pull requests from collaborators without write permission will require approval from someone with write permission before they will run.{% endif %} diff --git a/data/reusables/actions/reusable-workflow-calling-syntax.md b/data/reusables/actions/reusable-workflow-calling-syntax.md index d020f2cae8..3b33128228 100644 --- a/data/reusables/actions/reusable-workflow-calling-syntax.md +++ b/data/reusables/actions/reusable-workflow-calling-syntax.md @@ -1,5 +1,5 @@ -- `{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. +* `{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)." diff --git a/data/reusables/actions/section-using-unique-names-for-runner-groups.md b/data/reusables/actions/section-using-unique-names-for-runner-groups.md index e343447f47..b26972cdd7 100644 --- a/data/reusables/actions/section-using-unique-names-for-runner-groups.md +++ b/data/reusables/actions/section-using-unique-names-for-runner-groups.md @@ -7,8 +7,8 @@ To avoid ambiguity, a workflow will fail if there are duplicate runner groups in the organization and enterprise. To address this, you can either rename one of your runner groups in the organization or enterprise, or you can update your workflow file to add a prefix to the runner group name: -- `org/` or `organization/` -- `ent/` or `enterprise/` +* `org/` or `organization/` +* `ent/` or `enterprise/` ### Example: Using prefixes to differentiate runner groups diff --git a/data/reusables/actions/self-hosted-runner-configure.md b/data/reusables/actions/self-hosted-runner-configure.md index 463e2b64ce..883e271a16 100644 --- a/data/reusables/actions/self-hosted-runner-configure.md +++ b/data/reusables/actions/self-hosted-runner-configure.md @@ -13,7 +13,7 @@ {% endnote %} 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. - - 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 %}. + * 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. + * 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-management-permissions-required.md b/data/reusables/actions/self-hosted-runner-management-permissions-required.md index cace04c370..bf3fb217c4 100644 --- a/data/reusables/actions/self-hosted-runner-management-permissions-required.md +++ b/data/reusables/actions/self-hosted-runner-management-permissions-required.md @@ -1,9 +1,9 @@ A self-hosted runner can be located in either your repository, organization, or {% ifversion fpt or ghec %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif ghes %} enterprise settings on {% data variables.location.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: -- **User repository**: You must be the repository owner. -- **Organization**: You must be an organization owner. -- **Organization repository**: You must be an organization owner, or have admin access to the repository. +* **User repository**: You must be the repository owner. +* **Organization**: You must be an organization owner. +* **Organization repository**: You must be an organization owner, or have admin access to the repository. {% ifversion ghec %} -- **Enterprise account**: You must be an enterprise owner. +* **Enterprise account**: You must be an enterprise owner. {% elsif ghes %} -- **Enterprise**: You must be a {% data variables.product.prodname_enterprise %} site administrator. +* **Enterprise**: You must be a {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md b/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md index c6722e51f1..1fcca8d7ff 100644 --- a/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md +++ b/data/reusables/actions/self-hosted-runner-navigate-to-org-enterprise.md @@ -4,15 +4,15 @@ {% data reusables.organizations.settings-sidebar-actions-runners %} {% elsif ghec or ghes %} 1. Navigate to where your runner is registered: - - **In an organization**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. - - **If using an enterprise-level runner**: + * **In an organization**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. + * **If using an enterprise-level runner**: {% indented_data_reference reusables.enterprise-accounts.access-enterprise spaces=5 %} 1. Navigate to the {% data variables.product.prodname_actions %} settings: - - **In an organization**: + * **In an organization**: {% indented_data_reference reusables.actions.settings-ui.settings-actions-runners spaces=5 %} - - **If using an enterprise-level runner**: + * **If using an enterprise-level runner**: {% indented_data_reference reusables.enterprise-accounts.policies-tab spaces=5 %} {% indented_data_reference reusables.enterprise-accounts.actions-tab spaces=5 %} diff --git a/data/reusables/actions/self-hosted-runner-removing-a-runner-updated.md b/data/reusables/actions/self-hosted-runner-removing-a-runner-updated.md index 75c06d8f84..fca17414e9 100644 --- a/data/reusables/actions/self-hosted-runner-removing-a-runner-updated.md +++ b/data/reusables/actions/self-hosted-runner-removing-a-runner-updated.md @@ -1,12 +1,12 @@ 1. Click **Remove**. 1. You will see instructions for removing the self-hosted runner. Complete either of the following steps to remove the runner, depending on whether it is still accessible: - - **If you have access to the runner machine:** Follow the on-screen instructions for your machine's operating system to run the removal command. The instructions include the required URL and an automatically-generated, time-limited token. + * **If you have access to the runner machine:** Follow the on-screen instructions for your machine's operating system to run the removal command. The instructions include the required URL and an automatically-generated, time-limited token. The removal command does the following tasks: - - Removes the runner from {% data variables.product.product_name %}. - - Removes any self-hosted runner application configuration files on the machine. - - Removes any services configured if not running in interactive mode. + * Removes the runner from {% data variables.product.product_name %}. + * Removes any self-hosted runner application configuration files on the machine. + * Removes any services configured if not running in interactive mode. - - **If you don't have access to the machine:** Click **Force remove this runner** to force {% data variables.product.product_name %} to remove the runner. + * **If you don't have access to the machine:** Click **Force remove this runner** to force {% data variables.product.product_name %} to remove the runner. diff --git a/data/reusables/actions/self-hosted-runners-prerequisites.md b/data/reusables/actions/self-hosted-runners-prerequisites.md index bd4399a115..300620e727 100644 --- a/data/reusables/actions/self-hosted-runners-prerequisites.md +++ b/data/reusables/actions/self-hosted-runners-prerequisites.md @@ -1,7 +1,7 @@ {%- 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. +* You must have access to the machine you will use as a self-hosted runner in your environment. {% ifversion ghes %}- {% data reusables.actions.self-hosted-runner-ports-protocols %}{% endif %} diff --git a/data/reusables/actions/starter-workflow-categories.md b/data/reusables/actions/starter-workflow-categories.md index 09a7604296..252bb4bec8 100644 --- a/data/reusables/actions/starter-workflow-categories.md +++ b/data/reusables/actions/starter-workflow-categories.md @@ -1,5 +1,5 @@ {% data variables.product.prodname_dotcom %} provides ready-to-use starter workflows for the following high level categories: -- **Deployment (CD)**. For more information, see "[AUTOTITLE](/actions/deployment/about-deployments/about-continuous-deployment)." +* **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 starter workflows 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. +* **Continuous Integration (CI)**. For more information, see "[AUTOTITLE](/actions/automating-builds-and-tests/about-continuous-integration)." +* **Automation**. Automation starter workflows 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/third-party-actions.md b/data/reusables/actions/third-party-actions.md index d682365cb1..03175a079e 100644 --- a/data/reusables/actions/third-party-actions.md +++ b/data/reusables/actions/third-party-actions.md @@ -2,7 +2,7 @@ **Notes**: -- This starter workflow 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)." +* This starter workflow 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)." {% endnote %} diff --git a/data/reusables/actions/usage-api-requests.md b/data/reusables/actions/usage-api-requests.md index f17e591f52..d6a9cce43c 100644 --- a/data/reusables/actions/usage-api-requests.md +++ b/data/reusables/actions/usage-api-requests.md @@ -1 +1 @@ -- **API requests** - You can execute up to {% ifversion ghec %}15,000{% else %}1,000{% endif %} requests to the GitHub API in an hour across all actions within a repository. If requests are exceeded, additional API calls will fail which might cause jobs to fail. +* **API requests** - You can execute up to {% ifversion ghec %}15,000{% else %}1,000{% endif %} requests to the GitHub API in an hour across all actions within a repository. If requests are exceeded, additional API calls will fail which might cause jobs to fail. diff --git a/data/reusables/actions/usage-workflow-queue-limits.md b/data/reusables/actions/usage-workflow-queue-limits.md index 17445af2fd..84e9a6252d 100644 --- a/data/reusables/actions/usage-workflow-queue-limits.md +++ b/data/reusables/actions/usage-workflow-queue-limits.md @@ -1 +1 @@ -- **Workflow run queue** - No more than 500 workflow runs can be queued in a 10 second interval per repository. If a workflow run reaches this limit, the workflow run is terminated and fails to complete. +* **Workflow run queue** - No more than 500 workflow runs can be queued in a 10 second interval per repository. If a workflow run reaches this limit, the workflow run is terminated and fails to complete. diff --git a/data/reusables/actions/usage-workflow-run-time.md b/data/reusables/actions/usage-workflow-run-time.md index 9d41c4d993..92d70582df 100644 --- a/data/reusables/actions/usage-workflow-run-time.md +++ b/data/reusables/actions/usage-workflow-run-time.md @@ -1 +1 @@ -- **Workflow run time** - Each workflow run is limited to 35 days. If a workflow run reaches this limit, the workflow run is cancelled. This period includes execution duration, and time spent on waiting and approval. +* **Workflow run time** - Each workflow run is limited to 35 days. If a workflow run reaches this limit, the workflow run is cancelled. This period includes execution duration, and time spent on waiting and approval. diff --git a/data/reusables/actions/workflows-from-public-fork-setting.md b/data/reusables/actions/workflows-from-public-fork-setting.md index c06d933f42..6d8fea6f62 100644 --- a/data/reusables/actions/workflows-from-public-fork-setting.md +++ b/data/reusables/actions/workflows-from-public-fork-setting.md @@ -1,7 +1,7 @@ 1. Under **Fork pull request workflows from outside collaborators**, choose one of the options. - - **Require approval for first-time contributors who are new to {% data variables.product.prodname_dotcom %}**. This option requires approval to run workflows for users who have never committed to the repository and have new {% data variables.product.prodname_dotcom %} accounts. - - **Require approval for first-time contributors**. This option requires approval to run workflows for users who have never committed to the repository. - - **Require approval for all outside collaborators**. This option requires approval to run workflows for all users who are not repository collaborators. If the repository is owned by an organization, this option requires approval to run workflows for all repository collaborators who are not organization members. + * **Require approval for first-time contributors who are new to {% data variables.product.prodname_dotcom %}**. This option requires approval to run workflows for users who have never committed to the repository and have new {% data variables.product.prodname_dotcom %} accounts. + * **Require approval for first-time contributors**. This option requires approval to run workflows for users who have never committed to the repository. + * **Require approval for all outside collaborators**. This option requires approval to run workflows for all users who are not repository collaborators. If the repository is owned by an organization, this option requires approval to run workflows for all repository collaborators who are not organization members. 1. Click **Save** to apply the settings. diff --git a/data/reusables/actions/workflows/required-workflow-prerequisites.md b/data/reusables/actions/workflows/required-workflow-prerequisites.md index f1a95d0690..d61322cdd6 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)." -- 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. +* {% 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 %} -- 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. +* 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 d5869655eb..679cea2030 100644 --- a/data/reusables/actions/workflows/required-workflow-source-notes.md +++ b/data/reusables/actions/workflows/required-workflow-source-notes.md @@ -1,11 +1,11 @@ -- 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 %}." -- 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)." +* 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 %}." +* 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)." {% 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. -- If you want to allow direct pushes for a particular repository, you must remove the repository as a target from respective required workflows. +* 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. +* If you want to allow direct pushes for a particular repository, you must remove the repository as a target from respective required workflows. {% endif %} -- Required workflows can be referenced using any branch, tag, or commit SHA from the repository containing the workflow file. +* Required workflows can be referenced using any branch, tag, or commit SHA from the repository containing the workflow file. {% endif %} diff --git a/data/reusables/actions/workflows/required-workflow-target-notes.md b/data/reusables/actions/workflows/required-workflow-target-notes.md index 67a8c84062..036011837c 100644 --- a/data/reusables/actions/workflows/required-workflow-target-notes.md +++ b/data/reusables/actions/workflows/required-workflow-target-notes.md @@ -1,3 +1,3 @@ -- When configuring a required workflow to run on all or selected repositories, the visibility of the repository containing the required workflow will affect which repositories in your organization the workflow runs on. Required workflows stored in public repositories will run on all repositories. Required workflows stored in private repositories will only run on other private repositories. {% ifversion ghes or ghec %} Required workflows stored in internal repositories will run on internal and private repositories.{% endif %} -- Required workflows cannot be configured to run in the repository the workflow is created in. You should consider creating a separate repository to store your required workflows. -- When configuring a required workflow to run on all or selected repositories, required workflows will not run in repositories where actions is disabled in the organization settings. +* When configuring a required workflow to run on all or selected repositories, the visibility of the repository containing the required workflow will affect which repositories in your organization the workflow runs on. Required workflows stored in public repositories will run on all repositories. Required workflows stored in private repositories will only run on other private repositories. {% ifversion ghes or ghec %} Required workflows stored in internal repositories will run on internal and private repositories.{% endif %} +* Required workflows cannot be configured to run in the repository the workflow is created in. You should consider creating a separate repository to store your required workflows. +* When configuring a required workflow to run on all or selected repositories, required workflows will not run in repositories where actions is disabled in the organization settings. diff --git a/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md b/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md index ee15d3c374..328c5d6929 100644 --- a/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md +++ b/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md @@ -13,11 +13,11 @@ The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glo The patterns defined in `branches` and `tags` are evaluated against the Git ref's name. For example, the following workflow would run whenever there is a `push` event to: -- A branch named `main` (`refs/heads/main`) -- A branch named `mona/octocat` (`refs/heads/mona/octocat`) -- A branch whose name starts with `releases/`, like `releases/10` (`refs/heads/releases/10`) -- A tag named `v2` (`refs/tags/v2`) -- A tag whose name starts with `v1.`, like `v1.9.1` (`refs/tags/v1.9.1`) +* A branch named `main` (`refs/heads/main`) +* A branch named `mona/octocat` (`refs/heads/mona/octocat`) +* A branch whose name starts with `releases/`, like `releases/10` (`refs/heads/releases/10`) +* A tag named `v2` (`refs/tags/v2`) +* A tag whose name starts with `v1.`, like `v1.9.1` (`refs/tags/v1.9.1`) ```yaml on: @@ -37,10 +37,10 @@ on: When a pattern matches the `branches-ignore` or `tags-ignore` pattern, the workflow will not run. The patterns defined in `branches` and `tags` are evaluated against the Git ref's name. For example, the following workflow would run whenever there is a `push` event, unless the `push` event is to: -- A branch named `mona/octocat` (`refs/heads/mona/octocat`) -- A branch whose name matches `releases/**-alpha`, like `releases/beta/3-alpha` (`refs/heads/releases/beta/3-alpha`) -- A tag named `v2` (`refs/tags/v2`) -- A tag whose name starts with `v1.`, like `v1.9` (`refs/tags/v1.9`) +* A branch named `mona/octocat` (`refs/heads/mona/octocat`) +* A branch whose name matches `releases/**-alpha`, like `releases/beta/3-alpha` (`refs/heads/releases/beta/3-alpha`) +* A tag named `v2` (`refs/tags/v2`) +* A tag whose name starts with `v1.`, like `v1.9` (`refs/tags/v1.9`) ```yaml on: @@ -63,8 +63,8 @@ If you define a branch with the `!` character, you must also define at least one The order that you define patterns matters. -- A matching negative pattern (prefixed with `!`) after a positive match will exclude the Git ref. -- A matching positive pattern after a negative match will include the Git ref again. +* A matching negative pattern (prefixed with `!`) after a positive match will exclude the Git ref. +* A matching positive pattern after a negative match will include the Git ref again. The following workflow will run on pushes to `releases/10` or `releases/beta/mona`, but not on `releases/10-alpha` or `releases/beta/3-alpha` because the negative pattern `!releases/**-alpha` follows the positive pattern. diff --git a/data/reusables/actions/workflows/section-specifying-branches.md b/data/reusables/actions/workflows/section-specifying-branches.md index 3d225ada01..f5f495e187 100644 --- a/data/reusables/actions/workflows/section-specifying-branches.md +++ b/data/reusables/actions/workflows/section-specifying-branches.md @@ -29,8 +29,8 @@ You cannot use both the `branches` and `branches-ignore` filters for the same ev The order that you define patterns matters. -- A matching negative pattern (prefixed with `!`) after a positive match will exclude the branch. -- A matching positive pattern after a negative match will include the branch again. +* A matching negative pattern (prefixed with `!`) after a positive match will exclude the branch. +* A matching positive pattern after a negative match will include the branch again. For example, a workflow with the following trigger will run when the workflow named `Build` runs on a branch that is named `releases/10` or `releases/beta/mona` but will not `releases/10-alpha`, `releases/beta/3-alpha`, or `main`. diff --git a/data/reusables/actions/workflows/section-triggering-a-workflow-branches.md b/data/reusables/actions/workflows/section-triggering-a-workflow-branches.md index f050aec557..4acdcc3abc 100644 --- a/data/reusables/actions/workflows/section-triggering-a-workflow-branches.md +++ b/data/reusables/actions/workflows/section-triggering-a-workflow-branches.md @@ -10,9 +10,9 @@ The `branches` and `branches-ignore` keywords accept glob patterns that use char The patterns defined in `branches` are evaluated against the Git ref's name. For example, the following workflow would run whenever there is a `pull_request` event for a pull request targeting: -- A branch named `main` (`refs/heads/main`) -- A branch named `mona/octocat` (`refs/heads/mona/octocat`) -- A branch whose name starts with `releases/`, like `releases/10` (`refs/heads/releases/10`) +* A branch named `main` (`refs/heads/main`) +* A branch named `mona/octocat` (`refs/heads/mona/octocat`) +* A branch whose name starts with `releases/`, like `releases/10` (`refs/heads/releases/10`) ```yaml on: @@ -32,8 +32,8 @@ If a workflow is skipped due to branch filtering, [path filtering](/actions/usin When a pattern matches the `branches-ignore` pattern, the workflow will not run. The patterns defined in `branches-ignore` are evaluated against the Git ref's name. For example, the following workflow would run whenever there is a `pull_request` event unless the pull request is targeting: -- A branch named `mona/octocat` (`refs/heads/mona/octocat`) -- A branch whose name matches `releases/**-alpha`, like `releases/beta/3-alpha` (`refs/heads/releases/beta/3-alpha`) +* A branch named `mona/octocat` (`refs/heads/mona/octocat`) +* A branch whose name matches `releases/**-alpha`, like `releases/beta/3-alpha` (`refs/heads/releases/beta/3-alpha`) ```yaml on: @@ -52,8 +52,8 @@ If you define a branch with the `!` character, you must also define at least one The order that you define patterns matters. -- A matching negative pattern (prefixed with `!`) after a positive match will exclude the Git ref. -- A matching positive pattern after a negative match will include the Git ref again. +* A matching negative pattern (prefixed with `!`) after a positive match will exclude the Git ref. +* A matching positive pattern after a negative match will include the Git ref again. The following workflow will run on `pull_request` events for pull requests that target `releases/10` or `releases/beta/mona`, but not for pull requests that target `releases/10-alpha` or `releases/beta/3-alpha` because the negative pattern `!releases/**-alpha` follows the positive pattern. diff --git a/data/reusables/actions/workflows/section-triggering-a-workflow-paths.md b/data/reusables/actions/workflows/section-triggering-a-workflow-paths.md index 90d37d7a3a..bf8e1d7f13 100644 --- a/data/reusables/actions/workflows/section-triggering-a-workflow-paths.md +++ b/data/reusables/actions/workflows/section-triggering-a-workflow-paths.md @@ -7,8 +7,8 @@ Use the `paths` filter when you want to include file path patterns or when you w **Note:** The order that you define `paths` patterns matters: -- A matching negative pattern (prefixed with `!`) after a positive match will exclude the path. -- A matching positive pattern after a negative match will include the path again. +* A matching negative pattern (prefixed with `!`) after a positive match will exclude the path. +* A matching positive pattern after a negative match will include the path again. {% endnote %} @@ -52,8 +52,8 @@ If you define a path with the `!` character, you must also define at least one p The order that you define `paths` patterns matters: -- A matching negative pattern (prefixed with `!`) after a positive match will exclude the path. -- A matching positive pattern after a negative match will include the path again. +* A matching negative pattern (prefixed with `!`) after a positive match will exclude the path. +* A matching positive pattern after a negative match will include the path again. This example runs anytime the `push` event includes a file in the `sub-project` directory or its subdirectories, unless the file is in the `sub-project/docs` directory. For example, a push that changed `sub-project/index.js` or `sub-project/src/index.js` will trigger a workflow run, but a push changing only `sub-project/docs/readme.md` will not. @@ -76,9 +76,9 @@ on: The filter determines if a workflow should run by evaluating the changed files and running them against the `paths-ignore` or `paths` list. If there are no files changed, the workflow will not run. {% data variables.product.prodname_dotcom %} generates the list of changed files using two-dot diffs for pushes and three-dot diffs for pull requests: -- **Pull requests:** Three-dot diffs are a comparison between the most recent version of the topic branch and the commit where the topic branch was last synced with the base branch. -- **Pushes to existing branches:** A two-dot diff compares the head and base SHAs directly with each other. -- **Pushes to new branches:** A two-dot diff against the parent of the ancestor of the deepest commit pushed. +* **Pull requests:** Three-dot diffs are a comparison between the most recent version of the topic branch and the commit where the topic branch was last synced with the base branch. +* **Pushes to existing branches:** A two-dot diff compares the head and base SHAs directly with each other. +* **Pushes to new branches:** A two-dot diff against the parent of the ancestor of the deepest commit pushed. 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. diff --git a/data/reusables/advanced-security/secret-scanning-dry-run-select-repos.md b/data/reusables/advanced-security/secret-scanning-dry-run-select-repos.md index 944059953b..0d58fa715f 100644 --- a/data/reusables/advanced-security/secret-scanning-dry-run-select-repos.md +++ b/data/reusables/advanced-security/secret-scanning-dry-run-select-repos.md @@ -1,7 +1,7 @@ {%- ifversion custom-pattern-dry-run-ga %} 1. Select the repositories where you want to perform the dry run. - - To perform the dry run across the entire organization, select **All repositories in the organization**. - - To specify the repositories where you want to perform the dry run, select **Selected repositories**, then search for and select up to 10 repositories. + * To perform the dry run across the entire organization, select **All repositories in the organization**. + * To specify the repositories where you want to perform the dry run, select **Selected repositories**, then search for and select up to 10 repositories. 1. When you're ready to test your new custom pattern, click **Run**. {%- else %} 1. Search for and select up to 10 repositories where you want to perform the dry run. diff --git a/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md b/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md index 740a125cc9..1e3077644a 100644 --- a/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md +++ b/data/reusables/advanced-security/secret-scanning-enable-push-protection-custom-pattern.md @@ -3,8 +3,8 @@ {% note %} **Note:** - - Push protection for custom patterns will only apply to repositories that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information about enabling push protection, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." - - Enabling push protection for commonly found custom patterns can be disruptive to contributors. + * Push protection for custom patterns will only apply to repositories that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information about enabling push protection, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + * Enabling push protection for commonly found custom patterns can be disruptive to contributors. {% endnote %} diff --git a/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md b/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md index 4ebc74a21c..d3185001c9 100644 --- a/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md +++ b/data/reusables/advanced-security/secret-scanning-generate-regular-expression-custom-pattern.md @@ -8,11 +8,11 @@ {% endnote %} 1. In the sliding panel that is displayed: - - Complete the "I want a regular expression that" field, describing, ideally in plain English, what patterns you want your regular expression to capture. You can use other natural languages, but the performance may not be as good as with English. - - Complete the "Examples of what I'm looking for" field, giving an example of a pattern you want to scan for. - - Click **Generate suggestions**. - - Optionally, click on a suggestion to view a description of the regular expression. - - Click **Use results** in the Results section that appears, for the result you want to use. + * Complete the "I want a regular expression that" field, describing, ideally in plain English, what patterns you want your regular expression to capture. You can use other natural languages, but the performance may not be as good as with English. + * Complete the "Examples of what I'm looking for" field, giving an example of a pattern you want to scan for. + * Click **Generate suggestions**. + * Optionally, click on a suggestion to view a description of the regular expression. + * Click **Use results** in the Results section that appears, for the result you want to use. ![Screenshot of a filled custom {% data variables.product.prodname_secret_scanning %} pattern form for the generator to use.](/assets/images/help/repository/secret-scanning-use-regular-expression-generator.png) diff --git a/data/reusables/apps/app-services.md b/data/reusables/apps/app-services.md index 0fa0db299a..c11e518d24 100644 --- a/data/reusables/apps/app-services.md +++ b/data/reusables/apps/app-services.md @@ -1,5 +1,5 @@ If your app uses third-party services, they should be used in a secure manner: -- Any services used by your app should have a unique login and password. -- Apps should not share service accounts such as email or database services to manage your SaaS service. -- Only employees with administrative duties should have admin access to the infrastructure that hosts your app. +* Any services used by your app should have a unique login and password. +* Apps should not share service accounts such as email or database services to manage your SaaS service. +* Only employees with administrative duties should have admin access to the infrastructure that hosts your app. diff --git a/data/reusables/apps/apps-logging.md b/data/reusables/apps/apps-logging.md index d07ba9fcf0..0050086061 100644 --- a/data/reusables/apps/apps-logging.md +++ b/data/reusables/apps/apps-logging.md @@ -1,9 +1,9 @@ Consider adding logging and monitoring capabilities for your app. A security log could include: -- Authentication and authorization events -- Service configuration changes -- Object reads and writes -- User and group permission changes -- Elevation of role to admin +* Authentication and authorization events +* Service configuration changes +* Object reads and writes +* User and group permission changes +* Elevation of role to admin Your logs should use consistent timestamping for each event and should record the users, IP addresses, or hostnames for all logged events. diff --git a/data/reusables/apps/settings-step.md b/data/reusables/apps/settings-step.md index 8e626e21f5..d6c42a7720 100644 --- a/data/reusables/apps/settings-step.md +++ b/data/reusables/apps/settings-step.md @@ -1,6 +1,6 @@ 1. In the upper-right corner of any page on {% data variables.product.prodname_dotcom %}, click your profile photo. 1. Navigate to your account settings. - - For an app owned by a personal account, click **Settings**. - - For an app owned by an organization: + * For an app owned by a personal account, click **Settings**. + * For an app owned by an organization: 1. Click **Your organizations**. 1. To the right of the organization, click **Settings**. diff --git a/data/reusables/audit_log/audit-log-api-info.md b/data/reusables/audit_log/audit-log-api-info.md index 2270c1b712..e0b688d768 100644 --- a/data/reusables/audit_log/audit-log-api-info.md +++ b/data/reusables/audit_log/audit-log-api-info.md @@ -1,6 +1,6 @@ -- Access to your organization or repository settings -- Changes in permissions -- Added or removed users in an organization, repository, or team -- Users being promoted to admin -- Changes to permissions of a {% data variables.product.prodname_github_app %}{% ifversion ghec %} -- API requests (must be enabled){% endif %} +* Access to your organization or repository settings +* Changes in permissions +* Added or removed users in an organization, repository, or team +* Users being promoted to admin +* Changes to permissions of a {% data variables.product.prodname_github_app %}{% ifversion ghec %} +* API requests (must be enabled){% endif %} diff --git a/data/reusables/audit_log/audit-log-search-by-operation.md b/data/reusables/audit_log/audit-log-search-by-operation.md index 3cd5bcd31e..df651af850 100644 --- a/data/reusables/audit_log/audit-log-search-by-operation.md +++ b/data/reusables/audit_log/audit-log-search-by-operation.md @@ -2,10 +2,10 @@ Use the `operation` qualifier to limit actions to specific types of operations. For example: -- `operation:access` finds all events where a resource was accessed. -- `operation:authentication` finds all events where an authentication event was performed. -- `operation:create` finds all events where a resource was created. -- `operation:modify` finds all events where an existing resource was modified. -- `operation:remove` finds all events where an existing resource was removed. -- `operation:restore` finds all events where an existing resource was restored. -- `operation:transfer` finds all events where an existing resource was transferred. +* `operation:access` finds all events where a resource was accessed. +* `operation:authentication` finds all events where an authentication event was performed. +* `operation:create` finds all events where a resource was created. +* `operation:modify` finds all events where an existing resource was modified. +* `operation:remove` finds all events where an existing resource was removed. +* `operation:restore` finds all events where an existing resource was restored. +* `operation:transfer` finds all events where an existing resource was transferred. diff --git a/data/reusables/audit_log/audit-log-search-by-repo.md b/data/reusables/audit_log/audit-log-search-by-repo.md index e37783b24e..7b29ace5f8 100644 --- a/data/reusables/audit_log/audit-log-search-by-repo.md +++ b/data/reusables/audit_log/audit-log-search-by-repo.md @@ -3,15 +3,15 @@ Use the `repo` qualifier to limit actions to a specific repository. For example: {%- ifversion ghes %} -- `repo:"my-org/our-repo"` finds all events that occurred for the `our-repo` repository in the `my-org` organization. -- `repo:"my-org/our-repo" repo:"my-org/another-repo"` finds all events that occurred for both the `our-repo` and `another-repo` repositories in the `my-org` organization. -- `-repo:"my-org/not-this-repo"` excludes all events that occurred for the `not-this-repo` repository in the `my-org` organization. +* `repo:"my-org/our-repo"` finds all events that occurred for the `our-repo` repository in the `my-org` organization. +* `repo:"my-org/our-repo" repo:"my-org/another-repo"` finds all events that occurred for both the `our-repo` and `another-repo` repositories in the `my-org` organization. +* `-repo:"my-org/not-this-repo"` excludes all events that occurred for the `not-this-repo` repository in the `my-org` organization. Note that you must include the account name within the `repo` qualifier and put it in quotes or escape the `/` with a `\`; searching for just `repo:our-repo` or `repo:my-org/our-repo` will not work.{% endif %} {%- ifversion ghec or fpt %} -- `repo:my-org/our-repo` finds all events that occurred for the `our-repo` repository in the `my-org` organization. -- `repo:my-org/our-repo repo:my-org/another-repo` finds all events that occurred for both the `our-repo` and `another-repo` repositories in the `my-org` organization. -- `-repo:my-org/not-this-repo` excludes all events that occurred for the `not-this-repo` repository in the `my-org` organization. +* `repo:my-org/our-repo` finds all events that occurred for the `our-repo` repository in the `my-org` organization. +* `repo:my-org/our-repo repo:my-org/another-repo` finds all events that occurred for both the `our-repo` and `another-repo` repositories in the `my-org` organization. +* `-repo:my-org/not-this-repo` excludes all events that occurred for the `not-this-repo` repository in the `my-org` organization. Note that you must include the account name within the `repo` qualifier; searching for just `repo:our-repo` will not work.{% endif %} diff --git a/data/reusables/audit_log/audit-log-search-by-user.md b/data/reusables/audit_log/audit-log-search-by-user.md index 4b9ce3ad5e..cf6eeec496 100644 --- a/data/reusables/audit_log/audit-log-search-by-user.md +++ b/data/reusables/audit_log/audit-log-search-by-user.md @@ -2,8 +2,8 @@ The `actor` qualifier can scope events based on who performed the action. For example: -- `actor:octocat` finds all events performed by `octocat`. -- `actor:octocat actor:hubot` finds all events performed by `octocat` or `hubot`. -- `-actor:hubot` excludes all events performed by `hubot`. +* `actor:octocat` finds all events performed by `octocat`. +* `actor:octocat actor:hubot` finds all events performed by `octocat` or `hubot`. +* `-actor:hubot` excludes all events performed by `hubot`. Note that you can only use a {% data variables.product.product_name %} username, not an individual's real name. diff --git a/data/reusables/audit_log/audit-log-search-list-info-about-action.md b/data/reusables/audit_log/audit-log-search-list-info-about-action.md index 95d497898a..6623d67018 100644 --- a/data/reusables/audit_log/audit-log-search-list-info-about-action.md +++ b/data/reusables/audit_log/audit-log-search-list-info-about-action.md @@ -2,19 +2,19 @@ Each audit log entry shows applicable information about an event, such as: -- The {% ifversion ghec or ghes %}enterprise or {% endif %}organization an action was performed in -- The user (actor) who performed the action -- The user affected by the action -- Which repository an action was performed in -- The action that was performed -- Which country the action took place in -- The date and time the action occurred +* The {% ifversion ghec or ghes %}enterprise or {% endif %}organization an action was performed in +* The user (actor) who performed the action +* The user affected by the action +* Which repository an action was performed in +* The action that was performed +* Which country the action took place in +* The date and time the action occurred {%- ifversion ghec or ghes > 3.12 %} -- The SAML SSO and SCIM identity of the user (actor) who performed the action +* The SAML SSO and SCIM identity of the user (actor) who performed the action {%- endif %} {%- ifversion token-audit-log %} -- For actions outside of the web UI, how the user (actor) authenticated +* For actions outside of the web UI, how the user (actor) authenticated {%- endif %} {%- ifversion enterprise-audit-log-ip-addresses %} -- Optionally, the source IP address for the user (actor) who performed the action +* Optionally, the source IP address for the user (actor) who performed the action {%- endif %} diff --git a/data/reusables/audit_log/authentication-methods-with-metadata.md b/data/reusables/audit_log/authentication-methods-with-metadata.md index eb1d378160..0d4e81704f 100644 --- a/data/reusables/audit_log/authentication-methods-with-metadata.md +++ b/data/reusables/audit_log/authentication-methods-with-metadata.md @@ -1,11 +1,11 @@ Token data appears in the audit log for the following authentication methods. -- {% data variables.product.pat_generic_caps %} -- OAuth token -- {% data variables.product.prodname_github_apps %} (authentication as an app installation or on behalf of a user) +* {% data variables.product.pat_generic_caps %} +* OAuth token +* {% data variables.product.prodname_github_apps %} (authentication as an app installation or on behalf of a user) {%- ifversion token-audit-log-more-metadata %} -- Deploy key -- SSH key +* Deploy key +* SSH key {% note %} diff --git a/data/reusables/audit_log/searching-for-associated-events.md b/data/reusables/audit_log/searching-for-associated-events.md index 52f8e8bcaa..37429dbe4b 100644 --- a/data/reusables/audit_log/searching-for-associated-events.md +++ b/data/reusables/audit_log/searching-for-associated-events.md @@ -1,8 +1,8 @@ To identify events associated with a specific token, you can use the UI or REST API. {% ifversion token-audit-log-more-metadata %}To identify Git events, you'll need to export the events from the audit log.{% endif %} To identify any events, you will need to know the SHA-256 hash of the token first. -- [Generating a SHA-256 hash value for a token](#generating-a-sha-256-hash-value-for-a-token) -- [Searching on {% data variables.product.prodname_dotcom %}](#searching-on-github) -- [Searching with the REST API](#searching-with-the-rest-api) +* [Generating a SHA-256 hash value for a token](#generating-a-sha-256-hash-value-for-a-token) +* [Searching on {% data variables.product.prodname_dotcom %}](#searching-on-github) +* [Searching with the REST API](#searching-with-the-rest-api) {%- ifversion token-audit-log-more-metadata %} -- [Identifying Git events](#identifying-git-events) +* [Identifying Git events](#identifying-git-events) {%- endif %} diff --git a/data/reusables/billing/license-statuses.md b/data/reusables/billing/license-statuses.md index 0ff8dedd42..c08fb065fc 100644 --- a/data/reusables/billing/license-statuses.md +++ b/data/reusables/billing/license-statuses.md @@ -1,6 +1,6 @@ {% ifversion ghec %} If your license includes {% data variables.visual_studio.prodname_vss_ghe %}, you can identify whether a user account on {% data variables.product.prodname_dotcom_the_website %} has successfully matched with a {% data variables.product.prodname_vs %} subscriber by downloading the CSV file that contains additional license details. The license status will be one of the following. -- "Matched": The user account on {% data variables.product.prodname_dotcom_the_website %} is linked with a {% data variables.product.prodname_vs %} subscriber. -- "Pending Invitation": An invitation was sent to a {% data variables.product.prodname_vs %} subscriber, but the subscriber has not accepted the invitation. -- Blank: There is no {% data variables.product.prodname_vs %} association to consider for the user account on {% data variables.product.prodname_dotcom_the_website %}. +* "Matched": The user account on {% data variables.product.prodname_dotcom_the_website %} is linked with a {% data variables.product.prodname_vs %} subscriber. +* "Pending Invitation": An invitation was sent to a {% data variables.product.prodname_vs %} subscriber, but the subscriber has not accepted the invitation. +* Blank: There is no {% data variables.product.prodname_vs %} association to consider for the user account on {% data variables.product.prodname_dotcom_the_website %}. {% endif %} diff --git a/data/reusables/classroom/assignments-guide-create-the-assignment.md b/data/reusables/classroom/assignments-guide-create-the-assignment.md index def07051f6..a45236403e 100644 --- a/data/reusables/classroom/assignments-guide-create-the-assignment.md +++ b/data/reusables/classroom/assignments-guide-create-the-assignment.md @@ -1,5 +1,5 @@ 1. Sign into {% data variables.product.prodname_classroom_with_url %}. 1. Navigate to a classroom. 1. In the {% octicon "repo" aria-hidden="true" %} **Assignments** tab, create the assignment. - - If this your first assignment, click **Create an assignment**. - - Otherwise, click **New assignment** on the right side. + * If this your first assignment, click **Create an assignment**. + * Otherwise, click **New assignment** on the right side. diff --git a/data/reusables/classroom/assignments-guide-protected-paths.md b/data/reusables/classroom/assignments-guide-protected-paths.md index ce3f9cfae1..3fd5a300db 100644 --- a/data/reusables/classroom/assignments-guide-protected-paths.md +++ b/data/reusables/classroom/assignments-guide-protected-paths.md @@ -2,8 +2,8 @@ If your assignment has files or directories that are used in the grading process The patterns for protected paths follow rules similar to shell filename globs. It may contain the following meta-characters: -- `*`: Matches any file. For example, `*` matches all regular files, `foo*` matches all files beginning with `foo`, `*foo` matches all files ending with `foo`, and `*foo*` matches all files whose names contain `foo` (including at the beginning or end) -- `**`: Matches directories recursively or files expansively. For example, `.github/**/*` will match all files in `.github` and any of its subdirectories -- `?`: Matches any one character -- `[set]`: Matches any one character in `set`(including sets like `a-z`) -- `\`: Escapes the next meta-character +* `*`: Matches any file. For example, `*` matches all regular files, `foo*` matches all files beginning with `foo`, `*foo` matches all files ending with `foo`, and `*foo*` matches all files whose names contain `foo` (including at the beginning or end) +* `**`: Matches directories recursively or files expansively. For example, `.github/**/*` will match all files in `.github` and any of its subdirectories +* `?`: Matches any one character +* `[set]`: Matches any one character in `set`(including sets like `a-z`) +* `\`: Escapes the next meta-character diff --git a/data/reusables/classroom/supported-lmses.md b/data/reusables/classroom/supported-lmses.md index c9e4d30708..51edba64dc 100644 --- a/data/reusables/classroom/supported-lmses.md +++ b/data/reusables/classroom/supported-lmses.md @@ -1,16 +1,16 @@ {% data variables.product.prodname_classroom %} supports connecting with LMSes that implement Learning Tools Interoperability (LTI) standards. -- LTI version 1.3 -- LTI Advantage +* LTI version 1.3 +* LTI Advantage Using LTI helps keep your information safe and secure. LTI is an industry-standard protocol and GitHub Classroom's use of LTI is certified by the Instructional Management System (IMS) Global Learning Consortium. For more information, see [Learning Tools Interoperability](https://www.imsglobal.org/activity/learning-tools-interoperability) and [About IMS Global Learning Consortium](https://www.imsglobal.org/aboutims.html) on the IMS Global Learning Consortium website. {% data variables.product.company_short %} has tested and verified registration, connection and the import of roster data from the following LMSes into {% data variables.product.prodname_classroom %}. -- Canvas -- Moodle -- Sakai -- Google Classroom +* Canvas +* Moodle +* Sakai +* Google Classroom {% note %} diff --git a/data/reusables/cli/cli-features.md b/data/reusables/cli/cli-features.md index 4a7d0c526b..d89b21f379 100644 --- a/data/reusables/cli/cli-features.md +++ b/data/reusables/cli/cli-features.md @@ -1,10 +1,10 @@ {% data variables.product.prodname_cli %} includes {% data variables.product.prodname_dotcom %} features such as: -- View, create, clone, and fork repositories -- Create, close, edit, and view issues and pull requests -- Review, diff, and merge pull requests -- Run, view, and list workflows -- Create, list, view, and delete releases -- Create, edit, list, view, and delete gists{% ifversion fpt %} -- List, create, delete, and connect to a codespace{% endif %} -- Retrieve information from the {% data variables.product.prodname_dotcom %} API +* View, create, clone, and fork repositories +* Create, close, edit, and view issues and pull requests +* Review, diff, and merge pull requests +* Run, view, and list workflows +* Create, list, view, and delete releases +* Create, edit, list, view, and delete gists{% ifversion fpt %} +* List, create, delete, and connect to a codespace{% endif %} +* Retrieve information from the {% data variables.product.prodname_dotcom %} API diff --git a/data/reusables/code-scanning/autobuild-add-build-steps.md b/data/reusables/code-scanning/autobuild-add-build-steps.md index 1da1dc3cc4..18361fa9e7 100644 --- a/data/reusables/code-scanning/autobuild-add-build-steps.md +++ b/data/reusables/code-scanning/autobuild-add-build-steps.md @@ -1,6 +1,6 @@ If `autobuild` fails, or you want to analyze a different set of source files from those built by the `autobuild` process, you'll need to {% ifversion codeql-no-build %}do the following: -- If your workflow specifies a build mode for the language, change the build mode to `manual`. -- If your workflow contains an `autobuild` step, remove or comment out the `autobuild` step in the workflow. +* If your workflow specifies a build mode for the language, change the build mode to `manual`. +* If your workflow contains an `autobuild` step, remove or comment out the `autobuild` step in the workflow. {% else %}remove or comment out the autobuild step in the workflow.{% endif %} Then uncomment the `run` step and manually specify the build process to use. For {% data variables.code-scanning.compiled_languages %}, {% data variables.product.prodname_codeql %} will analyze whatever source code is built by your specified build steps. diff --git a/data/reusables/code-scanning/beta-swift-support.md b/data/reusables/code-scanning/beta-swift-support.md index 463ad48a45..4e6cc5cf13 100644 --- a/data/reusables/code-scanning/beta-swift-support.md +++ b/data/reusables/code-scanning/beta-swift-support.md @@ -2,7 +2,7 @@ {% note %} **Notes:** -- {% data variables.product.prodname_codeql %} analysis for Swift is currently in beta. During the beta, analysis of Swift code, and the accompanying documentation, will not be as comprehensive as for other languages. +* {% data variables.product.prodname_codeql %} analysis for Swift is currently in beta. During the beta, analysis of Swift code, and the accompanying documentation, will not be as comprehensive as for other languages. {% endnote %} {% endif %} diff --git a/data/reusables/code-scanning/codeql-languages-bullets.md b/data/reusables/code-scanning/codeql-languages-bullets.md index fe66207a30..866b735076 100644 --- a/data/reusables/code-scanning/codeql-languages-bullets.md +++ b/data/reusables/code-scanning/codeql-languages-bullets.md @@ -1,11 +1,11 @@ -- C/C++ -- C# -- Go -- Java{% ifversion codeql-kotlin-beta %}/Kotlin{% endif %} -- JavaScript/TypeScript -- Python -- Ruby +* C/C++ +* C# +* Go +* Java{% ifversion codeql-kotlin-beta %}/Kotlin{% endif %} +* JavaScript/TypeScript +* Python +* Ruby {% ifversion codeql-swift-beta %}- Swift{% endif %} {% note %} @@ -13,11 +13,11 @@ **Notes**: {% ifversion codeql-swift-beta %} -- {% data variables.product.prodname_codeql %} analysis for Swift is currently in beta. During the beta, analysis of Swift will be less comprehensive than {% data variables.product.prodname_codeql %} analysis of other languages. Additionally, Swift 5.8 is not yet supported.{% endif %} +* {% data variables.product.prodname_codeql %} analysis for Swift is currently in beta. During the beta, analysis of Swift will be less comprehensive than {% data variables.product.prodname_codeql %} analysis of other languages. Additionally, Swift 5.8 is not yet supported.{% endif %} {% ifversion codeql-kotlin-beta %} -- {% data variables.product.prodname_codeql %} analysis for Kotlin is currently in beta. During the beta, analysis of Kotlin will be less comprehensive than {% data variables.product.prodname_codeql %} analysis of other languages. -- Use {% ifversion codeql-language-identifiers-311 %}`java-kotlin`{% else %}`java`{% endif %} to analyze code written in Java, Kotlin or both.{% endif %} -- Use {% ifversion codeql-language-identifiers-311 %}`javascript-typescript`{% else %}`javascript`{% endif %} to analyze code written in JavaScript, TypeScript or both. +* {% data variables.product.prodname_codeql %} analysis for Kotlin is currently in beta. During the beta, analysis of Kotlin will be less comprehensive than {% data variables.product.prodname_codeql %} analysis of other languages. +* Use {% ifversion codeql-language-identifiers-311 %}`java-kotlin`{% else %}`java`{% endif %} to analyze code written in Java, Kotlin or both.{% endif %} +* Use {% ifversion codeql-language-identifiers-311 %}`javascript-typescript`{% else %}`javascript`{% endif %} to analyze code written in JavaScript, TypeScript or both. {% endnote %} diff --git a/data/reusables/code-scanning/codeql-license.md b/data/reusables/code-scanning/codeql-license.md index ada9c39bdb..2aa6238971 100644 --- a/data/reusables/code-scanning/codeql-license.md +++ b/data/reusables/code-scanning/codeql-license.md @@ -4,16 +4,16 @@ {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_codeql %} is licensed on a per-user basis. Under the license restrictions, you can use {% data variables.product.prodname_codeql %} to perform the following tasks: -- To perform academic research. -- To demonstrate the software. -- To test {% data variables.product.prodname_codeql %} queries that are released under an OSI-approved License to confirm that new versions of those queries continue to find the right vulnerabilities. +* To perform academic research. +* To demonstrate the software. +* To test {% data variables.product.prodname_codeql %} queries that are released under an OSI-approved License to confirm that new versions of those queries continue to find the right vulnerabilities. Where "OSI-approved License" means an Open Source Initiative (OSI)-approved open source software license. If you are working with an Open Source Codebase (that is, a codebase that is released under an OSI-approved License) you can also use {% data variables.product.prodname_codeql %} for the following tasks: -- To perform analysis of the Open Source Codebase. -- If the Open Source Codebase is hosted and maintained on {% data variables.product.prodname_dotcom_the_website %}, to generate {% data variables.product.prodname_codeql %} databases for or during automated analysis, continuous integration, or continuous delivery. +* To perform analysis of the Open Source Codebase. +* If the Open Source Codebase is hosted and maintained on {% data variables.product.prodname_dotcom_the_website %}, to generate {% data variables.product.prodname_codeql %} databases for or during automated analysis, continuous integration, or continuous delivery. {% data variables.product.prodname_codeql %} can’t be used for automated analysis, continuous integration or continuous delivery, whether as part of normal software engineering processes or otherwise, except in the express cases set forth herein unless you have a license for {% data variables.product.prodname_GH_advanced_security %}. diff --git a/data/reusables/code-scanning/codeql-query-tables/links-to-all-tables.md b/data/reusables/code-scanning/codeql-query-tables/links-to-all-tables.md index 8d8473f5a2..839919974f 100644 --- a/data/reusables/code-scanning/codeql-query-tables/links-to-all-tables.md +++ b/data/reusables/code-scanning/codeql-query-tables/links-to-all-tables.md @@ -1,8 +1,8 @@ -- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries)" -- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries)" -- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries)" -- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries)" -- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries)" -- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries)" -- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries)" -- "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries)" +* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/c-cpp-built-in-queries)" +* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/csharp-built-in-queries)" +* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/go-built-in-queries)" +* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/java-kotlin-built-in-queries)" +* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/javascript-typescript-built-in-queries)" +* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/python-built-in-queries)" +* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/ruby-built-in-queries)" +* "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/swift-built-in-queries)" diff --git a/data/reusables/code-scanning/custom-security-configuration-enforcement-edge-cases.md b/data/reusables/code-scanning/custom-security-configuration-enforcement-edge-cases.md index 3c55851808..4aba6b68fe 100644 --- a/data/reusables/code-scanning/custom-security-configuration-enforcement-edge-cases.md +++ b/data/reusables/code-scanning/custom-security-configuration-enforcement-edge-cases.md @@ -1,7 +1,7 @@ > If a user in your organization attempts to change the enablement status of a feature in an enforced configuration using the REST API, the API call will appear to succeed, but no enablement statuses will change. > > Some situations can break the enforcement of {% data variables.product.prodname_security_configurations %} for a repository. For example, the enablement of {% data variables.product.prodname_code_scanning %} will not apply to a repository if: -> - {% data variables.product.prodname_actions %} is initially enabled on the repository, but is then disabled in the repository. -> - {% data variables.product.prodname_actions %} required by {% data variables.product.prodname_code_scanning %} configurations are not available in the repository.{% ifversion ghes %} -> - Self-hosted runners with the label `code-scanning` are not available.{% endif %} -> - The definition for which languages should not be analyzed using {% data variables.product.prodname_code_scanning %} default setup is changed. +> * {% data variables.product.prodname_actions %} is initially enabled on the repository, but is then disabled in the repository. +> * {% data variables.product.prodname_actions %} required by {% data variables.product.prodname_code_scanning %} configurations are not available in the repository.{% ifversion ghes %} +> * Self-hosted runners with the label `code-scanning` are not available.{% endif %} +> * The definition for which languages should not be analyzed using {% data variables.product.prodname_code_scanning %} default setup is changed. diff --git a/data/reusables/code-scanning/enabling-options.md b/data/reusables/code-scanning/enabling-options.md index e8f65baf0a..0c13aec193 100644 --- a/data/reusables/code-scanning/enabling-options.md +++ b/data/reusables/code-scanning/enabling-options.md @@ -1,2 +1,2 @@ -- **{% data variables.product.prodname_codeql %}**: Uses {% data variables.product.prodname_actions %} with either default setup (see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)") or advanced setup (see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-advanced-setup-for-code-scanning-with-codeql)"), or runs {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system)"). -- **Third‑party**: Uses {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %}(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-workflows)") {% endif %}or third-party tools and uploads results to {% data variables.product.product_name %} (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)"). +* **{% data variables.product.prodname_codeql %}**: Uses {% data variables.product.prodname_actions %} with either default setup (see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)") or advanced setup (see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning#configuring-advanced-setup-for-code-scanning-with-codeql)"), or runs {% data variables.product.prodname_codeql %} analysis in a third-party continuous integration (CI) system (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/using-code-scanning-with-your-existing-ci-system)"). +* **Third‑party**: Uses {% data variables.product.prodname_actions %} {% ifversion fpt or ghec %}(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-workflows)") {% endif %}or third-party tools and uploads results to {% data variables.product.product_name %} (see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)"). diff --git a/data/reusables/code-scanning/extractor-diagnostics.md b/data/reusables/code-scanning/extractor-diagnostics.md index 40ed789984..ea9f030380 100644 --- a/data/reusables/code-scanning/extractor-diagnostics.md +++ b/data/reusables/code-scanning/extractor-diagnostics.md @@ -1,4 +1,4 @@ Extractor diagnostics only cover files that were seen during the analysis, metrics include: -- Number of files successfully analyzed -- Number of files that generated extractor errors during database creation -- Number of files that generated extractor warnings during database creation +* Number of files successfully analyzed +* Number of files that generated extractor errors during database creation +* Number of files that generated extractor warnings during database creation diff --git a/data/reusables/code-scanning/licensing-note.md b/data/reusables/code-scanning/licensing-note.md index 0dfd9e902f..8dba7844cd 100644 --- a/data/reusables/code-scanning/licensing-note.md +++ b/data/reusables/code-scanning/licensing-note.md @@ -1,12 +1,12 @@ {% note %} **Notes:** {% ifversion fpt %} -- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +* The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories. The {% data variables.product.prodname_codeql_cli %} is also available in private repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." {%- elsif ghec %} -- The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." +* The {% data variables.product.prodname_codeql_cli %} is free to use on public repositories that are maintained on {% data variables.product.prodname_dotcom_the_website %}, and available to use on private repositories that are owned by customers with an {% data variables.product.prodname_advanced_security %} license. For information, see "[{% data variables.product.product_name %} {% data variables.product.prodname_codeql %} Terms and Conditions](https://securitylab.github.com/tools/codeql/license)" and "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." {%- elsif ghes %} -- The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. +* The {% data variables.product.prodname_codeql_cli %} is available to customers with an {% data variables.product.prodname_advanced_security %} license. {% endif %} -- {% data reusables.code-scanning.non-glibc-linux-support %} +* {% data reusables.code-scanning.non-glibc-linux-support %} {% endnote %} diff --git a/data/reusables/code-scanning/max-paths-setting.md b/data/reusables/code-scanning/max-paths-setting.md index 57abbe3338..d284a49ade 100644 --- a/data/reusables/code-scanning/max-paths-setting.md +++ b/data/reusables/code-scanning/max-paths-setting.md @@ -1,4 +1,4 @@ -- {% data variables.product.prodname_codeql %} advanced setup for {% data variables.product.prodname_code_scanning %}: update the `analyze` step to limit the number of paths to a maximum of one or zero. +* {% data variables.product.prodname_codeql %} advanced setup for {% data variables.product.prodname_code_scanning %}: update the `analyze` step to limit the number of paths to a maximum of one or zero. ```yaml - name: Perform CodeQL Analysis @@ -7,7 +7,7 @@ CODEQL_ACTION_EXTRA_OPTIONS: '{"database":{"interpret-results":["--max-paths", 1]}}' ``` -- {% data variables.product.prodname_codeql_cli %} `database analyze`: update the database analysis command to include the `--max-paths=1` flag. For more information, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-analyze#--max-pathsmaxpaths)." +* {% data variables.product.prodname_codeql_cli %} `database analyze`: update the database analysis command to include the `--max-paths=1` flag. For more information, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-analyze#--max-pathsmaxpaths)." {% note %} diff --git a/data/reusables/code-scanning/merge-protection-rulesets-conditions.md b/data/reusables/code-scanning/merge-protection-rulesets-conditions.md index d04d906825..51e5ea1c28 100644 --- a/data/reusables/code-scanning/merge-protection-rulesets-conditions.md +++ b/data/reusables/code-scanning/merge-protection-rulesets-conditions.md @@ -1,5 +1,5 @@ -- A required tool found a {% data variables.product.prodname_code_scanning %} alert of a severity that is defined in a ruleset. +* A required tool found a {% data variables.product.prodname_code_scanning %} alert of a severity that is defined in a ruleset. -- A required {% data variables.product.prodname_code_scanning %} tool's analysis is still in progress. +* A required {% data variables.product.prodname_code_scanning %} tool's analysis is still in progress. -- A required {% data variables.product.prodname_code_scanning %} tool is not configured for the repository. +* A required {% data variables.product.prodname_code_scanning %} tool is not configured for the repository. diff --git a/data/reusables/code-scanning/run-additional-queries.md b/data/reusables/code-scanning/run-additional-queries.md index 4e45517264..bcc64b7dd1 100644 --- a/data/reusables/code-scanning/run-additional-queries.md +++ b/data/reusables/code-scanning/run-additional-queries.md @@ -12,8 +12,8 @@ You can run extra queries if they are part of a {% data variables.product.prodna The options available to specify the additional queries you want to run are: -- `packs` to install one or more {% data variables.product.prodname_codeql %} query packs and run the default query suite or queries for those packs. -- `queries` to specify a single _.ql_ file, a directory containing multiple _.ql_ files, a _.qls_ query suite definition file, or any combination. For more information about query suite definitions, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/)." +* `packs` to install one or more {% data variables.product.prodname_codeql %} query packs and run the default query suite or queries for those packs. +* `queries` to specify a single _.ql_ file, a directory containing multiple _.ql_ files, a _.qls_ query suite definition file, or any combination. For more information about query suite definitions, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/)." You can use both `packs` and `queries` in the same workflow. diff --git a/data/reusables/code-scanning/summary-metrics.md b/data/reusables/code-scanning/summary-metrics.md index 4ec46b292f..7cc37d6e71 100644 --- a/data/reusables/code-scanning/summary-metrics.md +++ b/data/reusables/code-scanning/summary-metrics.md @@ -1,5 +1,5 @@ Summary metrics include: -- Lines of code in the codebase (used as a baseline), before creation and extraction of the {% data variables.product.prodname_codeql %} database -- Lines of code in the {% data variables.product.prodname_codeql %} database extracted from the code, including external libraries and auto-generated files -- Lines of code in the {% data variables.product.prodname_codeql %} database excluding auto-generated files and external libraries +* Lines of code in the codebase (used as a baseline), before creation and extraction of the {% data variables.product.prodname_codeql %} database +* Lines of code in the {% data variables.product.prodname_codeql %} database extracted from the code, including external libraries and auto-generated files +* Lines of code in the {% data variables.product.prodname_codeql %} database excluding auto-generated files and external libraries diff --git a/data/reusables/code-scanning/using-security-overview-coverage.md b/data/reusables/code-scanning/using-security-overview-coverage.md index 9a4922fc46..cf622137c5 100644 --- a/data/reusables/code-scanning/using-security-overview-coverage.md +++ b/data/reusables/code-scanning/using-security-overview-coverage.md @@ -1,5 +1,5 @@ 1. Use options in the page summary to filter results to show the repositories you want to assess. The list of repositories and metrics displayed on the page automatically update to match your current selection. For more information on filtering, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)." - - Use the **Teams** dropdown to show information only for the repositories owned by one or more teams. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." - - Click **NUMBER enabled** or **NUMBER not enabled** in the header for any feature to show only the repositories with that feature enabled or not enabled. - - At the top of the list of repositories, click **NUMBER Archived** to show only repositories that are archived. - - Click in the search box to add further filters to the repositories displayed. + * Use the **Teams** dropdown to show information only for the repositories owned by one or more teams. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-team-access-to-an-organization-repository)." + * Click **NUMBER enabled** or **NUMBER not enabled** in the header for any feature to show only the repositories with that feature enabled or not enabled. + * At the top of the list of repositories, click **NUMBER Archived** to show only repositories that are archived. + * Click in the search box to add further filters to the repositories displayed. diff --git a/data/reusables/code-scanning/using-security-overview-risk.md b/data/reusables/code-scanning/using-security-overview-risk.md index 32255e3d0e..459750b637 100644 --- a/data/reusables/code-scanning/using-security-overview-risk.md +++ b/data/reusables/code-scanning/using-security-overview-risk.md @@ -1,6 +1,6 @@ 1. Use options in the page summary to filter results to show the repositories you want to assess. The list of repositories and metrics displayed on the page automatically update to match your current selection. For more information on filtering, see "[AUTOTITLE](/code-security/security-overview/filtering-alerts-in-security-overview)." - - Use the **Teams** dropdown to show information only for the repositories owned by one or more teams. - - Click **NUMBER affected** or **NUMBER unaffected** in the header for any feature to show only the repositories with open alerts or no open alerts of that type. - - Click any of the descriptions of "Open alerts" in the header to show only repositories with alerts of that type and category. For example, **1 critical** to show the repository with a critical alert for {% data variables.product.prodname_dependabot %}. - - At the top of the list of repositories, click **NUMBER Archived** to show only repositories that are archived. - - Click in the search box to add further filters to the repositories displayed. + * Use the **Teams** dropdown to show information only for the repositories owned by one or more teams. + * Click **NUMBER affected** or **NUMBER unaffected** in the header for any feature to show only the repositories with open alerts or no open alerts of that type. + * Click any of the descriptions of "Open alerts" in the header to show only repositories with alerts of that type and category. For example, **1 critical** to show the repository with a critical alert for {% data variables.product.prodname_dependabot %}. + * At the top of the list of repositories, click **NUMBER Archived** to show only repositories that are archived. + * Click in the search box to add further filters to the repositories displayed. diff --git a/data/reusables/codeql-cli/advanced-query-execution.md b/data/reusables/codeql-cli/advanced-query-execution.md index 3e65cd3a84..6398bb9496 100644 --- a/data/reusables/codeql-cli/advanced-query-execution.md +++ b/data/reusables/codeql-cli/advanced-query-execution.md @@ -2,8 +2,8 @@ **Note:** Queries run with `database analyze` have strict [metadata requirements](https://codeql.github.com/docs/codeql-cli/using-custom-queries-with-the-codeql-cli/#including-query-metadata). You can also execute queries using the following plumbing-level subcommands: -- [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-run-queries), which outputs non-interpreted results in an intermediate binary format called [BQRS](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#bqrs-file). -- [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/query-run), which will output BQRS files, or print results tables directly to the command line. Viewing results directly in the command line may be useful for iterative query development using the CLI. +* [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-run-queries), which outputs non-interpreted results in an intermediate binary format called [BQRS](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#bqrs-file). +* [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/query-run), which will output BQRS files, or print results tables directly to the command line. Viewing results directly in the command line may be useful for iterative query development using the CLI. Queries run with these commands don’t have the same metadata requirements. However, to save human-readable data you have to process each BQRS results file using the [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode) plumbing subcommand. Therefore, for most use cases it’s easiest to use database analyze to directly generate interpreted results. diff --git a/data/reusables/codeql-cli/download-codeql-cli-zip.md b/data/reusables/codeql-cli/download-codeql-cli-zip.md index f0e0fb2a18..c3f737c184 100644 --- a/data/reusables/codeql-cli/download-codeql-cli-zip.md +++ b/data/reusables/codeql-cli/download-codeql-cli-zip.md @@ -5,9 +5,9 @@ Conditions](https://securitylab.github.com/tools/codeql/license). You should download the {% data variables.product.prodname_codeql %} bundle from https://github.com/github/codeql-action/releases. The bundle contains: -- {% data variables.product.prodname_codeql_cli %} product -- A compatible version of the queries and libraries from https://github.com/github/codeql -- Precompiled versions of all the queries included in the bundle +* {% data variables.product.prodname_codeql_cli %} product +* A compatible version of the queries and libraries from https://github.com/github/codeql +* Precompiled versions of all the queries included in the bundle {% ifversion ghes %} diff --git a/data/reusables/codeql-cli/launch-codeql.md b/data/reusables/codeql-cli/launch-codeql.md index 0957064659..a2fe664f1d 100644 --- a/data/reusables/codeql-cli/launch-codeql.md +++ b/data/reusables/codeql-cli/launch-codeql.md @@ -1,8 +1,8 @@ Once extracted, you can run {% data variables.product.prodname_codeql %} processes by running the `codeql` executable in a couple of ways: -- By executing `/codeql/codeql`, where `` is the folder where you extracted the {% data variables.product.prodname_codeql_cli %} +* By executing `/codeql/codeql`, where `` is the folder where you extracted the {% data variables.product.prodname_codeql_cli %} package. -- By adding `/codeql` to your `PATH`, so that you +* By adding `/codeql` to your `PATH`, so that you can run the executable as just `codeql`. At this point, you can execute {% data variables.product.prodname_codeql %} commands. For a full list of the {% data variables.product.prodname_codeql_cli %} commands, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual)." diff --git a/data/reusables/codespaces/codespaces-jetbrains-beta-note.md b/data/reusables/codespaces/codespaces-jetbrains-beta-note.md index 5ead464e00..a53231d54c 100644 --- a/data/reusables/codespaces/codespaces-jetbrains-beta-note.md +++ b/data/reusables/codespaces/codespaces-jetbrains-beta-note.md @@ -2,7 +2,7 @@ **Notes:** -- Using {% data variables.product.prodname_github_codespaces %} with JetBrains IDEs is currently in public beta and is subject to change. -- To work on a codespace in a JetBrains IDE you must use release 2023.3.\* or 2024.1.\* of the JetBrains Gateway. +* Using {% data variables.product.prodname_github_codespaces %} with JetBrains IDEs is currently in public beta and is subject to change. +* To work on a codespace in a JetBrains IDE you must use release 2023.3.\* or 2024.1.\* of the JetBrains Gateway. {% endnote %} diff --git a/data/reusables/codespaces/devcontainer-properties-1.md b/data/reusables/codespaces/devcontainer-properties-1.md index 864e21880f..f07834e358 100644 --- a/data/reusables/codespaces/devcontainer-properties-1.md +++ b/data/reusables/codespaces/devcontainer-properties-1.md @@ -1,4 +1,4 @@ -- **name**: You can name your dev container anything you want. A default value is supplied. -- **image**: The name of an image in a container registry ([DockerHub](https://hub.docker.com/), [{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_container_registry %}](/packages/learn-github-packages/introduction-to-github-packages), or [Azure Container Registry](https://azure.microsoft.com/services/container-registry/)) that will be used to create the dev container for the codespace. -- **features**: A list of one or more objects, each of which references one of the available dev container features. Features are self-contained, shareable units of installation code and development container configuration. They provide an easy way to add more tooling, runtime, or library features to your development container. You can add features either within {% data variables.product.prodname_vscode_shortname %} or in the `devcontainer.json` editor on {% data variables.product.prodname_dotcom_the_website %}. For more information, click either the **{% data variables.product.prodname_vscode %}** or **Web browser** tab in "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui)." -- **forwardPorts**: Any ports listed here will be forwarded automatically. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." +* **name**: You can name your dev container anything you want. A default value is supplied. +* **image**: The name of an image in a container registry ([DockerHub](https://hub.docker.com/), [{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_container_registry %}](/packages/learn-github-packages/introduction-to-github-packages), or [Azure Container Registry](https://azure.microsoft.com/services/container-registry/)) that will be used to create the dev container for the codespace. +* **features**: A list of one or more objects, each of which references one of the available dev container features. Features are self-contained, shareable units of installation code and development container configuration. They provide an easy way to add more tooling, runtime, or library features to your development container. You can add features either within {% data variables.product.prodname_vscode_shortname %} or in the `devcontainer.json` editor on {% data variables.product.prodname_dotcom_the_website %}. For more information, click either the **{% data variables.product.prodname_vscode %}** or **Web browser** tab in "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui)." +* **forwardPorts**: Any ports listed here will be forwarded automatically. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." diff --git a/data/reusables/codespaces/devcontainer-properties-2.md b/data/reusables/codespaces/devcontainer-properties-2.md index 029f7d5416..3cc1a08a6f 100644 --- a/data/reusables/codespaces/devcontainer-properties-2.md +++ b/data/reusables/codespaces/devcontainer-properties-2.md @@ -1,3 +1,3 @@ -- **postCreateCommand**: Use this property to run commands after your codespace is created. This can be formatted as a string (as above), an array, or an object. For more information, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. -- **customizations**: This property allows you to customize a specific tool or service when it is used for working in a codespace. For example, you can configure specific settings and extensions for {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Supporting tools and services](https://containers.dev/supporting)" on the Development Containers website. -- **remoteUser**: By default, you’re running as the vscode user, but you can optionally set this to root. +* **postCreateCommand**: Use this property to run commands after your codespace is created. This can be formatted as a string (as above), an array, or an object. For more information, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. +* **customizations**: This property allows you to customize a specific tool or service when it is used for working in a codespace. For example, you can configure specific settings and extensions for {% data variables.product.prodname_vscode_shortname %}. For more information, see "[Supporting tools and services](https://containers.dev/supporting)" on the Development Containers website. +* **remoteUser**: By default, you’re running as the vscode user, but you can optionally set this to root. diff --git a/data/reusables/codespaces/next-steps-adding-devcontainer.md b/data/reusables/codespaces/next-steps-adding-devcontainer.md index bdd173196b..7184913683 100644 --- a/data/reusables/codespaces/next-steps-adding-devcontainer.md +++ b/data/reusables/codespaces/next-steps-adding-devcontainer.md @@ -1,6 +1,6 @@ Here are some additional resources for more advanced scenarios. -- "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui)" -- "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)" -- "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)" -- "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)" +* "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file?tool=webui)" +* "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)" +* "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)" +* "[AUTOTITLE](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)" diff --git a/data/reusables/codespaces/opening-codespace-in-jetbrains.md b/data/reusables/codespaces/opening-codespace-in-jetbrains.md index e4c34693db..b1dff85679 100644 --- a/data/reusables/codespaces/opening-codespace-in-jetbrains.md +++ b/data/reusables/codespaces/opening-codespace-in-jetbrains.md @@ -23,10 +23,10 @@ Alternatively, you can also open the JetBrains Gateway and select an existing co **Notes**: - - If you chose Rider as your JetBrains IDE and the repository contains multiple solution files, the "Set Solution Path" dialog is displayed prompting you to choose which solution you want to work in. Choose a solution file from the dropdown menu and click **OK**. + * If you chose Rider as your JetBrains IDE and the repository contains multiple solution files, the "Set Solution Path" dialog is displayed prompting you to choose which solution you want to work in. Choose a solution file from the dropdown menu and click **OK**. If the repository doesn't have a solution file, Rider opens in a basic project directory view and will have limited capabilities. For instance, you won't get .NET-specific code navigation. If there is just a single solution file in the repository it will be used automatically, without the prompt being displayed. For more information, see "[Create and open projects and solutions](https://www.jetbrains.com/help/rider/Creating_and_Opening_Projects_and_Solutions.html)" in the JetBrains documentation.

- - If you are running a firewall, then the first time you connect to a remote resource you may be prompted to allow the JetBrains Gateway to communicate across your network. + * If you are running a firewall, then the first time you connect to a remote resource you may be prompted to allow the JetBrains Gateway to communicate across your network. {% endnote %} diff --git a/data/reusables/codespaces/permanent-codespace-names.md b/data/reusables/codespaces/permanent-codespace-names.md index d778735852..4b9c39ce59 100644 --- a/data/reusables/codespaces/permanent-codespace-names.md +++ b/data/reusables/codespaces/permanent-codespace-names.md @@ -2,9 +2,9 @@ You will occasionally need to know the permanent name of a codespace. For exampl To find the permanent name of a codespace, do one of the following: -- Open the codespace in the browser. The subdomain of the URL is the name of the codespace. For example: `https://obscure-space-engine-grx7rgg6qp43v9j5.github.dev` is the URL for the `obscure-space-engine-grx7rgg6qp43v9j5` codespace. -- If you cannot open a codespace, you can access the name from your list of codespaces at https://github.com/codespaces. Right-click the display name of the codespace and select your browser's option for copying the link address. The final part of the URL you copy is the permanent name of the codespace. -- In a codespace, use this command in the terminal: `echo $CODESPACE_NAME`. -- If {% data variables.product.prodname_cli %} is installed, either locally or in a codespace, use this command in the terminal to list all of your codespaces: `gh codespace list`. +* Open the codespace in the browser. The subdomain of the URL is the name of the codespace. For example: `https://obscure-space-engine-grx7rgg6qp43v9j5.github.dev` is the URL for the `obscure-space-engine-grx7rgg6qp43v9j5` codespace. +* If you cannot open a codespace, you can access the name from your list of codespaces at https://github.com/codespaces. Right-click the display name of the codespace and select your browser's option for copying the link address. The final part of the URL you copy is the permanent name of the codespace. +* In a codespace, use this command in the terminal: `echo $CODESPACE_NAME`. +* If {% data variables.product.prodname_cli %} is installed, either locally or in a codespace, use this command in the terminal to list all of your codespaces: `gh codespace list`. The permanent name the codespace is also included in many of the log files. For example, in the {% data variables.product.prodname_github_codespaces %} extension log, after `fetching codespace` or `Connecting to codespace`, and in the browser console log after `clientUrl`. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/github-codespaces-logs)." diff --git a/data/reusables/codespaces/port-visibility-settings.md b/data/reusables/codespaces/port-visibility-settings.md index 5f9843a7a1..9879723104 100644 --- a/data/reusables/codespaces/port-visibility-settings.md +++ b/data/reusables/codespaces/port-visibility-settings.md @@ -1,5 +1,5 @@ There are three visibility settings: -- `private` - Visible only to you. This is the default setting when you forward a port. -- `org` - Visible to members of the organization that owns the repository. -- `public` - Visible to anyone who knows the URL and port number. +* `private` - Visible only to you. This is the default setting when you forward a port. +* `org` - Visible to members of the organization that owns the repository. +* `public` - Visible to anyone who knows the URL and port number. diff --git a/data/reusables/codespaces/rebuilding-container-procedures.md b/data/reusables/codespaces/rebuilding-container-procedures.md index 62f5d09912..5a34508d24 100644 --- a/data/reusables/codespaces/rebuilding-container-procedures.md +++ b/data/reusables/codespaces/rebuilding-container-procedures.md @@ -2,9 +2,9 @@ ![Screenshot of a message saying that the codespace is running in recovery mode. Below the message are buttons labeled "Cancel" and "View creation log."](/assets/images/help/codespaces/recovery-mode-error-message.png) - - To diagnose the error by reviewing the creation logs, click **View creation log**. - - To fix the errors identified in the logs, update your `devcontainer.json` file. - - To apply the changes, rebuild your container. + * To diagnose the error by reviewing the creation logs, click **View creation log**. + * To fix the errors identified in the logs, update your `devcontainer.json` file. + * To apply the changes, rebuild your container. ### Using {% data variables.product.prodname_cli %} to rebuild a dev container diff --git a/data/reusables/codespaces/secrets-naming.md b/data/reusables/codespaces/secrets-naming.md index ec7d6b5fb5..fbce299699 100644 --- a/data/reusables/codespaces/secrets-naming.md +++ b/data/reusables/codespaces/secrets-naming.md @@ -1,7 +1,7 @@ The following rules apply to secret names: -- Secret names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. -- Secret names must not start with the `GITHUB_` prefix. -- Secret names must not start with a number. -- Secret names are not case-sensitive. -- Secret names must be unique at the level they are created at. +* Secret names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed. +* Secret names must not start with the `GITHUB_` prefix. +* Secret names must not start with a number. +* Secret names are not case-sensitive. +* Secret names must be unique at the level they are created at. diff --git a/data/reusables/codespaces/when-an-org-pays.md b/data/reusables/codespaces/when-an-org-pays.md index 501901ead7..e0981d15aa 100644 --- a/data/reusables/codespaces/when-an-org-pays.md +++ b/data/reusables/codespaces/when-an-org-pays.md @@ -1,3 +1,3 @@ -- The organization has set a non-zero spending limit for {% data variables.product.prodname_github_codespaces %}. -- The codespace is created from one of the organization's repositories, or from a fork of one of the organization's repositories. This includes {% ifversion ghec %}public, private, and internal{% elsif fpt %}both public and private{% endif %} repositories. -- The user creating the codespace is a member or collaborator of the organization, and the organization has enabled {% data variables.product.prodname_github_codespaces %} for this user. This can include all members and collaborators if the organization has chosen to enable {% data variables.product.prodname_codespaces %} for all users. If {% data variables.product.prodname_codespaces %} isn't enabled for a user, they can still create codespaces from public repositories in the organization, but the user will pay for these codespaces. +* The organization has set a non-zero spending limit for {% data variables.product.prodname_github_codespaces %}. +* The codespace is created from one of the organization's repositories, or from a fork of one of the organization's repositories. This includes {% ifversion ghec %}public, private, and internal{% elsif fpt %}both public and private{% endif %} repositories. +* The user creating the codespace is a member or collaborator of the organization, and the organization has enabled {% data variables.product.prodname_github_codespaces %} for this user. This can include all members and collaborators if the organization has chosen to enable {% data variables.product.prodname_codespaces %} for all users. If {% data variables.product.prodname_codespaces %} isn't enabled for a user, they can still create codespaces from public repositories in the organization, but the user will pay for these codespaces. diff --git a/data/reusables/command-palette/change-scope.md b/data/reusables/command-palette/change-scope.md index 6d0f7c85b4..e0ad0dec7a 100644 --- a/data/reusables/command-palette/change-scope.md +++ b/data/reusables/command-palette/change-scope.md @@ -1,5 +1,5 @@ 1. Optionally, narrow, expand, or completely change the scope for suggestions by editing the path in the command palette's text field. - - To narrow the scope within a user or organization account, highlight a repository then use Tab to add it to the scope. - - To expand the scope, highlight and remove an item in the scope using the Backspace or delete key. - - To clear the scope and text box, click **Clear** or use Ctrl+Backspace (Windows and Linux) or Command+Delete (Mac). + * To narrow the scope within a user or organization account, highlight a repository then use Tab to add it to the scope. + * To expand the scope, highlight and remove an item in the scope using the Backspace or delete key. + * To clear the scope and text box, click **Clear** or use Ctrl+Backspace (Windows and Linux) or Command+Delete (Mac). diff --git a/data/reusables/command_line/manipulating_file_prereqs.md b/data/reusables/command_line/manipulating_file_prereqs.md index cfb2e6588e..5451f1ea90 100644 --- a/data/reusables/command_line/manipulating_file_prereqs.md +++ b/data/reusables/command_line/manipulating_file_prereqs.md @@ -1,4 +1,4 @@ This procedure assumes you've already: -- [Created a repository on {% data variables.product.product_name %}](/repositories/creating-and-managing-repositories/creating-a-new-repository), or have an existing repository owned by someone else you'd like to contribute to -- [Cloned the repository locally on your computer](/repositories/creating-and-managing-repositories/cloning-a-repository) +* [Created a repository on {% data variables.product.product_name %}](/repositories/creating-and-managing-repositories/creating-a-new-repository), or have an existing repository owned by someone else you'd like to contribute to +* [Cloned the repository locally on your computer](/repositories/creating-and-managing-repositories/cloning-a-repository) diff --git a/data/reusables/commits/about-commits.md b/data/reusables/commits/about-commits.md index 5e0cc4ecad..21f6a2cd48 100644 --- a/data/reusables/commits/about-commits.md +++ b/data/reusables/commits/about-commits.md @@ -1,7 +1,7 @@ Similar to saving a file that's been edited, a commit records changes to one or more files in your branch. Git assigns each commit a unique ID, called a SHA or hash, that identifies: -- The specific changes -- When the changes were made -- Who created the changes +* The specific changes +* When the changes were made +* Who created the changes When you make a commit, you must include a commit message that briefly describes the changes. diff --git a/data/reusables/community/report-content.md b/data/reusables/community/report-content.md index 56cabef508..d62b174ca8 100644 --- a/data/reusables/community/report-content.md +++ b/data/reusables/community/report-content.md @@ -1,4 +1,4 @@ 1. You may see options to **Report to repository admins** or **Report abuse to {% data variables.product.prodname_dotcom %} Support**. If not, skip to the next step. - - To report the content to {% data variables.product.prodname_dotcom %} Support, click **Report abuse to {% data variables.product.prodname_dotcom %} Support**. - - To report the content to repository maintainers, use the **Choose a reason** dropdown to select a reason, then click **Report to repository admins**. Your report has been submitted. + * To report the content to {% data variables.product.prodname_dotcom %} Support, click **Report abuse to {% data variables.product.prodname_dotcom %} Support**. + * To report the content to repository maintainers, use the **Choose a reason** dropdown to select a reason, then click **Report to repository admins**. Your report has been submitted. 1. Complete the "Report content" form, then click **Send request**. diff --git a/data/reusables/community/types-of-interaction-limits.md b/data/reusables/community/types-of-interaction-limits.md index 62d941e29b..4f74190474 100644 --- a/data/reusables/community/types-of-interaction-limits.md +++ b/data/reusables/community/types-of-interaction-limits.md @@ -1,4 +1,4 @@ There are three types of interaction limits. -- **Limit to existing users**: Limits activity for users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators. -- **Limit to prior contributors**: Limits activity for users who have not previously contributed to the default branch of the repository and are not collaborators. -- **Limit to repository collaborators**: Limits activity for users who do not have write access to the repository. +* **Limit to existing users**: Limits activity for users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators. +* **Limit to prior contributors**: Limits activity for users who have not previously contributed to the default branch of the repository and are not collaborators. +* **Limit to repository collaborators**: Limits activity for users who do not have write access to the repository. diff --git a/data/reusables/copilot/chat-subscription-prerequisite.md b/data/reusables/copilot/chat-subscription-prerequisite.md index b43fa95754..59027a58ec 100644 --- a/data/reusables/copilot/chat-subscription-prerequisite.md +++ b/data/reusables/copilot/chat-subscription-prerequisite.md @@ -1 +1 @@ -- To use {% data variables.product.prodname_copilot_chat %} you must have an active {% data variables.product.prodname_copilot %} subscription. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." +* To use {% data variables.product.prodname_copilot_chat %} you must have an active {% data variables.product.prodname_copilot %} subscription. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot)." diff --git a/data/reusables/copilot/content-exclusion-limitations.md b/data/reusables/copilot/content-exclusion-limitations.md index 5402ebd79a..168b73a5e3 100644 --- a/data/reusables/copilot/content-exclusion-limitations.md +++ b/data/reusables/copilot/content-exclusion-limitations.md @@ -1,3 +1,3 @@ -- With the exception of {% data variables.product.prodname_vscode %}, content exclusion is currently not supported for {% data variables.product.prodname_copilot_chat %}. -- Content exclusion is not applied, in {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}, when you use the `@github` {% data variables.product.prodname_copilot_short %} chat participant in your question. -- It's possible that {% data variables.product.prodname_copilot_short %} may use semantic information from an excluded file if the information is provided by the IDE in a non-excluded file. Examples of such content include type information and hover-over definitions for symbols used in code. +* With the exception of {% data variables.product.prodname_vscode %}, content exclusion is currently not supported for {% data variables.product.prodname_copilot_chat %}. +* Content exclusion is not applied, in {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %}, when you use the `@github` {% data variables.product.prodname_copilot_short %} chat participant in your question. +* It's possible that {% data variables.product.prodname_copilot_short %} may use semantic information from an excluded file if the information is provided by the IDE in a non-excluded file. Examples of such content include type information and hover-over definitions for symbols used in code. diff --git a/data/reusables/copilot/content-exclusion-note.md b/data/reusables/copilot/content-exclusion-note.md index 9d4a3496e9..c0bb1457c6 100644 --- a/data/reusables/copilot/content-exclusion-note.md +++ b/data/reusables/copilot/content-exclusion-note.md @@ -1,2 +1,2 @@ -- Excluding content from {% data variables.product.prodname_copilot %} is currently in public beta and is subject to change. -- This feature is supported for {% data variables.product.prodname_copilot %} code completion in {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode %}, JetBrains IDEs, and neovim. It is also supported for {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vscode_shortname %}. For details of supported JetBrains IDEs, see "[AUTOTITLE](/copilot/getting-started-with-github-copilot?tool=jetbrains#prerequisites)." +* Excluding content from {% data variables.product.prodname_copilot %} is currently in public beta and is subject to change. +* This feature is supported for {% data variables.product.prodname_copilot %} code completion in {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode %}, JetBrains IDEs, and neovim. It is also supported for {% data variables.product.prodname_copilot_chat %} in {% data variables.product.prodname_vscode_shortname %}. For details of supported JetBrains IDEs, see "[AUTOTITLE](/copilot/getting-started-with-github-copilot?tool=jetbrains#prerequisites)." diff --git a/data/reusables/copilot/copilot-chat-mobile-enable.md b/data/reusables/copilot/copilot-chat-mobile-enable.md index 13d5f52634..5e687903f9 100644 --- a/data/reusables/copilot/copilot-chat-mobile-enable.md +++ b/data/reusables/copilot/copilot-chat-mobile-enable.md @@ -3,6 +3,6 @@ 1. Click the **Policies** tab. 1. To the right of "{% data variables.product.prodname_copilot_mobile_short %}", select the dropdown menu, then choose the appropriate option. - - To allow each of your organizations to set their own policy, select **No policy**. - - To enable {% data variables.product.prodname_copilot_cli_short %} for all organizations under your enterprise, select **Enabled**. - - To disable {% data variables.product.prodname_copilot_cli_short %} for all organizations under your enterprise, select **Disabled**. + * To allow each of your organizations to set their own policy, select **No policy**. + * To enable {% data variables.product.prodname_copilot_cli_short %} for all organizations under your enterprise, select **Enabled**. + * To disable {% data variables.product.prodname_copilot_cli_short %} for all organizations under your enterprise, select **Disabled**. diff --git a/data/reusables/copilot/copilot-cli-enable.md b/data/reusables/copilot/copilot-cli-enable.md index 9317c14791..23e0a86369 100644 --- a/data/reusables/copilot/copilot-cli-enable.md +++ b/data/reusables/copilot/copilot-cli-enable.md @@ -3,6 +3,6 @@ 1. Click the **Policies** tab. 1. To the right of "{% data variables.product.prodname_copilot_cli %}", select the dropdown menu, then choose the appropriate option. - - To allow each of your organizations to set their own policy, select **No policy**. - - To enable {% data variables.product.prodname_copilot_cli_short %} for all organizations under your enterprise, select **Enabled**. - - To disable {% data variables.product.prodname_copilot_cli_short %} for all organizations under your enterprise, select **Disabled**. + * To allow each of your organizations to set their own policy, select **No policy**. + * To enable {% data variables.product.prodname_copilot_cli_short %} for all organizations under your enterprise, select **Enabled**. + * To disable {% data variables.product.prodname_copilot_cli_short %} for all organizations under your enterprise, select **Disabled**. diff --git a/data/reusables/copilot/copilot-enterprise-enable.md b/data/reusables/copilot/copilot-enterprise-enable.md index 0071a9e1cc..7912eab3c0 100644 --- a/data/reusables/copilot/copilot-enterprise-enable.md +++ b/data/reusables/copilot/copilot-enterprise-enable.md @@ -3,9 +3,9 @@ {% data reusables.enterprise-accounts.copilot-policies-tab %} 1. Next to "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}," click the dropdown menu and select the policy you want to enforce. - - **No policy** - Allow each of your organizations to set their own policy. "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}" will initially be disabled for all organizations, but can be enabled by organization owners in their organization settings. - - **Enabled** - Allow use of "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}" by all members of organizations in your enterprise who have been granted access to {% data variables.product.prodname_copilot_short %}. - - **Disabled** - Prevent organizations from assigning {% data variables.product.prodname_copilot_enterprise_short %} seats to members under the enterprise's {% data variables.product.prodname_copilot_enterprise_short %} subscription. + * **No policy** - Allow each of your organizations to set their own policy. "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}" will initially be disabled for all organizations, but can be enabled by organization owners in their organization settings. + * **Enabled** - Allow use of "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}" by all members of organizations in your enterprise who have been granted access to {% data variables.product.prodname_copilot_short %}. + * **Disabled** - Prevent organizations from assigning {% data variables.product.prodname_copilot_enterprise_short %} seats to members under the enterprise's {% data variables.product.prodname_copilot_enterprise_short %} subscription. 1. If you select **Enabled** for the "{% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_dotcom_the_website %}" policy, the **Opt in to user feedback collection** check box is displayed. @@ -19,8 +19,8 @@ 1. Next to "Give {% data variables.product.prodname_copilot_short %} access to Bing," click the dropdown menu and select the policy you want to enforce. - - **No policy** - Allow each of your organizations to set their own policy. Access to Bing will initially be disabled for all organizations, but can be enabled by organization owners in their organization settings. - - **Enabled** - Allow {% data variables.product.prodname_copilot_chat_short %} to use results from a Bing web search to provide information for its responses. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom#asking-a-general-question-about-software-development)" and "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide#using-github-skills-for-copilot)." - - **Disabled** - Prevent {% data variables.product.prodname_copilot_chat_short %} from accessing Bing. + * **No policy** - Allow each of your organizations to set their own policy. Access to Bing will initially be disabled for all organizations, but can be enabled by organization owners in their organization settings. + * **Enabled** - Allow {% data variables.product.prodname_copilot_chat_short %} to use results from a Bing web search to provide information for its responses. See "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom#asking-a-general-question-about-software-development)" and "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide#using-github-skills-for-copilot)." + * **Disabled** - Prevent {% data variables.product.prodname_copilot_chat_short %} from accessing Bing. > [!NOTE] Bing search integration into {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %}, {% data variables.product.prodname_vscode_shortname %}, and {% data variables.product.prodname_vs %} is currently in beta and is subject to change. diff --git a/data/reusables/copilot/copilot-extensions/compatible-chat-interfaces.md b/data/reusables/copilot/copilot-extensions/compatible-chat-interfaces.md index a6fc59bf2a..2ea05a94b6 100644 --- a/data/reusables/copilot/copilot-extensions/compatible-chat-interfaces.md +++ b/data/reusables/copilot/copilot-extensions/compatible-chat-interfaces.md @@ -1,3 +1,3 @@ -- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %} -- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %} -- {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %} (with a {% data variables.product.prodname_copilot_enterprise_short %} subscription) +* {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vs %} +* {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_vscode %} +* {% data variables.product.prodname_copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %} (with a {% data variables.product.prodname_copilot_enterprise_short %} subscription) diff --git a/data/reusables/copilot/enabling-chat-enterprise.md b/data/reusables/copilot/enabling-chat-enterprise.md index 7e7ead3d5e..20893c02f5 100644 --- a/data/reusables/copilot/enabling-chat-enterprise.md +++ b/data/reusables/copilot/enabling-chat-enterprise.md @@ -1,6 +1,6 @@ {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.copilot-tab %} 1. To the right of **{% data variables.product.prodname_copilot_chat %} Beta**, select the dropdown menu, and then choose the appropriate option. - - Click **Allowed** to enable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise. - - Click **Blocked** to disable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise. - - Click **No policy** to allow each organization under your enterprise to set their own policy. + * Click **Allowed** to enable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise. + * Click **Blocked** to disable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise. + * Click **No policy** to allow each organization under your enterprise to set their own policy. diff --git a/data/reusables/copilot/enabling-copilot-chat-beta.md b/data/reusables/copilot/enabling-copilot-chat-beta.md index 728d8908c9..25e7f51272 100644 --- a/data/reusables/copilot/enabling-copilot-chat-beta.md +++ b/data/reusables/copilot/enabling-copilot-chat-beta.md @@ -22,6 +22,6 @@ If {% data variables.product.prodname_copilot_chat_short %} is enabled or disabl {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.copilot-tab %} 1. To the right of **{% data variables.product.prodname_copilot_chat %} Beta**, select the dropdown menu, and then choose the appropriate option. - - Click **Allowed** to enable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise. - - Click **Blocked** to disable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise. - - Click **No policy** to allow each organization under your enterprise to set their own policy. + * Click **Allowed** to enable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise. + * Click **Blocked** to disable the {% data variables.product.prodname_copilot_chat %} beta for all organizations under your enterprise. + * Click **No policy** to allow each organization under your enterprise to set their own policy. diff --git a/data/reusables/copilot/enabling-or-disabling-copilot.md b/data/reusables/copilot/enabling-or-disabling-copilot.md index f6593b2d89..f8c7dfb602 100644 --- a/data/reusables/copilot/enabling-or-disabling-copilot.md +++ b/data/reusables/copilot/enabling-or-disabling-copilot.md @@ -26,8 +26,8 @@ If {% data variables.product.prodname_copilot_chat_short %} is enabled or disabl {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.copilot-tab %} 1. To the right of **{% data variables.product.prodname_copilot_chat_short %} in the IDE**, select the dropdown menu, and then choose the appropriate option. - - Click **Allowed** to enable {% data variables.product.prodname_copilot_chat %} for all organizations under your enterprise. - - Click **Blocked** to disable {% data variables.product.prodname_copilot_chat %} for all organizations under your enterprise. - - Click **No policy** to allow each organization under your enterprise to set their own policy. + * Click **Allowed** to enable {% data variables.product.prodname_copilot_chat %} for all organizations under your enterprise. + * Click **Blocked** to disable {% data variables.product.prodname_copilot_chat %} for all organizations under your enterprise. + * Click **No policy** to allow each organization under your enterprise to set their own policy. {% endif %} diff --git a/data/reusables/copilot/enabling-or-disabling-in-ads.md b/data/reusables/copilot/enabling-or-disabling-in-ads.md index c89aea7dd5..9e5aaa8783 100644 --- a/data/reusables/copilot/enabling-or-disabling-in-ads.md +++ b/data/reusables/copilot/enabling-or-disabling-in-ads.md @@ -8,6 +8,6 @@ You can enable or disable {% data variables.product.prodname_copilot %} from wit 1. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable suggestions globally, or for the language of the file you are currently editing. - - To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Disable Globally**. - - To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Disable for LANGUAGE**. + * To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Disable Globally**. + * To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Disable for LANGUAGE**. ![Screenshot of option to disable {% data variables.product.prodname_copilot %} globally or for the current language.](/assets/images/help/copilot/disable-copilot-global-or-language-ads.png) diff --git a/data/reusables/copilot/enabling-or-disabling-in-vsc.md b/data/reusables/copilot/enabling-or-disabling-in-vsc.md index 0e287afbc2..e3068994a4 100644 --- a/data/reusables/copilot/enabling-or-disabling-in-vsc.md +++ b/data/reusables/copilot/enabling-or-disabling-in-vsc.md @@ -8,6 +8,6 @@ You can enable or disable {% data variables.product.prodname_copilot %} from wit 1. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable suggestions globally, or for the language of the file you are currently editing. - - To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Disable Globally**. - - To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Disable for LANGUAGE**. + * To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Disable Globally**. + * To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Disable for LANGUAGE**. ![Screenshot of option to disable {% data variables.product.prodname_copilot %} globally or for the current language.](/assets/images/help/copilot/disable-copilot-global-or-language.png) diff --git a/data/reusables/copilot/enabling-or-disabling-vs.md b/data/reusables/copilot/enabling-or-disabling-vs.md index 8350c8bb0e..74a9685cb9 100644 --- a/data/reusables/copilot/enabling-or-disabling-vs.md +++ b/data/reusables/copilot/enabling-or-disabling-vs.md @@ -8,5 +8,5 @@ The {% data variables.product.prodname_copilot %} status icon in the bottom pane 1. If you are disabling {% data variables.product.prodname_copilot %}, you will be asked whether you want to disable suggestions globally, or for the language of the file you are currently editing. - - To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Enable Globally**. - - To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Enable for LANGUAGE**. + * To disable suggestions from {% data variables.product.prodname_copilot %} globally, click **Enable Globally**. + * To disable suggestions from {% data variables.product.prodname_copilot %} for the specified language, click **Enable for LANGUAGE**. diff --git a/data/reusables/copilot/install-copilot-and-chat-combo-vs-procedure.md b/data/reusables/copilot/install-copilot-and-chat-combo-vs-procedure.md index 34b93d944c..f8bf0ef1db 100644 --- a/data/reusables/copilot/install-copilot-and-chat-combo-vs-procedure.md +++ b/data/reusables/copilot/install-copilot-and-chat-combo-vs-procedure.md @@ -8,5 +8,5 @@ 1. In the bottom-right corner of {% data variables.product.prodname_vs %} Installer, click **Modify**. 1. When the modification is complete, close the {% data variables.product.prodname_vs %} Installer and launch {% data variables.product.prodname_vs %}. 1. Optionally, to modify the installation or add more components, launch {% data variables.product.prodname_vs %} Installer from the Windows Start menu. - - To the right of your installed version of {% data variables.product.prodname_vs %}, click **Modify**. - - Make your desired changes, and in the bottom right corner click **Modify** again to apply them. + * To the right of your installed version of {% data variables.product.prodname_vs %}, click **Modify**. + * Make your desired changes, and in the bottom right corner click **Modify** again to apply them. diff --git a/data/reusables/copilot/policies-for-dotcom.md b/data/reusables/copilot/policies-for-dotcom.md index 668ffc0899..ef6d27b572 100644 --- a/data/reusables/copilot/policies-for-dotcom.md +++ b/data/reusables/copilot/policies-for-dotcom.md @@ -1,3 +1,3 @@ -- **Give {% data variables.product.prodname_copilot_short %} access to Bing**: Select this check box to allow {% data variables.product.prodname_copilot_chat_short %} to use Bing search results to provide information for its responses. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom#asking-a-general-question-about-software-development)." +* **Give {% data variables.product.prodname_copilot_short %} access to Bing**: Select this check box to allow {% data variables.product.prodname_copilot_chat_short %} to use Bing search results to provide information for its responses. For more information, see "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom#asking-a-general-question-about-software-development)." -- **Opt in to user feedback collection**: Select this check box to allow users to provide feedback on {% data variables.product.prodname_copilot_short %} pull request summaries. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)." +* **Opt in to user feedback collection**: Select this check box to allow users to provide feedback on {% data variables.product.prodname_copilot_short %} pull request summaries. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot)." diff --git a/data/reusables/copilot/signup-procedure-org.md b/data/reusables/copilot/signup-procedure-org.md index a3be72c1b9..50069d243b 100644 --- a/data/reusables/copilot/signup-procedure-org.md +++ b/data/reusables/copilot/signup-procedure-org.md @@ -6,8 +6,8 @@ 1. In the "Public code suggestions" dropdown, select **Allow** or **Block** to allow or block suggestions that match public code, and click **Save and continue**. You can change these preferences later by returning to your {% data variables.product.prodname_copilot %} settings. 1. Either grant access to {% data variables.product.prodname_copilot %} for all current and future users in your organization, or for specific users in your organization. - - If you selected **Allow for all members**, click **Confirm** in the "Confirm seat assignment" dialog to confirm that you want to enable {% data variables.product.prodname_copilot %} for all current and future users in your organization. - - If you selected **Selected teams/users**, you can choose **Add people** or **Add team**. - - If you selected **Add people**, in the "Enable GitHub Copilot access for selected members of ORGANIZATION" dialog, you can either search for individual members, or you can add members in bulk by uploading a CSV file. - - If you selected **Add team**, in the "Enable GitHub Copilot access for selected teams of ORGANIZATION" dialog, start typing the team name in the search bar, select the team you want to add and click **Add team(s) to access list**. + * If you selected **Allow for all members**, click **Confirm** in the "Confirm seat assignment" dialog to confirm that you want to enable {% data variables.product.prodname_copilot %} for all current and future users in your organization. + * If you selected **Selected teams/users**, you can choose **Add people** or **Add team**. + * If you selected **Add people**, in the "Enable GitHub Copilot access for selected members of ORGANIZATION" dialog, you can either search for individual members, or you can add members in bulk by uploading a CSV file. + * If you selected **Add team**, in the "Enable GitHub Copilot access for selected teams of ORGANIZATION" dialog, start typing the team name in the search bar, select the team you want to add and click **Add team(s) to access list**. 1. To finish setting up your {% data variables.product.prodname_copilot_for_business %} subscription, click **Save and finish**. Organization members will receive an email with instructions on how to start using {% data variables.product.prodname_copilot %}. diff --git a/data/reusables/dashboard/recent-activity-qualifying-events.md b/data/reusables/dashboard/recent-activity-qualifying-events.md index ab15628da4..02352f5de5 100644 --- a/data/reusables/dashboard/recent-activity-qualifying-events.md +++ b/data/reusables/dashboard/recent-activity-qualifying-events.md @@ -1,8 +1,8 @@ Open issues and pull requests appear in the recent activity section when: -- You have opened an issue or pull request. -- Someone has commented on an issue or pull request you opened. -- Your issue or pull request was reopened. -- Your review was requested on a pull request. -- You were assigned to an issue or pull request. -- You referenced an issue or pull request via a commit. -- You commented on an issue or pull request. +* You have opened an issue or pull request. +* Someone has commented on an issue or pull request you opened. +* Your issue or pull request was reopened. +* Your review was requested on a pull request. +* You were assigned to an issue or pull request. +* You referenced an issue or pull request via a commit. +* You commented on an issue or pull request. diff --git a/data/reusables/dependabot/about-the-dependency-graph.md b/data/reusables/dependabot/about-the-dependency-graph.md index 8ffedfaed0..9f0afb0c2f 100644 --- a/data/reusables/dependabot/about-the-dependency-graph.md +++ b/data/reusables/dependabot/about-the-dependency-graph.md @@ -1,7 +1,7 @@ The dependency graph is a summary of the manifest and lock files stored in a repository and any dependencies that are submitted for the repository using the {% data variables.dependency-submission-api.name %} (beta). For each repository, it shows{% ifversion fpt or ghec %}: -- Dependencies, the ecosystems and packages it depends on -- Dependents, the repositories and packages that depend on it{% else %} dependencies, the ecosystems and packages it depends on.{% endif %} +* Dependencies, the ecosystems and packages it depends on +* Dependents, the repositories and packages that depend on it{% else %} dependencies, the ecosystems and packages it depends on.{% endif %} {% ifversion dependency-graph-repository-view-update %} {% data reusables.dependency-graph.repository-view-update %} diff --git a/data/reusables/dependabot/automatically-pause-dependabot-updates.md b/data/reusables/dependabot/automatically-pause-dependabot-updates.md index 1ce2cf38f6..1aeeb4a29f 100644 --- a/data/reusables/dependabot/automatically-pause-dependabot-updates.md +++ b/data/reusables/dependabot/automatically-pause-dependabot-updates.md @@ -4,21 +4,21 @@ The automatic deactivation of {% data variables.product.prodname_dependabot %} u An active repository is a repository for which a user (not {% data variables.product.prodname_dependabot %}) has carried out _any_ of the actions below in the last 90 days: -- Merge or close a {% data variables.product.prodname_dependabot %} pull request on the repository. -- Make a change to the `dependabot.yml` file for the repository. -- Manually trigger a security update or a version update. -- Enable {% data variables.product.prodname_dependabot_security_updates %} for the repository. -- Use `@dependabot` commands on pull requests. +* Merge or close a {% data variables.product.prodname_dependabot %} pull request on the repository. +* Make a change to the `dependabot.yml` file for the repository. +* Manually trigger a security update or a version update. +* Enable {% data variables.product.prodname_dependabot_security_updates %} for the repository. +* Use `@dependabot` commands on pull requests. An inactive repository is a repository that has at least one {% data variables.product.prodname_dependabot %} pull request open for more than 90 days, has been enabled for the full period, and where none of the actions listed above has been taken by a user. When {% data variables.product.prodname_dependabot %} is paused, {% data variables.product.prodname_dotcom %} adds a banner notice: -- To all open {% data variables.product.prodname_dependabot %} pull requests. -- To the UI of the **Settings** tab of the repository (under **Code security and analysis**, then **{% data variables.product.prodname_dependabot %}**). -- To the list of {% data variables.product.prodname_dependabot_alerts %} (if {% data variables.product.prodname_dependabot_security_updates %} are affected). +* To all open {% data variables.product.prodname_dependabot %} pull requests. +* To the UI of the **Settings** tab of the repository (under **Code security and analysis**, then **{% data variables.product.prodname_dependabot %}**). +* To the list of {% data variables.product.prodname_dependabot_alerts %} (if {% data variables.product.prodname_dependabot_security_updates %} are affected). {% ifversion dependabot-updates-paused-enterprise-orgs %} Additionally, you will be able to see whether {% data variables.product.prodname_dependabot %} is paused at the organization-level in the security overview. The `paused` status will also be visible via the API. For more information, see "[AUTOTITLE](/rest/repos#enable-automated-security-fixes)."{% endif %} As soon as a maintainer interacts with a {% data variables.product.prodname_dependabot %} pull request again, {% data variables.product.prodname_dependabot %} will unpause itself: -- Security updates are automatically resumed for {% data variables.product.prodname_dependabot_alerts %}. -- Version updates are automatically resumed with the schedule specified in the `dependabot.yml` file. +* Security updates are automatically resumed for {% data variables.product.prodname_dependabot_alerts %}. +* Version updates are automatically resumed with the schedule specified in the `dependabot.yml` file. diff --git a/data/reusables/dependabot/dependabot-grouped-security-updates-how-enable.md b/data/reusables/dependabot/dependabot-grouped-security-updates-how-enable.md index 97e939002a..1f11883c6e 100644 --- a/data/reusables/dependabot/dependabot-grouped-security-updates-how-enable.md +++ b/data/reusables/dependabot/dependabot-grouped-security-updates-how-enable.md @@ -1,3 +1,3 @@ You can enable grouped pull requests for {% data variables.product.prodname_dependabot_security_updates %} in one, or both, of the following ways. -- To group as many available security updates together as possible, across directories and per ecosystem, enable grouping in the "Code security and analysis" settings for your organization or repository. -- For more granular control of grouping, such as grouping by package name, development/production dependencies, or SemVer level, add configuration options to the `dependabot.yml` configuration file in your repository. +* To group as many available security updates together as possible, across directories and per ecosystem, enable grouping in the "Code security and analysis" settings for your organization or repository. +* For more granular control of grouping, such as grouping by package name, development/production dependencies, or SemVer level, add configuration options to the `dependabot.yml` configuration file in your repository. diff --git a/data/reusables/dependabot/dependabot-ignore-dependencies.md b/data/reusables/dependabot/dependabot-ignore-dependencies.md index 33032cf6de..46e2514f37 100644 --- a/data/reusables/dependabot/dependabot-ignore-dependencies.md +++ b/data/reusables/dependabot/dependabot-ignore-dependencies.md @@ -1,4 +1,4 @@ If you want to ignore updates for the dependency, you must do one of the following. -- Configure an `ignore` rule for the dependency in the `dependabot.yml` file. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#ignore)." -- Use the `@dependabot ignore` comment command for the dependency in the pull request for the grouped updates. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-for-grouped-{% ifversion dependabot-grouped-security-updates-config %}{% else %}version-{% endif %}updates-with-comment-commands)." +* Configure an `ignore` rule for the dependency in the `dependabot.yml` file. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#ignore)." +* Use the `@dependabot ignore` comment command for the dependency in the pull request for the grouped updates. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-for-grouped-{% ifversion dependabot-grouped-security-updates-config %}{% else %}version-{% endif %}updates-with-comment-commands)." diff --git a/data/reusables/dependabot/dependabot-overview.md b/data/reusables/dependabot/dependabot-overview.md index efd344aa64..0d732e50ff 100644 --- a/data/reusables/dependabot/dependabot-overview.md +++ b/data/reusables/dependabot/dependabot-overview.md @@ -1,5 +1,5 @@ {% data variables.product.prodname_dependabot %} consists of three different features that help you manage your dependencies: -- {% data variables.product.prodname_dependabot_alerts %}—inform you about vulnerabilities in the dependencies that you use in your repository. -- {% data variables.product.prodname_dependabot_security_updates %}—automatically raise pull requests to update the dependencies you use that have known security vulnerabilities. -- {% data variables.product.prodname_dependabot_version_updates %}—automatically raise pull requests to keep your dependencies up-to-date. +* {% data variables.product.prodname_dependabot_alerts %}—inform you about vulnerabilities in the dependencies that you use in your repository. +* {% data variables.product.prodname_dependabot_security_updates %}—automatically raise pull requests to update the dependencies you use that have known security vulnerabilities. +* {% data variables.product.prodname_dependabot_version_updates %}—automatically raise pull requests to keep your dependencies up-to-date. diff --git a/data/reusables/dependabot/dependabot-runners-system-requirements.md b/data/reusables/dependabot/dependabot-runners-system-requirements.md index 20091f92d4..11472d2aea 100644 --- a/data/reusables/dependabot/dependabot-runners-system-requirements.md +++ b/data/reusables/dependabot/dependabot-runners-system-requirements.md @@ -1,11 +1,11 @@ Any virtual machine (VM) that you use for {% data variables.product.prodname_dependabot %} runners must meet the requirements for self-hosted runners. In addition, they must meet the following requirements. -- Linux operating system -- x64 architecture +* Linux operating system +* x64 architecture -- Docker installed with access for the runner users: - - We recommend installing Docker in rootless mode and configuring the runners to access Docker without `root` privileges. - - Alternatively, install Docker and give the runner users raised privileges to run Docker. +* Docker installed with access for the runner users: + * We recommend installing Docker in rootless mode and configuring the runners to access Docker without `root` privileges. + * Alternatively, install Docker and give the runner users raised privileges to run Docker. The CPU and memory requirements will depend on the number of concurrent runners you deploy on a given VM. As guidance, we have successfully set up 20 runners on a single 2 CPU 8GB machine, but ultimately, your CPU and memory requirements will heavily depend on the repositories being updated. Some ecosystems will require more resources than others. diff --git a/data/reusables/dependabot/dependabot-updates-registries.md b/data/reusables/dependabot/dependabot-updates-registries.md index 132c581d4a..5d8a2cf7dd 100644 --- a/data/reusables/dependabot/dependabot-updates-registries.md +++ b/data/reusables/dependabot/dependabot-updates-registries.md @@ -1,7 +1,7 @@ There are 2 locations in the `dependabot.yml` file where you can use the `registries` key: -- At the top level, where you define the registries and their access information, if needed. -- Within the `updates` blocks, where you can use `registries: "*"` to tell {% data variables.product.prodname_dependabot %} to use any or all of the registries you defined at the top level. +* At the top level, where you define the registries and their access information, if needed. +* Within the `updates` blocks, where you can use `registries: "*"` to tell {% data variables.product.prodname_dependabot %} to use any or all of the registries you defined at the top level. ```yaml # registries: gradle-artifactory - provides access details for the gradle-artifactory registry diff --git a/data/reusables/dependabot/pull-request-security-vs-version-updates.md b/data/reusables/dependabot/pull-request-security-vs-version-updates.md index a1dee59915..12a1067cfc 100644 --- a/data/reusables/dependabot/pull-request-security-vs-version-updates.md +++ b/data/reusables/dependabot/pull-request-security-vs-version-updates.md @@ -1,4 +1,4 @@ When {% data variables.product.prodname_dependabot %} raises pull requests, these pull requests could be for _security_ or _version_ updates: -- _{% data variables.product.prodname_dependabot_security_updates %}_ are automated pull requests that help you update dependencies with known vulnerabilities. -- _{% data variables.product.prodname_dependabot_version_updates %}_ are automated pull requests that keep your dependencies updated, even when they don’t have any vulnerabilities. To check the status of version updates, navigate to the Insights tab of your repository, then Dependency Graph, and {% data variables.product.prodname_dependabot %}. +* _{% data variables.product.prodname_dependabot_security_updates %}_ are automated pull requests that help you update dependencies with known vulnerabilities. +* _{% data variables.product.prodname_dependabot_version_updates %}_ are automated pull requests that keep your dependencies updated, even when they don’t have any vulnerabilities. To check the status of version updates, navigate to the Insights tab of your repository, then Dependency Graph, and {% data variables.product.prodname_dependabot %}. diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index 66199f339c..f5848e6076 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -1,8 +1,8 @@ The following table shows, for each package manager: -- The YAML value to use in the `dependabot.yml` file -- The supported versions of the package manager -- Whether dependencies in private {% data variables.product.prodname_dotcom %} repositories or registries are supported -- Whether vendored dependencies are supported +* The YAML value to use in the `dependabot.yml` file +* The supported versions of the package manager +* Whether dependencies in private {% data variables.product.prodname_dotcom %} repositories or registries are supported +* Whether vendored dependencies are supported Package manager | YAML value | Supported versions | Private repositories | Private registries | Vendoring ---------------|------------------|------------------|:---:|:---:|:---: @@ -85,9 +85,9 @@ For more information about using {% data variables.product.prodname_dependabot_v {% ifversion dependabot-security-updates-gradle-support %}{% else %}Gradle is supported for {% data variables.product.prodname_dependabot_version_updates %} only.{% endif %} {% data variables.product.prodname_dependabot %} doesn't run Gradle but supports updates to the following files: -- `build.gradle`, `build.gradle.kts` (for Kotlin projects){% ifversion dependabot-updates-gradle-versions-catalog-support %} -- `gradle/libs.versions.toml` (for projects using a standard Gradle version catalog){% endif %} -- Files included via the `apply` declaration that have `dependencies` in the filename. Note that `apply` does not support `apply to`, recursion, or advanced syntaxes (for example, Kotlin's `apply` with `mapOf`, filenames defined by property). +* `build.gradle`, `build.gradle.kts` (for Kotlin projects){% ifversion dependabot-updates-gradle-versions-catalog-support %} +* `gradle/libs.versions.toml` (for projects using a standard Gradle version catalog){% endif %} +* Files included via the `apply` declaration that have `dependencies` in the filename. Note that `apply` does not support `apply to`, recursion, or advanced syntaxes (for example, Kotlin's `apply` with `mapOf`, filenames defined by property). {% ifversion dependabot-security-updates-gradle-support %} For {% data variables.product.prodname_dependabot_security_updates %}, Gradle support is limited to manual uploads of the dependency graph data using the {% data variables.dependency-submission-api.name %}. For more information about the {% data variables.dependency-submission-api.name %}, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)." @@ -96,8 +96,8 @@ For {% data variables.product.prodname_dependabot_security_updates %}, Gradle su **Notes:** -- When you upload Gradle dependencies to the dependency graph using the {% data variables.dependency-submission-api.name %}, all project dependencies are uploaded, even transitive dependencies that aren't explicitly mentioned in any dependency file. When an alert is detected in a transitive dependency, {% data variables.product.prodname_dependabot %} isn't able to find the vulnerable dependency in the repository, and therefore won't create a security update for that alert. -- {% data variables.product.prodname_dependabot_version_updates %} will, however, create pull requests when the parent dependency is explicitly declared as a direct dependency in the project's manifest file. +* When you upload Gradle dependencies to the dependency graph using the {% data variables.dependency-submission-api.name %}, all project dependencies are uploaded, even transitive dependencies that aren't explicitly mentioned in any dependency file. When an alert is detected in a transitive dependency, {% data variables.product.prodname_dependabot %} isn't able to find the vulnerable dependency in the repository, and therefore won't create a security update for that alert. +* {% data variables.product.prodname_dependabot_version_updates %} will, however, create pull requests when the parent dependency is explicitly declared as a direct dependency in the project's manifest file. {% endnote %} {% endif %} @@ -148,9 +148,9 @@ Private registry support applies to git registries only. Swift registries are no #### Terraform Terraform support includes: -- Modules hosted on Terraform Registry or a publicly reachable Git repository. -- Terraform providers. -- Private Terraform Registry. You can configure access for private git repositories by specifying a git registry in your `dependabot.yml` file. For more information, see [`git`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#git). +* Modules hosted on Terraform Registry or a publicly reachable Git repository. +* Terraform providers. +* Private Terraform Registry. You can configure access for private git repositories by specifying a git registry in your `dependabot.yml` file. For more information, see [`git`](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#git). #### yarn diff --git a/data/reusables/dependabot/vulnerable-calls-beta.md b/data/reusables/dependabot/vulnerable-calls-beta.md index 0a5cddc583..6d0647a97a 100644 --- a/data/reusables/dependabot/vulnerable-calls-beta.md +++ b/data/reusables/dependabot/vulnerable-calls-beta.md @@ -4,8 +4,8 @@ **Notes:** -- The detection of calls to vulnerable functions by {% data variables.product.prodname_dependabot %} is in beta and subject to change. -- {% data reusables.gated-features.dependency-vulnerable-calls %} +* The detection of calls to vulnerable functions by {% data variables.product.prodname_dependabot %} is in beta and subject to change. +* {% data reusables.gated-features.dependency-vulnerable-calls %} {% endnote %} {% endif %} diff --git a/data/reusables/dependency-graph/sbom-intro.md b/data/reusables/dependency-graph/sbom-intro.md index 965ca9a761..599a49e00c 100644 --- a/data/reusables/dependency-graph/sbom-intro.md +++ b/data/reusables/dependency-graph/sbom-intro.md @@ -1,6 +1,6 @@ An SBOM is a formal, machine-readable inventory of a project's dependencies and associated information (such as {%ifversion ghes %}versions and package identifiers{%else %}versions, package identifiers, and licenses{% endif %}). SBOMs help reduced supply chain risks by: -- providing transparency about the dependencies used by your repository -- allowing vulnerabilities to be identified early in the process -- providing insights in the license compliance, security, or quality issues that may exist in your codebase -- enabling you to better comply with various data protection standards +* providing transparency about the dependencies used by your repository +* allowing vulnerabilities to be identified early in the process +* providing insights in the license compliance, security, or quality issues that may exist in your codebase +* enabling you to better comply with various data protection standards diff --git a/data/reusables/dependency-review/feature-overview.md b/data/reusables/dependency-review/feature-overview.md index b36f11c93b..e015422fc8 100644 --- a/data/reusables/dependency-review/feature-overview.md +++ b/data/reusables/dependency-review/feature-overview.md @@ -1,4 +1,4 @@ {% data reusables.dependency-review.short-summary %} It provides an easily understandable visualization of dependency changes with a rich diff on the "Files Changed" tab of a pull request. Dependency review informs you of: -- Which dependencies were added, removed, or updated, along with the release dates. -- How many projects use these components. -- Vulnerability data for these dependencies. +* Which dependencies were added, removed, or updated, along with the release dates. +* How many projects use these components. +* Vulnerability data for these dependencies. diff --git a/data/reusables/desktop/2fa-in-browser.md b/data/reusables/desktop/2fa-in-browser.md index 2d17c76740..e9c87023e6 100644 --- a/data/reusables/desktop/2fa-in-browser.md +++ b/data/reusables/desktop/2fa-in-browser.md @@ -1,5 +1,5 @@ 1. If you have configured two-factor authentication (2FA) for {% data variables.product.prodname_dotcom %}, do one of the following: - - If you set up 2FA via SMS, retrieve your 2FA code from an SMS message. - - If you set up 2FA with a TOTP application, generate a 2FA code. + * If you set up 2FA via SMS, retrieve your 2FA code from an SMS message. + * If you set up 2FA with a TOTP application, generate a 2FA code. Then enter your 2FA code in the prompt on {% data variables.product.prodname_dotcom %} and click **Verify**. diff --git a/data/reusables/desktop/delete-tag.md b/data/reusables/desktop/delete-tag.md index 9c6af618d3..80812dcacb 100644 --- a/data/reusables/desktop/delete-tag.md +++ b/data/reusables/desktop/delete-tag.md @@ -1,6 +1,6 @@ 1. Right-click the commit. - - If a commit has only one tag, click **Delete Tag TAG NAME**. + * If a commit has only one tag, click **Delete Tag TAG NAME**. ![Screenshot of a list of commits in the "History" tab. Next to a commit, in a context menu, the cursor hovers over an option labeled "Delete tag hello-tag".](/assets/images/help/desktop/select-delete-tag.png) - - If a commit has multiple tags, hover over **Delete Tag...** and then click the tag that you want to delete. + * If a commit has multiple tags, hover over **Delete Tag...** and then click the tag that you want to delete. ![Screenshot of a context menu in the "History" tab. Next to "Delete tag", a second menu is expanded, and the cursor hovers over an option labeled "hello-tag".](/assets/images/help/desktop/delete-tag-multiple.png) diff --git a/data/reusables/desktop/fork-type-prompt.md b/data/reusables/desktop/fork-type-prompt.md index 2772b58949..5e966919a5 100644 --- a/data/reusables/desktop/fork-type-prompt.md +++ b/data/reusables/desktop/fork-type-prompt.md @@ -1,4 +1,4 @@ 1. Read the information in the "How are you planning to use this fork?" window. - - If you plan to use this fork for contributing to the original upstream repository, click **To contribute to the parent project**. - - If you plan to use this fork for a project not connected to the upstream, click **For my own purposes**. + * If you plan to use this fork for contributing to the original upstream repository, click **To contribute to the parent project**. + * If you plan to use this fork for a project not connected to the upstream, click **For my own purposes**. 1. Click **Continue**. diff --git a/data/reusables/desktop/preferences-options-tabs.md b/data/reusables/desktop/preferences-options-tabs.md index 927b6db83c..4975bb5984 100644 --- a/data/reusables/desktop/preferences-options-tabs.md +++ b/data/reusables/desktop/preferences-options-tabs.md @@ -1,8 +1,8 @@ You can choose from the following options. -- Choose **Accounts** to add or remove a {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %} account. -- Choose **Integrations** to pick an external editor or shell. -- Choose **Git** to edit your Git configuration. -- Choose **Appearance** to switch between the light or dark theme. -- Choose **Prompts** to enable or disable confirmation dialogs before performing destructive actions. -- Choose **Advanced** for more configuration options. -- Choose **Accessibility** to configure accessibility options. +* Choose **Accounts** to add or remove a {% data variables.product.prodname_dotcom %} or {% data variables.product.prodname_enterprise %} account. +* Choose **Integrations** to pick an external editor or shell. +* Choose **Git** to edit your Git configuration. +* Choose **Appearance** to switch between the light or dark theme. +* Choose **Prompts** to enable or disable confirmation dialogs before performing destructive actions. +* Choose **Advanced** for more configuration options. +* Choose **Accessibility** to configure accessibility options. diff --git a/data/reusables/desktop/retrieve-2fa.md b/data/reusables/desktop/retrieve-2fa.md index 87839ca82f..4361ffe5e6 100644 --- a/data/reusables/desktop/retrieve-2fa.md +++ b/data/reusables/desktop/retrieve-2fa.md @@ -1,3 +1,3 @@ 1. If you have configured two-factor authentication for {% data variables.product.prodname_enterprise %}, do one of the following: - - If you set up 2FA via SMS, retrieve your 2FA code from an SMS message. - - If you set up 2FA with a TOTP application, generate a 2FA code. + * If you set up 2FA via SMS, retrieve your 2FA code from an SMS message. + * If you set up 2FA with a TOTP application, generate a 2FA code. diff --git a/data/reusables/dotcom_billing/500-error.md b/data/reusables/dotcom_billing/500-error.md index 35397b6d6f..14ed56ed94 100644 --- a/data/reusables/dotcom_billing/500-error.md +++ b/data/reusables/dotcom_billing/500-error.md @@ -1,5 +1,5 @@ If you receive a 500 error when trying to upgrade your account: -- Try clearing your browser's cache, then resubmit your information -- Check to make sure you have entered your payment data correctly +* Try clearing your browser's cache, then resubmit your information +* Check to make sure you have entered your payment data correctly If that doesn't resolve the error, please contact {% data variables.contact.contact_support %}. diff --git a/data/reusables/dotcom_billing/actions-packages-unpaid-account.md b/data/reusables/dotcom_billing/actions-packages-unpaid-account.md index b3d1715820..dc87bcb5ee 100644 --- a/data/reusables/dotcom_billing/actions-packages-unpaid-account.md +++ b/data/reusables/dotcom_billing/actions-packages-unpaid-account.md @@ -1,5 +1,5 @@ If your account has outstanding unpaid charges: -- The storage or minutes included in your account for {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} will not be reset until the payment has been successfully processed. -- For accounts with storage or minutes remaining for the current billing period, {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} will continue to be available until any included usage has been reached. -- For accounts that have reached the included usage for the current billing period for {% data variables.product.prodname_actions %} or {% data variables.product.prodname_registry %}, both {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} will be disabled to prevent any further overages. +* The storage or minutes included in your account for {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} will not be reset until the payment has been successfully processed. +* For accounts with storage or minutes remaining for the current billing period, {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} will continue to be available until any included usage has been reached. +* For accounts that have reached the included usage for the current billing period for {% data variables.product.prodname_actions %} or {% data variables.product.prodname_registry %}, both {% data variables.product.prodname_actions %} and {% data variables.product.prodname_registry %} will be disabled to prevent any further overages. diff --git a/data/reusables/education/access-github-community-exchange.md b/data/reusables/education/access-github-community-exchange.md index 3e7f64a9ef..476212bac4 100644 --- a/data/reusables/education/access-github-community-exchange.md +++ b/data/reusables/education/access-github-community-exchange.md @@ -2,6 +2,6 @@ To access {% data variables.product.prodname_community_exchange %}, visit your { If you're a student or faculty member at an accredited educational institution, you can apply for {% data variables.product.prodname_education %} benefits, which includes access to {% data variables.product.prodname_community_exchange %} within {% data variables.product.prodname_global_campus %}. -- If you’re a student and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [student application form]( https://education.github.com/discount_requests/student_application). For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students)." +* If you’re a student and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [student application form]( https://education.github.com/discount_requests/student_application). For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/about-github-global-campus-for-students)." -- If you’re an educator and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [teacher application form]( https://education.github.com/discount_requests/teacher_application). For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." +* If you’re an educator and you haven't joined {% data variables.product.prodname_education %} yet, apply using the [teacher application form]( https://education.github.com/discount_requests/teacher_application). For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher)." diff --git a/data/reusables/education/apply-for-team.md b/data/reusables/education/apply-for-team.md index 1e10a07a15..1472264174 100644 --- a/data/reusables/education/apply-for-team.md +++ b/data/reusables/education/apply-for-team.md @@ -1 +1 @@ -- Apply for free [{% data variables.product.prodname_team %}](/get-started/learning-about-github/githubs-plans), which allows unlimited users and private repositories. For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher)." +* Apply for free [{% data variables.product.prodname_team %}](/get-started/learning-about-github/githubs-plans), which allows unlimited users and private repositories. For more information, see "[AUTOTITLE](/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-education-for-teachers/apply-to-github-education-as-a-teacher)." diff --git a/data/reusables/education/educator-requirements.md b/data/reusables/education/educator-requirements.md index 06043d3f70..2f82bbe23e 100644 --- a/data/reusables/education/educator-requirements.md +++ b/data/reusables/education/educator-requirements.md @@ -1,6 +1,6 @@ To apply for teacher benefits and {% data variables.product.prodname_global_campus %} access, you must meet the following requirements. -- Be an educator, faculty member, or researcher. -- Have a verifiable school-issued email address. -- Upload documents that prove your school affiliation. -- Have a personal account on {% data variables.product.product_name %}. +* Be an educator, faculty member, or researcher. +* Have a verifiable school-issued email address. +* Upload documents that prove your school affiliation. +* Have a personal account on {% data variables.product.product_name %}. diff --git a/data/reusables/education/upload-proof-status.md b/data/reusables/education/upload-proof-status.md index fe7e3ed797..e69237bad1 100644 --- a/data/reusables/education/upload-proof-status.md +++ b/data/reusables/education/upload-proof-status.md @@ -1,7 +1,7 @@ 1. Click **Continue**, and then you will be prompted to upload proof of your academic status. - - Click **Take a picture** to use your computer's camera to upload proof. + * Click **Take a picture** to use your computer's camera to upload proof. ![Screenshot of page for providing photo proof of your academic status. The "Take a picture" button is outlined in dark orange.](/assets/images/help/education/upload-proof-status.png) - - Optionally, use the camera drop-down menu to change the camera you want to use, if you have multiple cameras available. - - Place your valid academic ID or other proof of current academic status in the frame, then click **Take photo**. - - Under "Proof Type", use the dropdown to select the type of proof you are providing. + * Optionally, use the camera drop-down menu to change the camera you want to use, if you have multiple cameras available. + * Place your valid academic ID or other proof of current academic status in the frame, then click **Take photo**. + * Under "Proof Type", use the dropdown to select the type of proof you are providing. diff --git a/data/reusables/emus/giving-access-to-guest-collaborators.md b/data/reusables/emus/giving-access-to-guest-collaborators.md index 4160f19f16..7553efa663 100644 --- a/data/reusables/emus/giving-access-to-guest-collaborators.md +++ b/data/reusables/emus/giving-access-to-guest-collaborators.md @@ -1,3 +1,3 @@ When you have added a guest collaborator to your enterprise, to give the user access to repositories in the enterprise, you can do either of the following things. -- To give the user access to repositories in an organization, add the user as a member of the organization. The base permission policy for the organization determines whether the guest collaborator has access to internal and private repositories. If the base permission is set to "No permission", the guest collaborator will not have access to internal and private repositories unless added directly to one of the repositories as a collaborator, or through an authorized team. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization)." -- To give the user access to specific repositories, add the guest collaborator to the repositories as a repository collaborator. This gives the user access to the repository without giving them access to other internal or private repositories in the same organization. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators-or-repository-collaborators)." +* To give the user access to repositories in an organization, add the user as a member of the organization. The base permission policy for the organization determines whether the guest collaborator has access to internal and private repositories. If the base permission is set to "No permission", the guest collaborator will not have access to internal and private repositories unless added directly to one of the repositories as a collaborator, or through an authorized team. For more information, see "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/setting-base-permissions-for-an-organization)." +* To give the user access to specific repositories, add the guest collaborator to the repositories as a repository collaborator. This gives the user access to the repository without giving them access to other internal or private repositories in the same organization. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#outside-collaborators-or-repository-collaborators)." diff --git a/data/reusables/emus/migration-roles-prereq.md b/data/reusables/emus/migration-roles-prereq.md index c38a4572ee..b3b70fcd87 100644 --- a/data/reusables/emus/migration-roles-prereq.md +++ b/data/reusables/emus/migration-roles-prereq.md @@ -1,4 +1,4 @@ -- You'll need to access both your enterprise on {% data variables.location.product_location %} and your tenant on Entra ID. +* You'll need to access both your enterprise on {% data variables.location.product_location %} and your tenant on Entra ID. - - To configure the {% data variables.product.prodname_emu_idp_oidc_application %} application on Entra ID, you must sign into the Entra ID tenant as a user with the Global Administrator role. - - To sign in as the setup user for your enterprise on {% data variables.location.product_location %}, you must use a recovery code for the enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." + * To configure the {% data variables.product.prodname_emu_idp_oidc_application %} application on Entra ID, you must sign into the Entra ID tenant as a user with the Global Administrator role. + * To sign in as the setup user for your enterprise on {% data variables.location.product_location %}, you must use a recovery code for the enterprise. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/managing-recovery-codes-for-your-enterprise/downloading-your-enterprise-accounts-single-sign-on-recovery-codes)." diff --git a/data/reusables/emus/migration-schedule-downtime.md b/data/reusables/emus/migration-schedule-downtime.md index 7c0378bf2c..3f2c8bb2c2 100644 --- a/data/reusables/emus/migration-schedule-downtime.md +++ b/data/reusables/emus/migration-schedule-downtime.md @@ -1 +1 @@ -- Schedule a time to migrate when people aren't actively using your enterprise's resources. During the migration, users cannot access your enterprise until after you configure the new application and users as re-provisioned. +* Schedule a time to migrate when people aren't actively using your enterprise's resources. During the migration, users cannot access your enterprise until after you configure the new application and users as re-provisioned. diff --git a/data/reusables/enterprise-accounts/dormant-user-activity.md b/data/reusables/enterprise-accounts/dormant-user-activity.md index 324a199e1c..05fb420183 100644 --- a/data/reusables/enterprise-accounts/dormant-user-activity.md +++ b/data/reusables/enterprise-accounts/dormant-user-activity.md @@ -1,27 +1,27 @@ A user is considered active if the user has performed any of the following activities on {% ifversion fpt or ghes %}{% data variables.location.product_location %}{% elsif ghec %}your enterprise{% endif %}. -- {% ifversion ghec%}Authenticating to access your enterprise's resources via SAML SSO{% else %}Signing into {% data variables.location.product_location %} {% endif %} -- Creating a repository -- Pushing to a repository via HTTPS +* {% ifversion ghec%}Authenticating to access your enterprise's resources via SAML SSO{% else %}Signing into {% data variables.location.product_location %} {% endif %} +* Creating a repository +* Pushing to a repository via HTTPS {% ifversion ghes %}- Pushing to a repository via SSH{% endif %} -- Being added to a repository -- Changing the visibility of a repository -- Creating an issue or pull request -- Commenting on an issue or pull request -- Closing or reopening an issue or pull request -- Applying a label to an issue or pull request, or removing a label -- Assigning or unassigning an issue or pull request -- Requesting a review of a pull request, or removing a review request -- Creating or editing a comment in a pull request review -- Dismissing a comment in a pull request -- Synchronizing a pull request -- Commenting on a commit -- Publishing a release -- Pushing to a wiki{% ifversion not ghec %} -- Watching a repository{% endif %} -- Starring a repository -- Deleting a repository -- Joining an organization +* Being added to a repository +* Changing the visibility of a repository +* Creating an issue or pull request +* Commenting on an issue or pull request +* Closing or reopening an issue or pull request +* Applying a label to an issue or pull request, or removing a label +* Assigning or unassigning an issue or pull request +* Requesting a review of a pull request, or removing a review request +* Creating or editing a comment in a pull request review +* Dismissing a comment in a pull request +* Synchronizing a pull request +* Commenting on a commit +* Publishing a release +* Pushing to a wiki{% ifversion not ghec %} +* Watching a repository{% endif %} +* Starring a repository +* Deleting a repository +* Joining an organization {% ifversion ghes %} A user will also be considered active if their account has been updated by LDAP. diff --git a/data/reusables/enterprise-migration-tool/bitbucket-server-migrate-repo-access.md b/data/reusables/enterprise-migration-tool/bitbucket-server-migrate-repo-access.md index 69b4f8a1ed..a01fe6bfd0 100644 --- a/data/reusables/enterprise-migration-tool/bitbucket-server-migrate-repo-access.md +++ b/data/reusables/enterprise-migration-tool/bitbucket-server-migrate-repo-access.md @@ -1,6 +1,6 @@ You must follow this step from a computer that can access: -- Your Bitbucket Server instance via HTTPS -- Your Bitbucket Server instance via SFTP, if your Bitbucket Server instance runs on Linux. In general, if you can access the server via SSH, then you can also use SFTP. -- Your Bitbucket Server instance via SMB, if your Bitbucket Server instance runs on Windows -- Your chosen blob storage provider +* Your Bitbucket Server instance via HTTPS +* Your Bitbucket Server instance via SFTP, if your Bitbucket Server instance runs on Linux. In general, if you can access the server via SSH, then you can also use SFTP. +* Your Bitbucket Server instance via SMB, if your Bitbucket Server instance runs on Windows +* Your chosen blob storage provider diff --git a/data/reusables/enterprise-migration-tool/branch-protection-migration.md b/data/reusables/enterprise-migration-tool/branch-protection-migration.md index 5f516b17fd..bd0ad5d43f 100644 --- a/data/reusables/enterprise-migration-tool/branch-protection-migration.md +++ b/data/reusables/enterprise-migration-tool/branch-protection-migration.md @@ -2,14 +2,14 @@ Branch protections apply a specified set of rules to a specific branch name or b Branch protections will always be migrated, but certain rules will not be migrated. The following branch protection rules are not migrated. -- Allow specific actors to bypass required pull requests -- Require approval of the most recent push -- Require deployments to succeed before merging -- Lock branch -- Restrict pushes that create matching branches -- Allow force pushes +* Allow specific actors to bypass required pull requests +* Require approval of the most recent push +* Require deployments to succeed before merging +* Lock branch +* Restrict pushes that create matching branches +* Allow force pushes The following limitations also apply: -- If a branch protection rule optionally allows you to specify people, teams, or apps that are exempt from the rule, such as "Restrict who can dismiss pull request reviews," the exceptions will not be migrated. -- If the "Allow force pushes" rule is enabled in "Specify who can force push" mode, the rule will not be migrated. +* If a branch protection rule optionally allows you to specify people, teams, or apps that are exempt from the rule, such as "Restrict who can dismiss pull request reviews," the exceptions will not be migrated. +* If the "Allow force pushes" rule is enabled in "Specify who can force push" mode, the rule will not be migrated. diff --git a/data/reusables/enterprise-migration-tool/checking-the-migration-status.md b/data/reusables/enterprise-migration-tool/checking-the-migration-status.md index 894ebda79b..d816ccdd54 100644 --- a/data/reusables/enterprise-migration-tool/checking-the-migration-status.md +++ b/data/reusables/enterprise-migration-tool/checking-the-migration-status.md @@ -2,13 +2,13 @@ First, check whether your migration succeeded or failed. The way you check the status of your migration depends on how you ran the migration. -- If you ran the migration using the {% data variables.product.prodname_cli %}, by default, the process will display whether the migration succeeded or failed once the migration is complete. If the migration failed, you will see the reason for failure. +* If you ran the migration using the {% data variables.product.prodname_cli %}, by default, the process will display whether the migration succeeded or failed once the migration is complete. If the migration failed, you will see the reason for failure. ```text Migration completed (ID: RM_123)! State: SUCCEEDED ``` -- If you ran the migration using the {% data variables.product.prodname_cli %} with the optional `--queue-only` argument, the process will exit immediately after queueing the migration, and will not tell you if the migration succeeded or failed. You can check a migration's status using the `wait-for-migration` command, or by reviewing the migration log. -- If you ran the migration using the GraphQL API, you can query the `state` and `failureReason` fields on the `RepositoryMigration` object. +* If you ran the migration using the {% data variables.product.prodname_cli %} with the optional `--queue-only` argument, the process will exit immediately after queueing the migration, and will not tell you if the migration succeeded or failed. You can check a migration's status using the `wait-for-migration` command, or by reviewing the migration log. +* If you ran the migration using the GraphQL API, you can query the `state` and `failureReason` fields on the `RepositoryMigration` object. If the migration failed, the migration log may contain additional information about the cause of the failure. For more information, see "[Reviewing the migration log](#reviewing-the-migration-log)." diff --git a/data/reusables/enterprise-migration-tool/configuring-ip-allow-lists.md b/data/reusables/enterprise-migration-tool/configuring-ip-allow-lists.md index 620ae52398..7d2c9f3e45 100644 --- a/data/reusables/enterprise-migration-tool/configuring-ip-allow-lists.md +++ b/data/reusables/enterprise-migration-tool/configuring-ip-allow-lists.md @@ -1,6 +1,6 @@ If the source or destination of your migration uses an IP allow list (either {% data variables.product.company_short %}'s IP allow list feature or your identity provider's (IdP) IP allow list restrictions, such as Azure CAP), you need to configure IP allow lists on {% data variables.product.prodname_dotcom %}. -- If you use {% data variables.product.company_short %}'s IP allow list feature, you must add the {% data variables.product.prodname_dotcom %} IP ranges below to the allow list for the source and/or destination organizations. -- If you use your IdP's IP allow list to restrict access to your enterprise on {% data variables.product.prodname_dotcom %}, you should disable these restrictions in your enterprise account settings until after your migration is complete. +* If you use {% data variables.product.company_short %}'s IP allow list feature, you must add the {% data variables.product.prodname_dotcom %} IP ranges below to the allow list for the source and/or destination organizations. +* If you use your IdP's IP allow list to restrict access to your enterprise on {% data variables.product.prodname_dotcom %}, you should disable these restrictions in your enterprise account settings until after your migration is complete. For more information, see "[AUTOTITLE](/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization)" and "[AUTOTITLE](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise-with-an-ip-allow-list)." diff --git a/data/reusables/enterprise-migration-tool/data-not-migrated.md b/data/reusables/enterprise-migration-tool/data-not-migrated.md index a496640be7..52d0620770 100644 --- a/data/reusables/enterprise-migration-tool/data-not-migrated.md +++ b/data/reusables/enterprise-migration-tool/data-not-migrated.md @@ -1,23 +1,23 @@ -- {% data variables.product.prodname_code_scanning_caps %} results -- Commit status checks -- {% data variables.product.prodname_dependabot %} alerts -- {% data variables.product.prodname_dependabot %} secrets -- Discussions at the repository level -- Edit history of issue comments and pull request comments -- Fork relationships between repositories (see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)") -- {% data variables.product.prodname_actions %} secrets, variables, environments, self-hosted runners, {% data variables.actions.hosted_runner %}s, or workflow run history -- GitHub Apps and GitHub App installations -- {% data variables.large_files.product_name_short %} objects and large binaries (repositories using {% data variables.large_files.product_name_short %} are still supported, see "[Limitations of {% data variables.product.prodname_importer_proper_name %}](#limitations-of-github-enterprise-importer)") -- Packages in {% data variables.product.prodname_registry %} -- Projects (classic) at the organization level -- {% data variables.product.prodname_projects_v2 %} (the new projects experience) -- References between pull requests and issues in different repositories (see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls)") -- Remediation states of {% data variables.product.prodname_secret_scanning %} results -- Repositories owned by user accounts{% ifversion repository-properties %} -- Repository properties{% endif %} -- Repository stars -- Repository watchers -- Rulesets -- Tag protection rules -- Users' profiles, SSH keys, signing keys, or {% data variables.product.pat_generic_plural %} -- Webhook secrets +* {% data variables.product.prodname_code_scanning_caps %} results +* Commit status checks +* {% data variables.product.prodname_dependabot %} alerts +* {% data variables.product.prodname_dependabot %} secrets +* Discussions at the repository level +* Edit history of issue comments and pull request comments +* Fork relationships between repositories (see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)") +* {% data variables.product.prodname_actions %} secrets, variables, environments, self-hosted runners, {% data variables.actions.hosted_runner %}s, or workflow run history +* GitHub Apps and GitHub App installations +* {% data variables.large_files.product_name_short %} objects and large binaries (repositories using {% data variables.large_files.product_name_short %} are still supported, see "[Limitations of {% data variables.product.prodname_importer_proper_name %}](#limitations-of-github-enterprise-importer)") +* Packages in {% data variables.product.prodname_registry %} +* Projects (classic) at the organization level +* {% data variables.product.prodname_projects_v2 %} (the new projects experience) +* References between pull requests and issues in different repositories (see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls)") +* Remediation states of {% data variables.product.prodname_secret_scanning %} results +* Repositories owned by user accounts{% ifversion repository-properties %} +* Repository properties{% endif %} +* Repository stars +* Repository watchers +* Rulesets +* Tag protection rules +* Users' profiles, SSH keys, signing keys, or {% data variables.product.pat_generic_plural %} +* Webhook secrets diff --git a/data/reusables/enterprise-migration-tool/edit-csv.md b/data/reusables/enterprise-migration-tool/edit-csv.md index e0512ebb50..b30b50bbb1 100644 --- a/data/reusables/enterprise-migration-tool/edit-csv.md +++ b/data/reusables/enterprise-migration-tool/edit-csv.md @@ -1,2 +1,2 @@ -- Edit the CSV file, adding the username of the organization member that corresponds to each mannequin. -- Save the file. +* Edit the CSV file, adding the username of the organization member that corresponds to each mannequin. +* Save the file. diff --git a/data/reusables/enterprise-migration-tool/env-variables-gei.md b/data/reusables/enterprise-migration-tool/env-variables-gei.md index 2888054976..78304b63bb 100644 --- a/data/reusables/enterprise-migration-tool/env-variables-gei.md +++ b/data/reusables/enterprise-migration-tool/env-variables-gei.md @@ -1,13 +1,13 @@ 1. Set environment variables for the {% data variables.product.pat_generic %}s, replacing TOKEN in the commands below with the {% data variables.product.pat_generic %}s you recorded above. Use `GH_PAT` for the destination organization and `GH_SOURCE_PAT` for the source organization. - - If you're using Terminal, use the `export` command. + * If you're using Terminal, use the `export` command. ```shell copy export GH_PAT="TOKEN" export GH_SOURCE_PAT="TOKEN" ``` - - If you're using PowerShell, use the `$env` command. + * If you're using PowerShell, use the `$env` command. ```shell copy $env:GH_PAT="TOKEN" diff --git a/data/reusables/enterprise-migration-tool/grant-migrator-role-pat.md b/data/reusables/enterprise-migration-tool/grant-migrator-role-pat.md index f1310e2c36..b277e7b9ab 100644 --- a/data/reusables/enterprise-migration-tool/grant-migrator-role-pat.md +++ b/data/reusables/enterprise-migration-tool/grant-migrator-role-pat.md @@ -1,12 +1,12 @@ 1. Set the {% data variables.product.pat_generic %} as an environment variable, replacing TOKEN in the commands below with the {% data variables.product.pat_generic %} you recorded above. - - If you're using Terminal, use the `export` command. + * If you're using Terminal, use the `export` command. ```shell copy export GH_PAT="TOKEN" ``` - - If you're using PowerShell, use the `$env` command. + * If you're using PowerShell, use the `$env` command. ```shell copy $env:GH_PAT="TOKEN" diff --git a/data/reusables/enterprise-migration-tool/identifying-githubs-ip-ranges.md b/data/reusables/enterprise-migration-tool/identifying-githubs-ip-ranges.md index 94f7979bfd..0d8642ba1d 100644 --- a/data/reusables/enterprise-migration-tool/identifying-githubs-ip-ranges.md +++ b/data/reusables/enterprise-migration-tool/identifying-githubs-ip-ranges.md @@ -1,13 +1,13 @@ You'll need to add the following IP ranges to your IP allowlist(s): -- 192.30.252.0/22 -- 185.199.108.0/22 -- 140.82.112.0/20 -- 143.55.64.0/20 -- 40.71.233.224/28 -- 2a0a:a440::/29 -- 2606:50c0::/32 -- 20.125.12.8/29 _(active from 00:00 UTC on November 8, 2023)_ +* 192.30.252.0/22 +* 185.199.108.0/22 +* 140.82.112.0/20 +* 143.55.64.0/20 +* 40.71.233.224/28 +* 2a0a:a440::/29 +* 2606:50c0::/32 +* 20.125.12.8/29 _(active from 00:00 UTC on November 8, 2023)_ You can get an up-to-date list of IP ranges used by {% data variables.product.prodname_importer_proper_name %} at any time with the "Get {% data variables.product.prodname_dotcom %} meta information" endpoint of the REST API. diff --git a/data/reusables/enterprise-migration-tool/limitations-of-migrated-data.md b/data/reusables/enterprise-migration-tool/limitations-of-migrated-data.md index e8ec44e748..cb9198dde7 100644 --- a/data/reusables/enterprise-migration-tool/limitations-of-migrated-data.md +++ b/data/reusables/enterprise-migration-tool/limitations-of-migrated-data.md @@ -2,16 +2,16 @@ There are limits to what {% data variables.product.prodname_importer_proper_name ### Limitations of {% data variables.product.prodname_dotcom_the_website %} -- **2 GB size limit for a single Git commit:** No single commit in your Git repository can be larger than 2 GB. If any of your commits are larger than 2 GB, you will need to split the commit into smaller commits that are each 2 GB or smaller. -- **255 byte limit for Git references:** No single [Git reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References), commonly known as a "ref", can have a name larger than 255 bytes. Usually, this means that your references cannot be more than 255 characters long, but any non-[ASCII](https://en.wikipedia.org/wiki/ASCII) characters, such as emojis, may consume more than one byte. If any of your Git references are too large, we'll return a clear error message. -- **100 MB file size limit:** No single file in your Git repository can be larger than 100 MB. Consider using {% data variables.large_files.product_name_short %} for storing large files. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files)." +* **2 GB size limit for a single Git commit:** No single commit in your Git repository can be larger than 2 GB. If any of your commits are larger than 2 GB, you will need to split the commit into smaller commits that are each 2 GB or smaller. +* **255 byte limit for Git references:** No single [Git reference](https://git-scm.com/book/en/v2/Git-Internals-Git-References), commonly known as a "ref", can have a name larger than 255 bytes. Usually, this means that your references cannot be more than 255 characters long, but any non-[ASCII](https://en.wikipedia.org/wiki/ASCII) characters, such as emojis, may consume more than one byte. If any of your Git references are too large, we'll return a clear error message. +* **100 MB file size limit:** No single file in your Git repository can be larger than 100 MB. Consider using {% data variables.large_files.product_name_short %} for storing large files. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files)." ### Limitations of {% data variables.product.prodname_importer_proper_name %} -- **10 GB size limit for a Git repository:** This limit only applies to the source code. To check if the repository archive is over the limit, use the [git-sizer](https://github.com/github/git-sizer) tool and review the total blob size in the output. The git-sizer tool also helps to identify potential issues related to large files, blob size, commit size, and tree counts that could impact migrations. -- **10 GB limit for metadata**: The {% data variables.product.prodname_importer_secondary_name %} cannot migrate repositories with more than 10 GB of metadata. Metadata includes issues, pull requests, releases, and attachments. In most cases, large metadata is caused by binary assets attached to releases. You can exclude releases from the migration with the `migrate-repo` command's `--skip-releases` flag, and then move your releases manually after the migration. -- **{% data variables.large_files.product_name_short %} objects not migrated**: The {% data variables.product.prodname_importer_secondary_name %} can migrate repositories that use {% data variables.large_files.product_name_short %}, but the LFS objects themselves will not be migrated. They can be pushed to your migration destination as a follow-up task after the migration is complete. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects)." -- **Follow-up tasks required:** When migrating between {% data variables.product.prodname_dotcom %} products, certain settings are not migrated and must be reconfigured in the new repository. For a list of follow-up tasks you'll need to complete after each migration, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products#completing-follow-up-tasks)." -- **Delayed code search functionality:** Re-indexing the search index can take a few hours after a repository is migrated, and code searches may return unexpected results until re-indexing is complete. -- **Rulesets configured for your organization can cause migrations to fail**: For example, if you configured a rule that requires email addresses for commit authors to end with `@monalisa.cat`, and the repository you're migrating contains commits that don't comply with this rule, your migration will fail. For more information about rulesets, see "[AUTOTITLE](/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." -- **Mannequin content might not be searchable**: Mannequins are placeholder users to which imported content (such as issues, pull requests, comments, etc.) is associated. When you search for content associated with a mannequin, such as assigned issues, the issues may not be found. Once a mannequin is reclaimed, the content should be found via the new owner. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer)." +* **10 GB size limit for a Git repository:** This limit only applies to the source code. To check if the repository archive is over the limit, use the [git-sizer](https://github.com/github/git-sizer) tool and review the total blob size in the output. The git-sizer tool also helps to identify potential issues related to large files, blob size, commit size, and tree counts that could impact migrations. +* **10 GB limit for metadata**: The {% data variables.product.prodname_importer_secondary_name %} cannot migrate repositories with more than 10 GB of metadata. Metadata includes issues, pull requests, releases, and attachments. In most cases, large metadata is caused by binary assets attached to releases. You can exclude releases from the migration with the `migrate-repo` command's `--skip-releases` flag, and then move your releases manually after the migration. +* **{% data variables.large_files.product_name_short %} objects not migrated**: The {% data variables.product.prodname_importer_secondary_name %} can migrate repositories that use {% data variables.large_files.product_name_short %}, but the LFS objects themselves will not be migrated. They can be pushed to your migration destination as a follow-up task after the migration is complete. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/duplicating-a-repository#mirroring-a-repository-that-contains-git-large-file-storage-objects)." +* **Follow-up tasks required:** When migrating between {% data variables.product.prodname_dotcom %} products, certain settings are not migrated and must be reconfigured in the new repository. For a list of follow-up tasks you'll need to complete after each migration, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/migrating-between-github-products/overview-of-a-migration-between-github-products#completing-follow-up-tasks)." +* **Delayed code search functionality:** Re-indexing the search index can take a few hours after a repository is migrated, and code searches may return unexpected results until re-indexing is complete. +* **Rulesets configured for your organization can cause migrations to fail**: For example, if you configured a rule that requires email addresses for commit authors to end with `@monalisa.cat`, and the repository you're migrating contains commits that don't comply with this rule, your migration will fail. For more information about rulesets, see "[AUTOTITLE](/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)." +* **Mannequin content might not be searchable**: Mannequins are placeholder users to which imported content (such as issues, pull requests, comments, etc.) is associated. When you search for content associated with a mannequin, such as assigned issues, the issues may not be found. Once a mannequin is reclaimed, the content should be found via the new owner. For more information, see "[AUTOTITLE](/migrations/using-github-enterprise-importer/completing-your-migration-with-github-enterprise-importer/reclaiming-mannequins-for-github-enterprise-importer)." diff --git a/data/reusables/enterprise-migration-tool/migrate-multiple-repos.md b/data/reusables/enterprise-migration-tool/migrate-multiple-repos.md index bc3a4063e5..12bccd494c 100644 --- a/data/reusables/enterprise-migration-tool/migrate-multiple-repos.md +++ b/data/reusables/enterprise-migration-tool/migrate-multiple-repos.md @@ -1,12 +1,12 @@ To migrate multiple repositories, run the script you generated above. Replace FILENAME in the commands below with the filename you provided when generating the script. -- If you're using Terminal, use `./`. +* If you're using Terminal, use `./`. ```shell copy ./FILENAME ``` -- If you're using PowerShell, use `.\`. +* If you're using PowerShell, use `.\`. ```shell copy .\FILENAME diff --git a/data/reusables/enterprise-migration-tool/migration-prerequisites.md b/data/reusables/enterprise-migration-tool/migration-prerequisites.md index 2d13c50fd8..d49aa0fe5f 100644 --- a/data/reusables/enterprise-migration-tool/migration-prerequisites.md +++ b/data/reusables/enterprise-migration-tool/migration-prerequisites.md @@ -1,2 +1,2 @@ -- {% data reusables.enterprise-migration-tool.link-to-support-limitations %} -- {% data reusables.enterprise-migration-tool.delta-migrations-not-supported %} +* {% data reusables.enterprise-migration-tool.link-to-support-limitations %} +* {% data reusables.enterprise-migration-tool.delta-migrations-not-supported %} diff --git a/data/reusables/enterprise-migration-tool/reclaim-bulk-csv.md b/data/reusables/enterprise-migration-tool/reclaim-bulk-csv.md index add9da588a..fa262f2fdc 100644 --- a/data/reusables/enterprise-migration-tool/reclaim-bulk-csv.md +++ b/data/reusables/enterprise-migration-tool/reclaim-bulk-csv.md @@ -1 +1 @@ -- To reclaim mannequins in bulk with the mapping file you created earlier, replace DESTINATION with the destination organization and FILENAME with the file name of the mapping file. +* To reclaim mannequins in bulk with the mapping file you created earlier, replace DESTINATION with the destination organization and FILENAME with the file name of the mapping file. diff --git a/data/reusables/enterprise-migration-tool/reclaim-individual-mannequin.md b/data/reusables/enterprise-migration-tool/reclaim-individual-mannequin.md index 4961d3fbbd..13e9b29c47 100644 --- a/data/reusables/enterprise-migration-tool/reclaim-individual-mannequin.md +++ b/data/reusables/enterprise-migration-tool/reclaim-individual-mannequin.md @@ -1,4 +1,4 @@ -- To reclaim an individual mannequin, replace DESTINATION with the destination organization, MANNEQUIN with the login of mannequin, and USERNAME with the username of the organization member that corresponds to the mannequin. +* To reclaim an individual mannequin, replace DESTINATION with the destination organization, MANNEQUIN with the login of mannequin, and USERNAME with the username of the organization member that corresponds to the mannequin. If there are multiple mannequins with the same login, you can replace `--mannequin-user MANNEQUIN` with `--mannequin-ID ID`, replacing ID with the ID of the mannequin. diff --git a/data/reusables/enterprise-migration-tool/review-migration-script.md b/data/reusables/enterprise-migration-tool/review-migration-script.md index 2af7586adf..b35c37f596 100644 --- a/data/reusables/enterprise-migration-tool/review-migration-script.md +++ b/data/reusables/enterprise-migration-tool/review-migration-script.md @@ -1,4 +1,4 @@ After you generate the script, review the file and, optionally, edit the script. -- If there are any repositories you don't want to migrate, delete or comment out the corresponding lines. -- If you want any repositories to have a different name in the destination organization, update the value for the corresponding `--target-repo` flag. +* If there are any repositories you don't want to migrate, delete or comment out the corresponding lines. +* If you want any repositories to have a different name in the destination organization, update the value for the corresponding `--target-repo` flag. diff --git a/data/reusables/enterprise-migration-tool/running-your-migrations.md b/data/reusables/enterprise-migration-tool/running-your-migrations.md index 326d8df3a9..2aab032414 100644 --- a/data/reusables/enterprise-migration-tool/running-your-migrations.md +++ b/data/reusables/enterprise-migration-tool/running-your-migrations.md @@ -2,8 +2,8 @@ After you complete your planning, you can start the actual migrations. To help u Trial migrations help you determine several critical pieces of information. -- Whether the migration for a given repository can complete successfully -- Whether you can get the repository back to a state where your users can successfully start working -- How long a migration will take to run, which is useful for planning migration schedules and setting stakeholder expectations +* Whether the migration for a given repository can complete successfully +* Whether you can get the repository back to a state where your users can successfully start working +* How long a migration will take to run, which is useful for planning migration schedules and setting stakeholder expectations Trial runs do not require much time coordination. {% data variables.product.prodname_importer_proper_name %} never requires downtime for users of a repository being migrated. However, we recommend halting work during production migrations to ensure that new data isn't created during the migration, which would then be missing from the migrated repository. This isn't a concern for trial migrations, so trial runs can take place at any time. To reduce the time it takes to complete your trial migrations, you can schedule the batches for your trial runs back-to-back. Users of those repositories can then validate the results on their own time. diff --git a/data/reusables/enterprise-migration-tool/setting-repository-visibility.md b/data/reusables/enterprise-migration-tool/setting-repository-visibility.md index ff44c077d1..c634a177dd 100644 --- a/data/reusables/enterprise-migration-tool/setting-repository-visibility.md +++ b/data/reusables/enterprise-migration-tool/setting-repository-visibility.md @@ -1,4 +1,4 @@ All repositories are migrated as private, and only the user that ran the migration and organization owners will have access to the repository. If you don't want the repository to be private, change the visibility. -- You can change a repository's visibility in the browser. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." -- Alternatively, you can use {% data variables.product.prodname_cli %} to change repository visibility from the command line. You can even add this command to the script that was generated to run your migrations. For more information, see [`gh repo edit`](https://cli.github.com/manual/gh_repo_edit) in the {% data variables.product.prodname_cli %} documentation. +* You can change a repository's visibility in the browser. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." +* Alternatively, you can use {% data variables.product.prodname_cli %} to change repository visibility from the command line. You can even add this command to the script that was generated to run your migrations. For more information, see [`gh repo edit`](https://cli.github.com/manual/gh_repo_edit) in the {% data variables.product.prodname_cli %} documentation. diff --git a/data/reusables/enterprise-migration-tool/supported-blob-storage-providers.md b/data/reusables/enterprise-migration-tool/supported-blob-storage-providers.md index 529b6a659a..acbad25b3d 100644 --- a/data/reusables/enterprise-migration-tool/supported-blob-storage-providers.md +++ b/data/reusables/enterprise-migration-tool/supported-blob-storage-providers.md @@ -1,4 +1,4 @@ The {% data variables.product.prodname_cli %} supports the following blob storage providers: -- Amazon Web Services (AWS) S3 -- Azure Blob Storage +* Amazon Web Services (AWS) S3 +* Azure Blob Storage diff --git a/data/reusables/enterprise-migration-tool/supported-migration-paths.md b/data/reusables/enterprise-migration-tool/supported-migration-paths.md index bbcd5de6e6..29e76370f9 100644 --- a/data/reusables/enterprise-migration-tool/supported-migration-paths.md +++ b/data/reusables/enterprise-migration-tool/supported-migration-paths.md @@ -1,6 +1,6 @@ {% data variables.product.prodname_importer_proper_name %} supports migrations to {% data variables.product.prodname_ghe_cloud %} from the following sources. -- Azure DevOps (ADO) Cloud -- Bitbucket Server and Bitbucket Data Center 5.14+ -- {% data variables.product.prodname_dotcom_the_website %} -- {% data variables.product.prodname_ghe_server %} (GHES) 3.4.1+ +* Azure DevOps (ADO) Cloud +* Bitbucket Server and Bitbucket Data Center 5.14+ +* {% data variables.product.prodname_dotcom_the_website %} +* {% data variables.product.prodname_ghe_server %} (GHES) 3.4.1+ diff --git a/data/reusables/enterprise/about-ssh-ports.md b/data/reusables/enterprise/about-ssh-ports.md index 3544d9203e..e8993b7d9a 100644 --- a/data/reusables/enterprise/about-ssh-ports.md +++ b/data/reusables/enterprise/about-ssh-ports.md @@ -1,5 +1,5 @@ Each {% data variables.product.product_name %} instance accepts SSH connections over two ports. Site administrators can access the administrative shell via SSH, then run command-line utilities, troubleshoot, and perform maintenance. Users can connect via SSH to access and write Git data in the instance's repositories. Users do not have shell access to your instance. For more information, see the following articles. -- "[AUTOTITLE](/admin/configuration/configuring-network-settings/network-ports)" -- "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)" -- "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/about-ssh)" +* "[AUTOTITLE](/admin/configuration/configuring-network-settings/network-ports)" +* "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)" +* "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/about-ssh)" diff --git a/data/reusables/enterprise_installation/download-appliance.md b/data/reusables/enterprise_installation/download-appliance.md index ee31ea374d..8b6b81d4da 100644 --- a/data/reusables/enterprise_installation/download-appliance.md +++ b/data/reusables/enterprise_installation/download-appliance.md @@ -1,5 +1,5 @@ 1. Navigate to the image you want to use for your new instance. - - Navigate to [Release notes](/admin/release-notes). - - In the right sidebar, click the version you want to download. - - Click **Download {% data variables.product.prodname_ghe_server %} X.X.X**. + * Navigate to [Release notes](/admin/release-notes). + * In the right sidebar, click the version you want to download. + * Click **Download {% data variables.product.prodname_ghe_server %} X.X.X**. diff --git a/data/reusables/enterprise_installation/ha-and-clustering-failure-scenarios.md b/data/reusables/enterprise_installation/ha-and-clustering-failure-scenarios.md index 164f162887..6673846dce 100644 --- a/data/reusables/enterprise_installation/ha-and-clustering-failure-scenarios.md +++ b/data/reusables/enterprise_installation/ha-and-clustering-failure-scenarios.md @@ -1,4 +1,4 @@ -- **Software crashes**, either due to operating system failure or unrecoverable applications. -- **Hardware failures**, including storage hardware, CPU, RAM, network interfaces, etc. -- **Virtualization host system failures**, including unplanned and scheduled maintenance events for [AWS](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html), [Azure](https://learn.microsoft.com/en-us/azure/virtual-machines/maintenance-and-updates#maintenance-that-requires-a-reboot), or [GCP](https://cloud.google.com/compute/docs/instances/host-maintenance-overview#maintenanceevents). -- **Logically or physically severed network**, if the failover appliance is on a separate network not impacted by the failure. +* **Software crashes**, either due to operating system failure or unrecoverable applications. +* **Hardware failures**, including storage hardware, CPU, RAM, network interfaces, etc. +* **Virtualization host system failures**, including unplanned and scheduled maintenance events for [AWS](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html), [Azure](https://learn.microsoft.com/en-us/azure/virtual-machines/maintenance-and-updates#maintenance-that-requires-a-reboot), or [GCP](https://cloud.google.com/compute/docs/instances/host-maintenance-overview#maintenanceevents). +* **Logically or physically severed network**, if the failover appliance is on a separate network not impacted by the failure. diff --git a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md index 2af5828746..9f3ef6a448 100644 --- a/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md +++ b/data/reusables/enterprise_installation/hardware-considerations-all-platforms.md @@ -1,6 +1,6 @@ -- [Minimum requirements](#minimum-requirements) -- [Storage](#storage) -- [CPU and memory](#cpu-and-memory) +* [Minimum requirements](#minimum-requirements) +* [Storage](#storage) +* [CPU and memory](#cpu-and-memory) ### Minimum requirements diff --git a/data/reusables/enterprise_installation/increase-resources-communicate-and-enable-maintenance-mode.md b/data/reusables/enterprise_installation/increase-resources-communicate-and-enable-maintenance-mode.md index 84acb51446..05eae8d731 100644 --- a/data/reusables/enterprise_installation/increase-resources-communicate-and-enable-maintenance-mode.md +++ b/data/reusables/enterprise_installation/increase-resources-communicate-and-enable-maintenance-mode.md @@ -1,4 +1,4 @@ 1. Communicate the upcoming downtime to your users and enable maintenance mode. For more information, see the following articles. - - "[AUTOTITLE](/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-mandatory-message)" - - "[AUTOTITLE](/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode)" + * "[AUTOTITLE](/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-mandatory-message)" + * "[AUTOTITLE](/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode)" diff --git a/data/reusables/enterprise_installation/monitoring-replicas.md b/data/reusables/enterprise_installation/monitoring-replicas.md index 6c75f9f9ff..6793a90a70 100644 --- a/data/reusables/enterprise_installation/monitoring-replicas.md +++ b/data/reusables/enterprise_installation/monitoring-replicas.md @@ -1,7 +1,7 @@ You can monitor the availability of {% data variables.product.prodname_ghe_server %} by checking the status code that is returned for the `https://HOSTNAME/status` URL. An appliance that can service user traffic will return status code `200` (OK). An appliance may return `503` (Service Unavailable) for this URL and other web or API requests for a few reasons: -- The appliance is a passive replica, such as the replica in a two-node high availability configuration. -- The appliance is in maintenance mode. -- The appliance is part of a geo-replication configuration, but is an inactive replica. +* The appliance is a passive replica, such as the replica in a two-node high availability configuration. +* The appliance is in maintenance mode. +* The appliance is part of a geo-replication configuration, but is an inactive replica. You can also use the Replication overview dashboard available at: diff --git a/data/reusables/enterprise_migrations/review-the-import-csv.md b/data/reusables/enterprise_migrations/review-the-import-csv.md index 87e7bcc557..dca3abfdec 100644 --- a/data/reusables/enterprise_migrations/review-the-import-csv.md +++ b/data/reusables/enterprise_migrations/review-the-import-csv.md @@ -1,6 +1,6 @@ 1. Review the comma-separated (CSV) file in `/PATH/REPO-NAME.git/git-import/raw-authors.csv`. It should contain these columns: - - `ID`: The author as stored in the original repository, followed by a unique identifier - - `NAME`: The author as stored in the original repository + * `ID`: The author as stored in the original repository, followed by a unique identifier + * `NAME`: The author as stored in the original repository To map authors from the original repository to an email address and name, create a new CSV file with the columns `ID,(ignored),GIT_EMAIL,GIT_NAME`. You can use this CSV file to replace the author information for anything by "ID" with "GIT_EMAIL" and "GIT_NAME". diff --git a/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md b/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md index 35872826aa..ccb135c7f8 100644 --- a/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md +++ b/data/reusables/enterprise_site_admin_settings/create-pgp-key-web-commit-signing.md @@ -4,4 +4,4 @@ gpg --full-generate-key --pinentry-mode=loopback ``` - - Use the default key type and at least `4096` bits with no expiry. + * Use the default key type and at least `4096` bits with no expiry. diff --git a/data/reusables/enterprise_site_admin_settings/pgp-key-no-passphrase.md b/data/reusables/enterprise_site_admin_settings/pgp-key-no-passphrase.md index 7ab4825136..61f96615b3 100644 --- a/data/reusables/enterprise_site_admin_settings/pgp-key-no-passphrase.md +++ b/data/reusables/enterprise_site_admin_settings/pgp-key-no-passphrase.md @@ -1 +1 @@ -- The PGP key **cannot** be protected by a passphrase. +* The PGP key **cannot** be protected by a passphrase. diff --git a/data/reusables/enterprise_site_admin_settings/search-user.md b/data/reusables/enterprise_site_admin_settings/search-user.md index 61ab341375..a007bce690 100644 --- a/data/reusables/enterprise_site_admin_settings/search-user.md +++ b/data/reusables/enterprise_site_admin_settings/search-user.md @@ -1,5 +1,5 @@ 1. Under "Search users, organizations, teams, repositories, gists, and applications", type the name of the user in the text field. 1. To the right of text field, click **Search**. ![Screenshot of the "Search" page of the "Site admin" settings. The button to search users, labeled "Search," is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/search-for-things.png) - - If an exact account name match isn't found, under "Search results – Accounts", in the "Fuzzy matches" section, click the name of the user you want to manage. + * If an exact account name match isn't found, under "Search results – Accounts", in the "Fuzzy matches" section, click the name of the user you want to manage. ![Screenshot of search results in the "Site admin" settings. In the "Fuzzy matches" section, an example user name is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/click-user.png) diff --git a/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md b/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md index 7e914e8766..5df5c79dda 100644 --- a/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md +++ b/data/reusables/enterprise_user_management/disclaimer-for-git-read-access.md @@ -2,8 +2,8 @@ **Warnings:** -- The Git protocol is unauthenticated and unencrypted. An attacker could intercept repository data transferred over connections using this protocol. -- If you enable anonymous Git read access, you're responsible for all access and use of the feature. {% data variables.product.company_short %} is not responsible for any unintended access, security risks, or misuse of the feature. -- You may not use this feature to violate your license from {% data variables.product.company_short %}, including the limit on the number of user licenses for {% data variables.location.product_location %}. +* The Git protocol is unauthenticated and unencrypted. An attacker could intercept repository data transferred over connections using this protocol. +* If you enable anonymous Git read access, you're responsible for all access and use of the feature. {% data variables.product.company_short %} is not responsible for any unintended access, security risks, or misuse of the feature. +* You may not use this feature to violate your license from {% data variables.product.company_short %}, including the limit on the number of user licenses for {% data variables.location.product_location %}. {% endwarning %} diff --git a/data/reusables/enterprise_user_management/exceptions-for-enabling-anonymous-git-read-access.md b/data/reusables/enterprise_user_management/exceptions-for-enabling-anonymous-git-read-access.md index 1aa5004f78..cec6eb9332 100644 --- a/data/reusables/enterprise_user_management/exceptions-for-enabling-anonymous-git-read-access.md +++ b/data/reusables/enterprise_user_management/exceptions-for-enabling-anonymous-git-read-access.md @@ -1,8 +1,8 @@ {% note %} **Notes:** -- You cannot change the Git read access settings for forked repositories since they inherit their access settings from the root repository by default. -- If a public repository becomes private, then anonymous Git read access will automatically be disabled for that repository and it forks. -- If a repository with anonymous authentication contains {% data variables.large_files.product_name_short %} assets, it will fail to download the {% data variables.large_files.product_name_short %} assets since they still require authentication. We strongly recommend not enabling anonymous Git read access for a repository with {% data variables.large_files.product_name_short %} assets. +* You cannot change the Git read access settings for forked repositories since they inherit their access settings from the root repository by default. +* If a public repository becomes private, then anonymous Git read access will automatically be disabled for that repository and it forks. +* If a repository with anonymous authentication contains {% data variables.large_files.product_name_short %} assets, it will fail to download the {% data variables.large_files.product_name_short %} assets since they still require authentication. We strongly recommend not enabling anonymous Git read access for a repository with {% data variables.large_files.product_name_short %} assets. {% endnote %} diff --git a/data/reusables/gated-features/copilot-business.md b/data/reusables/gated-features/copilot-business.md index 4264e99d96..9ea10e0038 100644 --- a/data/reusables/gated-features/copilot-business.md +++ b/data/reusables/gated-features/copilot-business.md @@ -1,4 +1,4 @@ {% data variables.product.prodname_copilot_for_business %} is available for the following types of accounts: -- Organizations with a {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan -- Enterprises and organizations on {% data variables.product.prodname_ghe_cloud %} +* Organizations with a {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan +* Enterprises and organizations on {% data variables.product.prodname_ghe_cloud %} diff --git a/data/reusables/git/clear-stored-gcm-credentials.md b/data/reusables/git/clear-stored-gcm-credentials.md index fd8f1890c8..9ed8e249b9 100644 --- a/data/reusables/git/clear-stored-gcm-credentials.md +++ b/data/reusables/git/clear-stored-gcm-credentials.md @@ -1 +1 @@ -- If the output is `manager` (or `manager-core` in previous versions), you're using Git Credential Manager. To clear the credentials, run the following command. +* If the output is `manager` (or `manager-core` in previous versions), you're using Git Credential Manager. To clear the credentials, run the following command. diff --git a/data/reusables/git/no-credential-manager.md b/data/reusables/git/no-credential-manager.md index c942636867..bf87c637a8 100644 --- a/data/reusables/git/no-credential-manager.md +++ b/data/reusables/git/no-credential-manager.md @@ -1 +1 @@ -- If the output doesn't include the name of a credential manager, there is no credential manager configured, and you can proceed to the next step. +* If the output doesn't include the name of a credential manager, there is no credential manager configured, and you can proceed to the next step. diff --git a/data/reusables/gpg/copy-ssh-public-key.md b/data/reusables/gpg/copy-ssh-public-key.md index 96d3f13915..5af211161a 100644 --- a/data/reusables/gpg/copy-ssh-public-key.md +++ b/data/reusables/gpg/copy-ssh-public-key.md @@ -25,8 +25,8 @@ **Notes:** - - With Windows Subsystem for Linux (WSL), you can use `clip.exe`. Otherwise if `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. - - On newer versions of Windows that use the Windows Terminal, or anywhere else that uses the PowerShell command line, you may receive a `ParseError` stating that `The '<' operator is reserved for future use.` In this case, the following alternative `clip` command should be used: + * With Windows Subsystem for Linux (WSL), you can use `clip.exe`. Otherwise if `clip` isn't working, you can locate the hidden `.ssh` folder, open the file in your favorite text editor, and copy it to your clipboard. + * On newer versions of Windows that use the Windows Terminal, or anywhere else that uses the PowerShell command line, you may receive a `ParseError` stating that `The '<' operator is reserved for future use.` In this case, the following alternative `clip` command should be used: ```shell $ cat ~/.ssh/id_ed25519.pub | clip diff --git a/data/reusables/gpg/supported-gpg-key-algorithms.md b/data/reusables/gpg/supported-gpg-key-algorithms.md index 0147f7c42e..12bdfbe0e5 100644 --- a/data/reusables/gpg/supported-gpg-key-algorithms.md +++ b/data/reusables/gpg/supported-gpg-key-algorithms.md @@ -3,9 +3,9 @@ {% data variables.product.product_name %} supports several GPG key algorithms. If you try to add a key generated with an unsupported algorithm, you may encounter an error. -- RSA -- ElGamal -- DSA -- ECDH -- ECDSA -- EdDSA +* RSA +* ElGamal +* DSA +* ECDH +* ECDSA +* EdDSA diff --git a/data/reusables/gpg/x-509-key.md b/data/reusables/gpg/x-509-key.md index eee6581bf3..f53d0b6ccb 100644 --- a/data/reusables/gpg/x-509-key.md +++ b/data/reusables/gpg/x-509-key.md @@ -8,14 +8,14 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and 1. Install [smimesign](https://github.com/github/smimesign#installation). {% data reusables.command_line.open_the_multi_os_terminal %} 1. Configure Git to use S/MIME to sign commits and tags. In Git 2.19 or later, use the `git config gpg.x509.program` and `git config gpg.format` commands: - - To use S/MIME to sign for all repositories: + * To use S/MIME to sign for all repositories: ```shell git config --global gpg.x509.program smimesign git config --global gpg.format x509 ``` - - To use S/MIME to sign for a single repository: + * To use S/MIME to sign for a single repository: ```shell cd PATH-TO-REPOSITORY @@ -24,13 +24,13 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and ``` In Git 2.18 or earlier, use the `git config gpg.program` command: - - To use S/MIME to sign for all repositories: + * To use S/MIME to sign for all repositories: ```shell git config --global gpg.program smimesign ``` - - To use S/MIME to sign for a single repository: + * To use S/MIME to sign for a single repository: ```shell cd PATH-TO-REPOSITORY @@ -58,13 +58,13 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and ``` 1. To set your X.509 signing key in Git, paste the text below, substituting in the certificate ID you copied earlier. - - To use your X.509 key to sign for all repositories: + * To use your X.509 key to sign for all repositories: ```shell git config --global user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f ``` - - To use your X.509 key to sign for a single repository: + * To use your X.509 key to sign for a single repository: ```shell cd PATH-TO-REPOSITORY diff --git a/data/reusables/identity-and-permissions/ip-allow-lists-example-and-restrictions.md b/data/reusables/identity-and-permissions/ip-allow-lists-example-and-restrictions.md index 0d3428e8df..626f7f26b7 100644 --- a/data/reusables/identity-and-permissions/ip-allow-lists-example-and-restrictions.md +++ b/data/reusables/identity-and-permissions/ip-allow-lists-example-and-restrictions.md @@ -4,9 +4,9 @@ If the list allows an IP address, an authenticated user connecting to {% data va After you configure an IP allow list, the list determines whether users can access protected resources through the web UI, APIs, or Git, using any of the following authentication methods. -- Username and password, using {% data variables.product.prodname_dotcom %} authentication or SAML SSO -- {% data variables.product.pat_generic_caps %} -- SSH key +* Username and password, using {% data variables.product.prodname_dotcom %} authentication or SAML SSO +* {% data variables.product.pat_generic_caps %} +* SSH key The IP allow list applies to users with any role or access, including enterprise and organization owners, repository administrators, and external collaborators. diff --git a/data/reusables/identity-and-permissions/supported-idps-team-sync.md b/data/reusables/identity-and-permissions/supported-idps-team-sync.md index ec6e863b66..aacd9bbebc 100644 --- a/data/reusables/identity-and-permissions/supported-idps-team-sync.md +++ b/data/reusables/identity-and-permissions/supported-idps-team-sync.md @@ -1,3 +1,3 @@ You can use team synchronization with supported IdPs. -- Entra ID commercial tenants (Gov Cloud is not supported) -- Okta +* Entra ID commercial tenants (Gov Cloud is not supported) +* Okta diff --git a/data/reusables/identity-and-permissions/team-sync-azure-permissions.md b/data/reusables/identity-and-permissions/team-sync-azure-permissions.md index 0af5a45242..98f470b8b5 100644 --- a/data/reusables/identity-and-permissions/team-sync-azure-permissions.md +++ b/data/reusables/identity-and-permissions/team-sync-azure-permissions.md @@ -1,4 +1,4 @@ To enable team synchronization for Entra ID, your Entra ID installation needs the following permissions. -- Read all users’ full profiles -- Sign in and read user profile -- Read directory data +* Read all users’ full profiles +* Sign in and read user profile +* Read directory data diff --git a/data/reusables/identity-and-permissions/team-sync-confirm.md b/data/reusables/identity-and-permissions/team-sync-confirm.md index 5ba6541bfc..c8d4fbdf40 100644 --- a/data/reusables/identity-and-permissions/team-sync-confirm.md +++ b/data/reusables/identity-and-permissions/team-sync-confirm.md @@ -1,3 +1,3 @@ 1. Confirm team synchronization. - - If you have IdP access, click **Enable team synchronization**. You'll be redirected to your identity provider's SAML SSO page and asked to select your account and review the requested permissions. - - If you don't have IdP access, copy the IdP redirect link and share it with your IdP administrator to continue enabling team synchronization. + * If you have IdP access, click **Enable team synchronization**. You'll be redirected to your identity provider's SAML SSO page and asked to select your account and review the requested permissions. + * If you don't have IdP access, copy the IdP redirect link and share it with your IdP administrator to continue enabling team synchronization. diff --git a/data/reusables/identity-and-permissions/team-sync-okta-requirements.md b/data/reusables/identity-and-permissions/team-sync-okta-requirements.md index 153c62bd53..fb0136a4e1 100644 --- a/data/reusables/identity-and-permissions/team-sync-okta-requirements.md +++ b/data/reusables/identity-and-permissions/team-sync-okta-requirements.md @@ -1,5 +1,5 @@ Before you enable team synchronization for Okta, you or your IdP administrator must: -- Configure the SAML, SSO, and SCIM integration for your organization using Okta. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)." -- Provide the tenant URL for your Okta instance. -- Generate a valid SSWS token with read-only admin permissions for your Okta installation as a service user. For more information, see [Create the token](https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/) and [Service users](https://help.okta.com/asa/en-us/Content/Topics/Adv_Server_Access/docs/service-users.htm) in Okta's documentation. +* Configure the SAML, SSO, and SCIM integration for your organization using Okta. For more information, see "[AUTOTITLE](/organizations/managing-saml-single-sign-on-for-your-organization/configuring-saml-single-sign-on-and-scim-using-okta)." +* Provide the tenant URL for your Okta instance. +* Generate a valid SSWS token with read-only admin permissions for your Okta installation as a service user. For more information, see [Create the token](https://developer.okta.com/docs/guides/create-an-api-token/create-the-token/) and [Service users](https://help.okta.com/asa/en-us/Content/Topics/Adv_Server_Access/docs/service-users.htm) in Okta's documentation. diff --git a/data/reusables/identity-and-permissions/team-sync-usage-limits.md b/data/reusables/identity-and-permissions/team-sync-usage-limits.md index b132efec46..9a11b72ca4 100644 --- a/data/reusables/identity-and-permissions/team-sync-usage-limits.md +++ b/data/reusables/identity-and-permissions/team-sync-usage-limits.md @@ -2,6 +2,6 @@ There are usage limits for the team synchronization feature. Exceeding these limits will lead to a degradation in performance and may cause synchronization failures. -- Maximum number of members in a GitHub team: 5,000 -- Maximum number of members in a GitHub organization: 10,000 -- Maximum number of teams in a GitHub organization: 1,500 +* Maximum number of members in a GitHub team: 5,000 +* Maximum number of members in a GitHub organization: 10,000 +* Maximum number of teams in a GitHub organization: 1,500 diff --git a/data/reusables/marketplace/add-payment-method-org.md b/data/reusables/marketplace/add-payment-method-org.md index c17e60e543..027d06f3b9 100644 --- a/data/reusables/marketplace/add-payment-method-org.md +++ b/data/reusables/marketplace/add-payment-method-org.md @@ -1,3 +1,3 @@ 1. If you chose a paid plan, review your payment method. - - To change the existing payment method on file for the organization, click **Edit**, then complete the form to add a new payment method. - - If there isn't a payment method on file for the organization, click **Add a Payment Method**, then complete the form to add a credit card or PayPal account. + * To change the existing payment method on file for the organization, click **Edit**, then complete the form to add a new payment method. + * If there isn't a payment method on file for the organization, click **Add a Payment Method**, then complete the form to add a credit card or PayPal account. diff --git a/data/reusables/marketplace/add-payment-method-personal.md b/data/reusables/marketplace/add-payment-method-personal.md index 981998d4d6..daa24df2d6 100644 --- a/data/reusables/marketplace/add-payment-method-personal.md +++ b/data/reusables/marketplace/add-payment-method-personal.md @@ -1,3 +1,3 @@ 1. If you chose a paid plan, in the "Payment Method" section, review your payment method. - - To change the existing payment method on file for your personal account, click **Edit**, then complete the form to add a new payment method. - - If there isn't a payment method on file for your personal account, complete the form to add a credit card or PayPal account. + * To change the existing payment method on file for your personal account, click **Edit**, then complete the form to add a new payment method. + * If there isn't a payment method on file for your personal account, complete the form to add a credit card or PayPal account. diff --git a/data/reusables/marketplace/confirm-install-account-org.md b/data/reusables/marketplace/confirm-install-account-org.md index 973ecf27c4..d330981ee1 100644 --- a/data/reusables/marketplace/confirm-install-account-org.md +++ b/data/reusables/marketplace/confirm-install-account-org.md @@ -1,10 +1,10 @@ 1. Choose an installation organization for the app. Depending on your organization's terms of service, this process will be slightly different. - - If you have given {% data variables.product.prodname_dotcom %} permission to collect name and address information for your organization, in the "Billing information" section, select the **Switch billing account** {% octicon "triangle-down" aria-label="The downwards-facing triangle icon" %} dropdown menu, then click the organization in which you'd like to install the app. + * If you have given {% data variables.product.prodname_dotcom %} permission to collect name and address information for your organization, in the "Billing information" section, select the **Switch billing account** {% octicon "triangle-down" aria-label="The downwards-facing triangle icon" %} dropdown menu, then click the organization in which you'd like to install the app. ![Screenshot of the {% data variables.product.prodname_marketplace %} app purchase screen. A collapsed blue dropdown menu labeled "Switch billing account" is outlined in dark orange.](/assets/images/help/marketplace/marketplace-confirm-org.png) - - Otherwise, under "Review your order," select the **Account** dropdown menu, then click the organization in which you'd like to install the app. + * Otherwise, under "Review your order," select the **Account** dropdown menu, then click the organization in which you'd like to install the app. ![Screenshot of the {% data variables.product.prodname_marketplace %} app purchase screen. A collapsed gray dropdown menu labeled "Account" is outlined in dark orange.](/assets/images/help/marketplace/marketplace-confirm-org-no-org-details.png) diff --git a/data/reusables/marketplace/marketplace-billing-ui-requirements.md b/data/reusables/marketplace/marketplace-billing-ui-requirements.md index 7e3e8c61d2..c958dc8613 100644 --- a/data/reusables/marketplace/marketplace-billing-ui-requirements.md +++ b/data/reusables/marketplace/marketplace-billing-ui-requirements.md @@ -1,9 +1,9 @@ -- Customers who cancel a paid plan purchased from {% data variables.product.prodname_marketplace %} should be automatically downgraded to the app's free plan if it exists. {% data reusables.marketplace.cancellation-clarification %} It's highly recommended to allow customers to re-enable their previous plan. -- Customers should be able to upgrade from your app's user interface if you provide an [upgrade URL](/apps/publishing-apps-to-github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes#about-upgrade-urls) in this format: `https://www.github.com/marketplace//upgrade//` -- Customers should be able to modify which users have access to your app from your app's website if they purchased seats (per-unit pricing plan) or the plan offers unlimited collaborators. -- Customers should be able to see the following changes to their account immediately in the billing, profile, or account settings section of the app's website: - - Current plan and price. - - New plans purchased. - - Upgrades, downgrades, cancellations, and the number of remaining days in a free trial. - - Changes to billing cycles (monthly or yearly). - - Usage and remaining resources for flat-rate and per-unit plans. For example, if the pricing plan is per-unit, your app's site should show units used and units available. +* Customers who cancel a paid plan purchased from {% data variables.product.prodname_marketplace %} should be automatically downgraded to the app's free plan if it exists. {% data reusables.marketplace.cancellation-clarification %} It's highly recommended to allow customers to re-enable their previous plan. +* Customers should be able to upgrade from your app's user interface if you provide an [upgrade URL](/apps/publishing-apps-to-github-marketplace/using-the-github-marketplace-api-in-your-app/handling-plan-changes#about-upgrade-urls) in this format: `https://www.github.com/marketplace//upgrade//` +* Customers should be able to modify which users have access to your app from your app's website if they purchased seats (per-unit pricing plan) or the plan offers unlimited collaborators. +* Customers should be able to see the following changes to their account immediately in the billing, profile, or account settings section of the app's website: + * Current plan and price. + * New plans purchased. + * Upgrades, downgrades, cancellations, and the number of remaining days in a free trial. + * Changes to billing cycles (monthly or yearly). + * Usage and remaining resources for flat-rate and per-unit plans. For example, if the pricing plan is per-unit, your app's site should show units used and units available. diff --git a/data/reusables/notifications/vulnerable-dependency-notification-options.md b/data/reusables/notifications/vulnerable-dependency-notification-options.md index 0c25279ff2..b5a175c276 100644 --- a/data/reusables/notifications/vulnerable-dependency-notification-options.md +++ b/data/reusables/notifications/vulnerable-dependency-notification-options.md @@ -1,19 +1,19 @@ {% ifversion fpt or ghec %}By default, you will receive notifications:{% endif %}{% ifversion ghes %}By default, if your enterprise owner has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:{% endif %} -- in your inbox, as web notifications. A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**On {% data variables.product.prodname_dotcom %}** option). -- by email, an email is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Email** option). -- on the command line, warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**CLI** option). -- on {% data variables.product.prodname_mobile %}, as web notifications. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#enabling-push-notifications-with-github-mobile)." +* in your inbox, as web notifications. A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**On {% data variables.product.prodname_dotcom %}** option). +* by email, an email is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Email** option). +* on the command line, warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**CLI** option). +* on {% data variables.product.prodname_mobile %}, as web notifications. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#enabling-push-notifications-with-github-mobile)." {% note %} **Note:** The email and web/{% data variables.product.prodname_mobile %} notifications are: -- _Per repository_ when {% data variables.product.prodname_dependabot %} is enabled on the repository, or when a new manifest file is committed to the repository. +* _Per repository_ when {% data variables.product.prodname_dependabot %} is enabled on the repository, or when a new manifest file is committed to the repository. -- _Per organization_ when a new vulnerability is discovered. +* _Per organization_ when a new vulnerability is discovered. -- Sent when a new vulnerability is discovered. {% data variables.product.prodname_dotcom %} doesn't send notifications when vulnerabilities are updated. +* Sent when a new vulnerability is discovered. {% data variables.product.prodname_dotcom %} doesn't send notifications when vulnerabilities are updated. {% endnote %} diff --git a/data/reusables/organizations/invite_to_team.md b/data/reusables/organizations/invite_to_team.md index bd98a3027e..78800365d4 100644 --- a/data/reusables/organizations/invite_to_team.md +++ b/data/reusables/organizations/invite_to_team.md @@ -1,7 +1,7 @@ {% ifversion fpt or ghec %} 1. Add an organization member to the team or invite a non-member to join a team. - - If the person you want to add is already a member of your organization, type their username and click **Enter**. The user will immediately be added to the team. - - If the person you want to add is not member of your organization, type their username or email address and click **Enter**. The user will receive an email invitation to join your organization and will be added to the team once they accept the invitation. + * If the person you want to add is already a member of your organization, type their username and click **Enter**. The user will immediately be added to the team. + * If the person you want to add is not member of your organization, type their username or email address and click **Enter**. The user will receive an email invitation to join your organization and will be added to the team once they accept the invitation. {% else %} 1. Type the username of the person you want to add and click **Enter**. The user will immediately be added to the team. {% endif %} diff --git a/data/reusables/organizations/types-of-team-visibility.md b/data/reusables/organizations/types-of-team-visibility.md index 7f0a659674..36b0228741 100644 --- a/data/reusables/organizations/types-of-team-visibility.md +++ b/data/reusables/organizations/types-of-team-visibility.md @@ -1,6 +1,6 @@ Teams can be visible or secret: -- Visible teams can be [viewed and @mentioned](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#mentioning-people-and-teams) by every organization member. -- Secret teams are only visible to the people on the team and people with owner permissions. They're great for hiding teams with sensitive names or members, such as those used for working with external partners or clients. Secret teams cannot be nested under parent teams or have child teams. +* Visible teams can be [viewed and @mentioned](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#mentioning-people-and-teams) by every organization member. +* Secret teams are only visible to the people on the team and people with owner permissions. They're great for hiding teams with sensitive names or members, such as those used for working with external partners or clients. Secret teams cannot be nested under parent teams or have child teams. People who are not members of the organization cannot view any teams. diff --git a/data/reusables/package_registry/about-packaging-and-actions.md b/data/reusables/package_registry/about-packaging-and-actions.md index 8c037f9bf8..b359bdfad7 100644 --- a/data/reusables/package_registry/about-packaging-and-actions.md +++ b/data/reusables/package_registry/about-packaging-and-actions.md @@ -16,12 +16,12 @@ This will let you run the code in the pull request on your machine, which can he In addition to uploading packaging artifacts for testing in a continuous integration workflow, you can create workflows that build your project and publish packages to a package registry. -- **Publish packages to {% data variables.product.prodname_registry %}** +* **Publish packages to {% data variables.product.prodname_registry %}** {% data variables.product.prodname_registry %} can act as a package hosting service for many types of packages. You can choose to share your packages with all of {% data variables.product.prodname_dotcom %}, or private packages to share with collaborators or an organization. For more information, see "[AUTOTITLE](/packages/learn-github-packages/introduction-to-github-packages)." You may want to publish packages to {% data variables.product.prodname_registry %} on every push into the default branch. This will allow developers on your project to always be able to run and test the latest build from the default branch easily, by installing it from {% data variables.product.prodname_registry %}. -- **Publish packages to a package registry** +* **Publish packages to a package registry** For many projects, publishing to a package registry is performed whenever a new version of a project is released. For example, a project that produces a JAR file may upload new releases to the Maven Central repository. Or, a .NET project may produce a nuget package and upload it to the NuGet Gallery. You can automate this by creating a workflow that publishes packages to a package registry on every release creation. For more information, see "[AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository)." diff --git a/data/reusables/package_registry/authenticate-packages.md b/data/reusables/package_registry/authenticate-packages.md index 7405f74eca..c15920beb2 100644 --- a/data/reusables/package_registry/authenticate-packages.md +++ b/data/reusables/package_registry/authenticate-packages.md @@ -5,5 +5,5 @@ You need an access token to publish, install, and delete private, internal, and You can use a {% data variables.product.pat_v1 %} to authenticate to {% data variables.product.prodname_registry %} or the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. When you create a {% data variables.product.pat_v1 %}, you can assign the token different scopes depending on your needs. For more information about packages-related scopes for a {% data variables.product.pat_v1 %}, see "[AUTOTITLE](/packages/learn-github-packages/about-permissions-for-github-packages#about-scopes-and-permissions-for-package-registries)." To authenticate to a {% data variables.product.prodname_registry %} registry within a {% data variables.product.prodname_actions %} workflow, you can use: -- `GITHUB_TOKEN` to publish packages associated with the workflow repository. -- a {% data variables.product.pat_v1 %} with at least `read:packages` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). +* `GITHUB_TOKEN` to publish packages associated with the workflow repository. +* a {% data variables.product.pat_v1 %} with at least `read:packages` scope to install packages associated with other private repositories (which `GITHUB_TOKEN` can't access). diff --git a/data/reusables/package_registry/authenticate-to-container-registry-steps.md b/data/reusables/package_registry/authenticate-to-container-registry-steps.md index 2b4b4059c9..c3dffc1978 100644 --- a/data/reusables/package_registry/authenticate-to-container-registry-steps.md +++ b/data/reusables/package_registry/authenticate-to-container-registry-steps.md @@ -7,9 +7,9 @@ {% endwarning %} - - Select the `read:packages` scope to download container images and read their metadata. - - Select the `write:packages` scope to download and upload container images and read and write their metadata. - - Select the `delete:packages` scope to delete container images. + * Select the `read:packages` scope to download container images and read their metadata. + * Select the `write:packages` scope to download and upload container images and read and write their metadata. + * Select the `delete:packages` scope to delete container images. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." diff --git a/data/reusables/package_registry/package-settings-delete-versions.md b/data/reusables/package_registry/package-settings-delete-versions.md index f89b33d9c9..226121c1d3 100644 --- a/data/reusables/package_registry/package-settings-delete-versions.md +++ b/data/reusables/package_registry/package-settings-delete-versions.md @@ -1,5 +1,5 @@ 1. In the list of packages, find the version of the package that you want to delete. - - _If your package is a container_, to the right of the package version click {% octicon "kebab-horizontal" aria-hidden="true" %}, then select **Delete version** from the dropdown menu. + * _If your package is a container_, to the right of the package version click {% octicon "kebab-horizontal" aria-hidden="true" %}, then select **Delete version** from the dropdown menu. ![Screenshot of a package version with a dropdown menu button, labeled with a kebab icon. The "Delete version" link in the menu is highlighted with an orange outline.](/assets/images/help/package-registry/delete-container-package-version.png) - - _For types of packages other than containers_, to the right of the package version click **Delete**. + * _For types of packages other than containers_, to the right of the package version click **Delete**. ![Screenshot of a package version with a "Delete" button. The button is highlighted with an orange outline.](/assets/images/help/package-registry/delete-noncontainer-package-version.png) diff --git a/data/reusables/package_registry/package-settings-manage-versions-menu.md b/data/reusables/package_registry/package-settings-manage-versions-menu.md index 65ae42e6ea..af42ff3020 100644 --- a/data/reusables/package_registry/package-settings-manage-versions-menu.md +++ b/data/reusables/package_registry/package-settings-manage-versions-menu.md @@ -3,9 +3,9 @@ ![Screenshot of a package's "Recent Versions" section. Underneath, the "View and manage all versions" link is highlighted with an orange outline.](/assets/images/help/package-registry/packages-recent-versions-manage-link.png) {% elsif ghes %} 1. Navigate to where you can manage versions for your type of package. - - _If your package is a container_, under the "Recent Versions" section, click **View and manage all versions**. + * _If your package is a container_, under the "Recent Versions" section, click **View and manage all versions**. ![Screenshot of a package's "Recent Versions" section. Underneath, the "View and manage all versions" link is highlighted with an orange outline.](/assets/images/help/package-registry/packages-recent-versions-manage-link.png) - - _For types of packages other than containers_: + * _For types of packages other than containers_: 1. On the right-hand side, click **{% octicon "gear" aria-hidden="true" %} Package settings**. ![Screenshot of a package's landing page. In the lower right corner, "Package settings" is highlighted with an orange outline.](/assets/images/help/package-registry/package-settings.png) 1. On the left click **Manage versions**. diff --git a/data/reusables/package_registry/publish-docker-image.md b/data/reusables/package_registry/publish-docker-image.md index e17861070b..8f064a1d41 100644 --- a/data/reusables/package_registry/publish-docker-image.md +++ b/data/reusables/package_registry/publish-docker-image.md @@ -2,8 +2,8 @@ **Notes:** -- {% data reusables.actions.actions-not-certified-by-github %} -- {% data reusables.actions.actions-use-sha-pinning %} +* {% data reusables.actions.actions-not-certified-by-github %} +* {% data reusables.actions.actions-use-sha-pinning %} {% endnote %} diff --git a/data/reusables/pages/admin-must-push.md b/data/reusables/pages/admin-must-push.md index 3606a15088..4f8ab0c022 100644 --- a/data/reusables/pages/admin-must-push.md +++ b/data/reusables/pages/admin-must-push.md @@ -2,8 +2,8 @@ **Notes**: -- {% ifversion pages-custom-workflow %}If you are publishing from a branch and{% else %}If{% endif %} your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source. +* {% ifversion pages-custom-workflow %}If you are publishing from a branch and{% else %}If{% endif %} your site has not published automatically, make sure someone with admin permissions and a verified email address has pushed to the publishing source. -- {% data reusables.actions.actions-do-not-trigger-pages-rebuilds %} +* {% data reusables.actions.actions-do-not-trigger-pages-rebuilds %} {% endnote %} diff --git a/data/reusables/pages/yaml-rules.md b/data/reusables/pages/yaml-rules.md index 3cfbf06681..2864c87a84 100644 --- a/data/reusables/pages/yaml-rules.md +++ b/data/reusables/pages/yaml-rules.md @@ -1,5 +1,5 @@ -- Use spaces instead of tabs. -- Include a space after the `:` for each key value pair, like `timezone: Africa/Nairobi`. -- Use only UTF-8 characters. -- Quote any special characters, such as `:`, like `title: "my awesome site: an adventure in parse errors"`. -- For multi-line values, use `|` to create newlines and `>` to ignore newlines. +* Use spaces instead of tabs. +* Include a space after the `:` for each key value pair, like `timezone: Africa/Nairobi`. +* Use only UTF-8 characters. +* Quote any special characters, such as `:`, like `title: "my awesome site: an adventure in parse errors"`. +* For multi-line values, use `|` to create newlines and `>` to ignore newlines. diff --git a/data/reusables/project-management/project-board-permissions.md b/data/reusables/project-management/project-board-permissions.md index 2f630ed4f9..1152a00bcf 100644 --- a/data/reusables/project-management/project-board-permissions.md +++ b/data/reusables/project-management/project-board-permissions.md @@ -1,3 +1,3 @@ -- **Read**, which gives people permission to view a {% data variables.projects.projects_v1_board %}. -- **Write**, which gives people permission to view a {% data variables.projects.projects_v1_board %}, link repositories to a {% data variables.projects.projects_v1_board %}, and interact with a {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board)." -- **Admin**, which gives people permission to view a {% data variables.projects.projects_v1_board %}, interact with a {% data variables.projects.projects_v1_board %}, manage {% data variables.projects.projects_v1_board %} settings, and manage other people's access to the {% data variables.projects.projects_v1_board %}. +* **Read**, which gives people permission to view a {% data variables.projects.projects_v1_board %}. +* **Write**, which gives people permission to view a {% data variables.projects.projects_v1_board %}, link repositories to a {% data variables.projects.projects_v1_board %}, and interact with a {% data variables.projects.projects_v1_board %}. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/linking-a-repository-to-a-project-board)." +* **Admin**, which gives people permission to view a {% data variables.projects.projects_v1_board %}, interact with a {% data variables.projects.projects_v1_board %}, manage {% data variables.projects.projects_v1_board %} settings, and manage other people's access to the {% data variables.projects.projects_v1_board %}. diff --git a/data/reusables/projects/create-project.md b/data/reusables/projects/create-project.md index 53502504eb..aecbc2d084 100644 --- a/data/reusables/projects/create-project.md +++ b/data/reusables/projects/create-project.md @@ -6,8 +6,8 @@ 1. Click **New project**. {%- ifversion projects-v2-org-templates-GA-updates %} 1. Select which type of project or template you want to use. - - To create a blank project, under "Start from scratch", click **Table**{% ifversion projects-v2-roadmaps %}, **Roadmap**,{% endif %} or **Board**. - - To create a project from a template, click the template you want to use. You can select from the built-in templates curated by {% data variables.product.company_short %}, the templates created by your organization, and the recommended templates that have been chosen by your organization. + * To create a blank project, under "Start from scratch", click **Table**{% ifversion projects-v2-roadmaps %}, **Roadmap**,{% endif %} or **Board**. + * To create a project from a template, click the template you want to use. You can select from the built-in templates curated by {% data variables.product.company_short %}, the templates created by your organization, and the recommended templates that have been chosen by your organization. 1. Optionally, if you selected a template, review the fields, views, workflows, and insights that will be created. 1. In the text box under "Project name", type a name for your new project. 1. Click **Create project**. diff --git a/data/reusables/projects/create-user-project.md b/data/reusables/projects/create-user-project.md index 6bf18cb527..c11fbe1c8a 100644 --- a/data/reusables/projects/create-user-project.md +++ b/data/reusables/projects/create-user-project.md @@ -6,8 +6,8 @@ 1. Click **New project**. {%- ifversion projects-v2-org-templates-GA-updates %} 1. Select which type of project or template you want to use. - - To create a blank project, under "Start from scratch", click **Table**{% ifversion projects-v2-roadmaps %}, **Roadmap**,{% endif %} or **Board**. - - To create a project from a template, click the built-in template that you want to use. + * To create a blank project, under "Start from scratch", click **Table**{% ifversion projects-v2-roadmaps %}, **Roadmap**,{% endif %} or **Board**. + * To create a project from a template, click the built-in template that you want to use. 1. Optionally, if you selected a template, review the fields, views, workflows, and insights that will be created. 1. In the text box under "Project name", type a name for your new project. 1. Click **Create project**. diff --git a/data/reusables/projects/last-updated-explanation.md b/data/reusables/projects/last-updated-explanation.md index 37f09e902a..b9994a385a 100644 --- a/data/reusables/projects/last-updated-explanation.md +++ b/data/reusables/projects/last-updated-explanation.md @@ -1,10 +1,10 @@ {% data variables.product.product_name %} marks an issue or pull request as updated when it is: -- Created -- Reopened -- Edited -- Commented -- Labeled -- Assignees are updated -- Milestones are updated -- Transferred to another repository +* Created +* Reopened +* Edited +* Commented +* Labeled +* Assignees are updated +* Milestones are updated +* Transferred to another repository diff --git a/data/reusables/projects/project-description.md b/data/reusables/projects/project-description.md index f4a5ccd917..b5b8eb9f88 100644 --- a/data/reusables/projects/project-description.md +++ b/data/reusables/projects/project-description.md @@ -3,8 +3,8 @@ You can set your project's description and README to share the purpose of your p {% data reusables.projects.project-settings %} 1. To add a short description to your project, under "Add a description", type your description in the text box and click **Save**. 1. To update your project's README, under "README", type your content in the text box. - - You can format your README using Markdown. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." - - To toggle between the text box and a preview of your changes, click {% octicon "eye" aria-label="The preview icon" %} or {% octicon "pencil" aria-label="The edit icon" %}. + * You can format your README using Markdown. For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + * To toggle between the text box and a preview of your changes, click {% octicon "eye" aria-label="The preview icon" %} or {% octicon "pencil" aria-label="The edit icon" %}. 1. To save changes to your README, click **Save**. You can view and make quick changes to your project description and README by navigating to your project and clicking {% octicon "sidebar-expand" aria-label="The sidebar icon" %} in the top right. diff --git a/data/reusables/projects/project_boards_old.md b/data/reusables/projects/project_boards_old.md index ca7ca402c0..537f2d89ee 100644 --- a/data/reusables/projects/project_boards_old.md +++ b/data/reusables/projects/project_boards_old.md @@ -3,8 +3,8 @@ {% ifversion projects-v2 %} >[!NOTE] ->- {% data variables.product.prodname_projects_v2 %}, the all-new projects experience, is now available. For more information about {% data variables.product.prodname_projects_v2 %}, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." ->- You can only create a new {% data variables.projects.projects_v1_board %} for an organization{% ifversion projects-v1-create-repo-project %}, repository, {% endif %} or user that already has at least one {% data variables.projects.projects_v1_board %}. {% ifversion projects-v1-create-repo-project %}{% else %} You cannot create new {% data variables.projects.projects_v1_boards %} for repositories. {% endif %} If you're unable to create a {% data variables.projects.projects_v1_board %}, create a project instead. +>* {% data variables.product.prodname_projects_v2 %}, the all-new projects experience, is now available. For more information about {% data variables.product.prodname_projects_v2 %}, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." +>* You can only create a new {% data variables.projects.projects_v1_board %} for an organization{% ifversion projects-v1-create-repo-project %}, repository, {% endif %} or user that already has at least one {% data variables.projects.projects_v1_board %}. {% ifversion projects-v1-create-repo-project %}{% else %} You cannot create new {% data variables.projects.projects_v1_boards %} for repositories. {% endif %} If you're unable to create a {% data variables.projects.projects_v1_board %}, create a project instead. {% endif %} diff --git a/data/reusables/projects/projects-api.md b/data/reusables/projects/projects-api.md index 708ed9910a..e85992c6a0 100644 --- a/data/reusables/projects/projects-api.md +++ b/data/reusables/projects/projects-api.md @@ -5,8 +5,8 @@ **Notes:** -- These endpoints only interact with {% data variables.product.prodname_projects_v1 %}. To manage {% data variables.product.prodname_projects_v2 %}, use the GraphQL API. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." -- To create a new {% data variables.projects.projects_v1_board %}, the organization, user, or repository must already have at least one {% data variables.projects.projects_v1_board %}. +* These endpoints only interact with {% data variables.product.prodname_projects_v1 %}. To manage {% data variables.product.prodname_projects_v2 %}, use the GraphQL API. For more information, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects)." +* To create a new {% data variables.projects.projects_v1_board %}, the organization, user, or repository must already have at least one {% data variables.projects.projects_v1_board %}. {% endnote %} {% endif %} diff --git a/data/reusables/projects/select-a-cell.md b/data/reusables/projects/select-a-cell.md index ba2e83022a..e9dc549929 100644 --- a/data/reusables/projects/select-a-cell.md +++ b/data/reusables/projects/select-a-cell.md @@ -1,4 +1,4 @@ -- Hold Command (Mac) or Ctrl (Windows/Linux) and select each cell. -- Select a cell then press Shift+↑ or Shift+↓ to select additional cell above or below the selected item. -- Select a cell then press Shift and select another item to select all items between the two items. -- Holding your mouse button down, move the cursor over the cells you want to select. +* Hold Command (Mac) or Ctrl (Windows/Linux) and select each cell. +* Select a cell then press Shift+↑ or Shift+↓ to select additional cell above or below the selected item. +* Select a cell then press Shift and select another item to select all items between the two items. +* Holding your mouse button down, move the cursor over the cells you want to select. diff --git a/data/reusables/projects/select-an-item.md b/data/reusables/projects/select-an-item.md index ea063e649b..85480df519 100644 --- a/data/reusables/projects/select-an-item.md +++ b/data/reusables/projects/select-an-item.md @@ -1,9 +1,9 @@ 1. {% ifversion projects-v2-roadmaps %}If you're using a table or board layout, first select{% else %}Select{% endif %} the item: - - In a table layout, click on the row number. - - In a board layout, click on the card. + * In a table layout, click on the row number. + * In a board layout, click on the card. To select multiple items, do one of the following: - - Hold Command (Mac) or Ctrl (Windows/Linux) and select each item. - - Select an item then press Shift+↑ or Shift+↓ to select additional items above or below the selected item. - - Select an item then press Shift and select another item to select all items between the two items. - - With a row or item already selected, press Command+A (Mac) or Ctrl+A (Windows/Linux) to select all items in a column in a board layout or all items in a table layout. + * Hold Command (Mac) or Ctrl (Windows/Linux) and select each item. + * Select an item then press Shift+↑ or Shift+↓ to select additional items above or below the selected item. + * Select an item then press Shift and select another item to select all items between the two items. + * With a row or item already selected, press Command+A (Mac) or Ctrl+A (Windows/Linux) to select all items in a column in a board layout or all items in a table layout. diff --git a/data/reusables/pull_requests/merge-queue-removal-reasons.md b/data/reusables/pull_requests/merge-queue-removal-reasons.md index 019be3a066..481a558164 100644 --- a/data/reusables/pull_requests/merge-queue-removal-reasons.md +++ b/data/reusables/pull_requests/merge-queue-removal-reasons.md @@ -1,6 +1,6 @@ There are a number of reasons a pull request can be removed from a merge queue: -- Configured CI service is reporting test failures for a merge group -- Timed out awaiting a successful CI result based off the configured timeout setting -- User requesting a removal via the API or merge queue interface -- Branch protection failure that could not automatically be resolved +* Configured CI service is reporting test failures for a merge group +* Timed out awaiting a successful CI result based off the configured timeout setting +* User requesting a removal via the API or merge queue interface +* Branch protection failure that could not automatically be resolved diff --git a/data/reusables/pull_requests/pull_request_merges_and_contributions.md b/data/reusables/pull_requests/pull_request_merges_and_contributions.md index 974e28e726..8212fcbba9 100644 --- a/data/reusables/pull_requests/pull_request_merges_and_contributions.md +++ b/data/reusables/pull_requests/pull_request_merges_and_contributions.md @@ -1,8 +1,8 @@ {% note %} **Notes:**{% ifversion ghes %} -- To appear on your profile contributions graph, co-authored commits must meet the same criteria as commits with one author.{% endif %} -- When rebasing commits, the original authors of the commit and the person who rebased the commits, whether on the command line or on {% data variables.location.product_location %}, receive contribution credit.{% ifversion ghec or fpt %} -- If you merged multiple personal accounts, issues, pull requests, and discussions will not be attributed to the new account and will not appear on your contribution graph.{% endif %} +* To appear on your profile contributions graph, co-authored commits must meet the same criteria as commits with one author.{% endif %} +* When rebasing commits, the original authors of the commit and the person who rebased the commits, whether on the command line or on {% data variables.location.product_location %}, receive contribution credit.{% ifversion ghec or fpt %} +* If you merged multiple personal accounts, issues, pull requests, and discussions will not be attributed to the new account and will not appear on your contribution graph.{% endif %} {% endnote %} diff --git a/data/reusables/rai/copilot/about-copilot-chat-in-mobile.md b/data/reusables/rai/copilot/about-copilot-chat-in-mobile.md index 4f683152a6..7f14ef50d8 100644 --- a/data/reusables/rai/copilot/about-copilot-chat-in-mobile.md +++ b/data/reusables/rai/copilot/about-copilot-chat-in-mobile.md @@ -20,9 +20,9 @@ The response generated by {% data variables.product.prodname_copilot_chat_short The options available to you in {% data variables.product.prodname_copilot_mobile_short %} vary depending on the {% data variables.product.prodname_copilot %} plan you are using. -- Only people with a {% data variables.product.prodname_copilot_enterprise %} subscription can access and have conversations using the data from private indexed repositories. -- If you have a {% data variables.product.prodname_copilot_enterprise %} subscription and you have enabled Bing search integration (beta), {% data variables.product.prodname_copilot_mobile_short %} may respond using information based on the results of a Bing search. For information on how to enable or disable Bing search integration, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-features-on-githubcom){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} -- In addition to general coding conversations or conversations about a single file, people with a {% data variables.product.prodname_copilot_individuals_short %} subscription have the ability to discuss top popular public repositories using embeddings. +* Only people with a {% data variables.product.prodname_copilot_enterprise %} subscription can access and have conversations using the data from private indexed repositories. +* If you have a {% data variables.product.prodname_copilot_enterprise %} subscription and you have enabled Bing search integration (beta), {% data variables.product.prodname_copilot_mobile_short %} may respond using information based on the results of a Bing search. For information on how to enable or disable Bing search integration, see "[AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#enforcing-a-policy-to-manage-the-use-of-github-copilot-features-on-githubcom){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} +* In addition to general coding conversations or conversations about a single file, people with a {% data variables.product.prodname_copilot_individuals_short %} subscription have the ability to discuss top popular public repositories using embeddings. If you do not have a {% data variables.product.prodname_copilot %} subscription, you can purchase a {% data variables.product.prodname_copilot_individuals_short %} subscription directly in the iOS version of {% data variables.product.prodname_mobile %}, or in the Google Play Store for the Android version of {% data variables.product.prodname_mobile %}. diff --git a/data/reusables/rai/copilot/copilot-chat-ide-next-steps.md b/data/reusables/rai/copilot/copilot-chat-ide-next-steps.md index ba40bcdbf5..4f8cbcc8c3 100644 --- a/data/reusables/rai/copilot/copilot-chat-ide-next-steps.md +++ b/data/reusables/rai/copilot/copilot-chat-ide-next-steps.md @@ -2,11 +2,11 @@ For details of how to use {% data variables.product.prodname_copilot_chat %}, see: -- "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide)" -- "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} +* "[AUTOTITLE](/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide)" +* "[AUTOTITLE](/enterprise-cloud@latest/copilot/github-copilot-chat/copilot-chat-in-github/using-github-copilot-chat-in-githubcom)"{% ifversion fpt %} in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %} ## Further reading -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" -- "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" -- [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)" +* "[AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-copilot-pre-release-terms)" +* [{% data variables.product.prodname_copilot %} Trust Center](https://resources.github.com/copilot-trust-center/) diff --git a/data/reusables/release-notes/git-push-known-issue.md b/data/reusables/release-notes/git-push-known-issue.md index 15cb3772ab..8f3c6a50fa 100644 --- a/data/reusables/release-notes/git-push-known-issue.md +++ b/data/reusables/release-notes/git-push-known-issue.md @@ -1,4 +1,4 @@ On instances in a high availability configuration, `git push` operations may fail in the following situations. -- During creation of the repository on a replica node -- After failure to create the repository on a replica node, before automatic repair of the repository +* During creation of the repository on a replica node +* After failure to create the repository on a replica node, before automatic repair of the repository diff --git a/data/reusables/releases/create-release.md b/data/reusables/releases/create-release.md index f839ff0609..68c24e59b1 100644 --- a/data/reusables/releases/create-release.md +++ b/data/reusables/releases/create-release.md @@ -1,5 +1,5 @@ 1. At the top of the page, click **Draft a new release**. 1. To choose a tag for the release, select the **Choose a tag** dropdown menu. - - To use an existing tag, click the tag. - - To create a new tag, type a version number for your release, then click **Create new tag**. + * To use an existing tag, click the tag. + * To create a new tag, type a version number for your release, then click **Create new tag**. 1. If you created a new tag, select the **Target** dropdown menu, then click the branch that contains the project you want to release. diff --git a/data/reusables/releases/finish-release.md b/data/reusables/releases/finish-release.md index de8f615819..f480f3ee90 100644 --- a/data/reusables/releases/finish-release.md +++ b/data/reusables/releases/finish-release.md @@ -5,8 +5,8 @@ {%- endif %} {%- ifversion discussions %} 1. Optionally, if {% data variables.product.prodname_discussions %} is enabled for the repository, create a discussion for the release. - - Select **Create a discussion for this release**. - - Select the **Category** dropdown menu, then click a category for the release discussion. + * Select **Create a discussion for this release**. + * Select the **Category** dropdown menu, then click a category for the release discussion. {%- endif %} 1. If you're ready to publicize your release, click **Publish release**. To work on the release later, click **Save draft**. diff --git a/data/reusables/reminders/tracked-repos.md b/data/reusables/reminders/tracked-repos.md index 732c7b76d5..8c9893043e 100644 --- a/data/reusables/reminders/tracked-repos.md +++ b/data/reusables/reminders/tracked-repos.md @@ -1,3 +1,3 @@ 1. Under "Tracked repositories," choose which repositories you'd like the team to receive pull request review reminders for. - - To receive reminders for all repositories that the chosen team has access to, click **All repositories**. - - To receive reminders for a subset of repositories, click **Only select repositories**, then select one or more repositories that the chosen team has access to. + * To receive reminders for all repositories that the chosen team has access to, click **All repositories**. + * To receive reminders for a subset of repositories, click **Only select repositories**, then select one or more repositories that the chosen team has access to. diff --git a/data/reusables/repositories/about-ruleset-insights.md b/data/reusables/repositories/about-ruleset-insights.md index 50df566f4f..12018f856e 100644 --- a/data/reusables/repositories/about-ruleset-insights.md +++ b/data/reusables/repositories/about-ruleset-insights.md @@ -1,8 +1,8 @@ On the "Rule Insights" page, you will see a timeline of the following user actions. You can use filters to find what you're looking for. -- Actions that have been checked against one or more rulesets and passed. -- Actions that have been checked against one or more rulesets and failed. -- Actions where someone has bypassed one or more rulesets. +* Actions that have been checked against one or more rulesets and passed. +* Actions that have been checked against one or more rulesets and failed. +* Actions where someone has bypassed one or more rulesets. If a ruleset is running in "Evaluate" mode, you can see actions that would have passed or failed if the ruleset had been active. diff --git a/data/reusables/repositories/choose-line-or-range.md b/data/reusables/repositories/choose-line-or-range.md index 8bbcb579c6..0597be9bb3 100644 --- a/data/reusables/repositories/choose-line-or-range.md +++ b/data/reusables/repositories/choose-line-or-range.md @@ -1,4 +1,4 @@ 1. Choose whether to select a single line or a range. - - To select a single line of code, click the line number to highlight the line. - - To select a range of code, click the number of the first line in the range to highlight the line of code. Then, hover over the last line of the code range, press Shift, and click the line number to highlight the range. + * To select a single line of code, click the line number to highlight the line. + * To select a range of code, click the number of the first line in the range to highlight the line of code. Then, hover over the last line of the code range, press Shift, and click the line number to highlight the range. diff --git a/data/reusables/repositories/copy-clone-url.md b/data/reusables/repositories/copy-clone-url.md index c70d96942c..292939c9dd 100644 --- a/data/reusables/repositories/copy-clone-url.md +++ b/data/reusables/repositories/copy-clone-url.md @@ -4,8 +4,8 @@ 1. Copy the URL for the repository. - - To clone the repository using HTTPS, under "HTTPS", click {% octicon "clippy" aria-label="Copy to clipboard" %}. - - To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click **SSH**, then click {% octicon "clippy" aria-label="Copy to clipboard" %}. - - To clone a repository using {% data variables.product.prodname_cli %}, click **{% data variables.product.prodname_cli %}**, then click {% octicon "copy" aria-label="Copy to clipboard" %}. + * To clone the repository using HTTPS, under "HTTPS", click {% octicon "clippy" aria-label="Copy to clipboard" %}. + * To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click **SSH**, then click {% octicon "clippy" aria-label="Copy to clipboard" %}. + * To clone a repository using {% data variables.product.prodname_cli %}, click **{% data variables.product.prodname_cli %}**, then click {% octicon "copy" aria-label="Copy to clipboard" %}. ![Screenshot of the "Code" dropdown menu. To the right of the HTTPS URL for the repository, a copy icon is outlined in dark orange.](/assets/images/help/repository/https-url-clone-cli.png) diff --git a/data/reusables/repositories/create-ruleset-step.md b/data/reusables/repositories/create-ruleset-step.md index e69f605c34..ae507c7511 100644 --- a/data/reusables/repositories/create-ruleset-step.md +++ b/data/reusables/repositories/create-ruleset-step.md @@ -4,8 +4,8 @@ 1. Alternatively, to create a ruleset targeting tags, click **New tag ruleset**. {% else %} 1. You can create a ruleset targeting branches, or a ruleset targeting tags. - - To create a ruleset targeting branches, click **New branch ruleset**. - - To create a ruleset targeting tags, select {% octicon "triangle-down" aria-label="Open ruleset creation menu" %}, then click **New tag ruleset**. + * To create a ruleset targeting branches, click **New branch ruleset**. + * To create a ruleset targeting tags, select {% octicon "triangle-down" aria-label="Open ruleset creation menu" %}, then click **New tag ruleset**. ![Screenshot of the "Rulesets" page. Next to the "New branch ruleset" button, a dropdown menu is expanded, with an option labeled "New tag ruleset" outlined in orange.](/assets/images/help/repository/new-tag-ruleset.png) {% endif %} diff --git a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md index 063818f4f7..ef12f11b0a 100644 --- a/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md +++ b/data/reusables/repositories/deleted_forks_from_private_repositories_warning.md @@ -2,10 +2,10 @@ **Warning:** -- If you remove a person’s access to a private repository, any of their forks of that private repository are deleted. Local clones of the private repository are retained. If a team's access to a private repository is revoked or a team with access to a private repository is deleted, and team members do not have access to the repository through another team, private forks of the repository will be deleted.{% ifversion ghes %} -- When [LDAP Sync is enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %} -- You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. +* If you remove a person’s access to a private repository, any of their forks of that private repository are deleted. Local clones of the private repository are retained. If a team's access to a private repository is revoked or a team with access to a private repository is deleted, and team members do not have access to the repository through another team, private forks of the repository will be deleted.{% ifversion ghes %} +* When [LDAP Sync is enabled](/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync), if you remove a person from a repository, they will lose access but their forks will not be deleted. If the person is added to a team with access to the original organization repository within three months, their access to the forks will be automatically restored on the next sync.{% endif %} +* You are responsible for ensuring that people who have lost access to a repository delete any confidential information or intellectual property. -- People with admin permissions to a private{% ifversion ghes or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghec %} or internal{% endif %} repository in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." +* People with admin permissions to a private{% ifversion ghes or ghec %} or internal{% endif %} repository can disallow forking of that repository, and organization owners can disallow forking of any private{% ifversion ghes or ghec %} or internal{% endif %} repository in an organization. For more information, see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-forking-policy-for-your-repository)." {% endwarning %} diff --git a/data/reusables/repositories/push-rulesets-overview.md b/data/reusables/repositories/push-rulesets-overview.md index f75ec95377..5bda4ef41b 100644 --- a/data/reusables/repositories/push-rulesets-overview.md +++ b/data/reusables/repositories/push-rulesets-overview.md @@ -4,12 +4,12 @@ Push rules do not require any branch targeting because they apply to every push Push rulesets allow you to: -- **Restrict file paths**: Prevent commits that include changes in specified file paths from being pushed. +* **Restrict file paths**: Prevent commits that include changes in specified file paths from being pushed. {% data reusables.repositories.rulesets-push-rules-path-example %} -- **Restrict file path length**: Prevent commits that include file paths that exceed a specified character limit from being pushed. -- **Restrict file extensions**: Prevent commits that include files with specified file extensions from being pushed. -- **Restrict file size**: Prevent commits that exceed a specified file size limit from being pushed. +* **Restrict file path length**: Prevent commits that include file paths that exceed a specified character limit from being pushed. +* **Restrict file extensions**: Prevent commits that include files with specified file extensions from being pushed. +* **Restrict file size**: Prevent commits that exceed a specified file size limit from being pushed. #### About push rulesets for forked repositories diff --git a/data/reusables/repositories/request-changes-tips.md b/data/reusables/repositories/request-changes-tips.md index 09182c827e..1c058e294e 100644 --- a/data/reusables/repositories/request-changes-tips.md +++ b/data/reusables/repositories/request-changes-tips.md @@ -1,11 +1,11 @@ {% tip %} **Tips**: -- If a collaborator with `admin`, `owner`, or `write` access to the repository submits a review requesting changes, the pull request cannot be merged until the same collaborator submits another review approving the changes in the pull request. -- Repository owners and administrators can merge a pull request even if it hasn't received an approving review, or if a reviewer who requested changes has left the organization or is unavailable. -- If both required reviews and stale review dismissal are enabled and a code-modifying commit is pushed to the branch of an approved pull request, the approval is dismissed. The pull request must be reviewed and approved again before it can be merged. -- When several open pull requests each have a head branch pointing to the same commit, you won’t be able to merge them if one or both have a pending or rejected review. -- If your repository requires approving reviews from people with write or admin permissions, then any approvals from people with these permissions are denoted with a green check mark, and approvals from people without these permissions have a gray check mark. Approvals with a gray check mark do not affect whether the pull request can be merged. -- Pull request authors cannot approve their own pull requests. +* If a collaborator with `admin`, `owner`, or `write` access to the repository submits a review requesting changes, the pull request cannot be merged until the same collaborator submits another review approving the changes in the pull request. +* Repository owners and administrators can merge a pull request even if it hasn't received an approving review, or if a reviewer who requested changes has left the organization or is unavailable. +* If both required reviews and stale review dismissal are enabled and a code-modifying commit is pushed to the branch of an approved pull request, the approval is dismissed. The pull request must be reviewed and approved again before it can be merged. +* When several open pull requests each have a head branch pointing to the same commit, you won’t be able to merge them if one or both have a pending or rejected review. +* If your repository requires approving reviews from people with write or admin permissions, then any approvals from people with these permissions are denoted with a green check mark, and approvals from people without these permissions have a gray check mark. Approvals with a gray check mark do not affect whether the pull request can be merged. +* Pull request authors cannot approve their own pull requests. {% endtip %} diff --git a/data/reusables/repositories/ruleset-beta-note.md b/data/reusables/repositories/ruleset-beta-note.md index b1e06cc9fe..a4de3e035d 100644 --- a/data/reusables/repositories/ruleset-beta-note.md +++ b/data/reusables/repositories/ruleset-beta-note.md @@ -2,7 +2,7 @@ **Notes:** -- Ruleset history is currently in public beta and subject to change. -- Only changes made to a ruleset after the public beta release, on October 11, 2023, are included in the ruleset history. +* Ruleset history is currently in public beta and subject to change. +* Only changes made to a ruleset after the public beta release, on October 11, 2023, are included in the ruleset history. {% endnote %} diff --git a/data/reusables/repositories/rulesets-about-enforcement-statuses.md b/data/reusables/repositories/rulesets-about-enforcement-statuses.md index cd0dcb205a..a0b342b614 100644 --- a/data/reusables/repositories/rulesets-about-enforcement-statuses.md +++ b/data/reusables/repositories/rulesets-about-enforcement-statuses.md @@ -2,9 +2,9 @@ While creating or editing your ruleset, you can use enforcement statuses to conf You can select any of the following enforcement statuses for your ruleset. - - {% octicon "play" aria-hidden="true" %} **Active**: your ruleset will be enforced upon creation.{% ifversion repo-rules-enterprise %} - - {% octicon "meter" aria-hidden="true" %} **Evaluate**: your ruleset will not be enforced, but you will be able to monitor which actions would or would not violate rules on the "Rule Insights" page.{% endif %} - - {% octicon "skip" aria-hidden="true" %} **Disabled**: your ruleset will not be enforced{% ifversion repo-rules-enterprise %} or evaluated{% endif %}. + * {% octicon "play" aria-hidden="true" %} **Active**: your ruleset will be enforced upon creation.{% ifversion repo-rules-enterprise %} + * {% octicon "meter" aria-hidden="true" %} **Evaluate**: your ruleset will not be enforced, but you will be able to monitor which actions would or would not violate rules on the "Rule Insights" page.{% endif %} + * {% octicon "skip" aria-hidden="true" %} **Disabled**: your ruleset will not be enforced{% ifversion repo-rules-enterprise %} or evaluated{% endif %}. {% ifversion repo-rules-enterprise %} diff --git a/data/reusables/repositories/rulesets-bypass-step.md b/data/reusables/repositories/rulesets-bypass-step.md index 5995e8f688..3a7c34d002 100644 --- a/data/reusables/repositories/rulesets-bypass-step.md +++ b/data/reusables/repositories/rulesets-bypass-step.md @@ -1,11 +1,11 @@ You can grant certain roles, teams, or apps bypass permissions {% ifversion push-rule-delegated-bypass %} as well as the ability to approve bypass requests {% endif %} for your ruleset. The following are eligible for bypass access: -- Repository admins or organization owners -- The maintain or write role, or custom repository roles based on the write role -- Teams -- Deploy keys -- {% data variables.product.prodname_github_apps %}{% ifversion repo-rules-dependabot-bypass %} -- {% data variables.product.prodname_dependabot %}. For more information about {% data variables.product.prodname_dependabot %}, see "[AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide)."{% endif %} +* Repository admins or organization owners +* The maintain or write role, or custom repository roles based on the write role +* Teams +* Deploy keys +* {% data variables.product.prodname_github_apps %}{% ifversion repo-rules-dependabot-bypass %} +* {% data variables.product.prodname_dependabot %}. For more information about {% data variables.product.prodname_dependabot %}, see "[AUTOTITLE](/code-security/getting-started/dependabot-quickstart-guide)."{% endif %} 1. To grant bypass permissions for the ruleset, in the "Bypass list" section, click {% octicon "plus" aria-hidden="true" %} **Add bypass**. 1. In the "Add bypass" modal dialog that appears, search for the role, team, or app you would like to grant bypass permissions, then select the role, team, or app from the "Suggestions" section and click **Add Selected**. diff --git a/data/reusables/repositories/rulesets-metadata-restrictions-notes.md b/data/reusables/repositories/rulesets-metadata-restrictions-notes.md index 0aaf44af34..ccc4a05bd4 100644 --- a/data/reusables/repositories/rulesets-metadata-restrictions-notes.md +++ b/data/reusables/repositories/rulesets-metadata-restrictions-notes.md @@ -1,8 +1,8 @@ {% note %} **Notes:** -- Adding metadata restrictions can impact the experience of people contributing to your repository. Before you enact a ruleset with metadata restrictions, you can select the "Evaluate" enforcement status for your ruleset to test the effects of any metadata restrictions without impacting contributors. For more information on metadata restrictions, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#important-considerations-for-metadata-restrictions)." -- Metadata restrictions are intended to increase consistency between commits in your repository. They are not intended to replace security measures such as requiring code review via pull requests. -- If you squash merge a branch, all commits on that branch must meet any metadata requirements for the base branch. +* Adding metadata restrictions can impact the experience of people contributing to your repository. Before you enact a ruleset with metadata restrictions, you can select the "Evaluate" enforcement status for your ruleset to test the effects of any metadata restrictions without impacting contributors. For more information on metadata restrictions, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#important-considerations-for-metadata-restrictions)." +* Metadata restrictions are intended to increase consistency between commits in your repository. They are not intended to replace security measures such as requiring code review via pull requests. +* If you squash merge a branch, all commits on that branch must meet any metadata requirements for the base branch. {% endnote %} diff --git a/data/reusables/repositories/rulesets-protections-step.md b/data/reusables/repositories/rulesets-protections-step.md index 916369403b..d7c1ba0d97 100644 --- a/data/reusables/repositories/rulesets-protections-step.md +++ b/data/reusables/repositories/rulesets-protections-step.md @@ -3,7 +3,7 @@ In the "Branch protections" or "Tag protections" section, select the rules you w {% note %} **Notes:** If you select **Require status checks before merging**, in the "Additional settings" section: -- You can enter the name of each status check you would like to require. To finish adding the status check as a requirement, you must click {% octicon "plus" aria-label="Add selected status checks" %}. -- If you select **Require branches to be up to date before merging**, you must define a check for the protection to take effect. +* You can enter the name of each status check you would like to require. To finish adding the status check as a requirement, you must click {% octicon "plus" aria-label="Add selected status checks" %}. +* If you select **Require branches to be up to date before merging**, you must define a check for the protection to take effect. {% endnote %} diff --git a/data/reusables/repositories/rulesets-require-code-scanning-results.md b/data/reusables/repositories/rulesets-require-code-scanning-results.md index 52c1e926e7..230e6d1fbc 100644 --- a/data/reusables/repositories/rulesets-require-code-scanning-results.md +++ b/data/reusables/repositories/rulesets-require-code-scanning-results.md @@ -1,8 +1,8 @@ 1. Under "Branch protections", select **Require {% data variables.product.prodname_code_scanning %} results**. 1. Under "Required tools and alert thresholds", click **{% octicon "plus" aria-label="Add tool" %} Add tool** and select a {% data variables.product.prodname_code_scanning %} tool with the dropdown. For example, "{% data variables.product.prodname_codeql %}". 1. Next to the name of a {% data variables.product.prodname_code_scanning %} tool: - - Click **Alerts** and select one of: **None**, **Errors**, **Errors and Warnings** or **All**. - - Click **Security alerts** and select one of: **None**, **Critical**, **High or higher**, **Medium or higher**, or **All**. + * Click **Alerts** and select one of: **None**, **Errors**, **Errors and Warnings** or **All**. + * Click **Security alerts** and select one of: **None**, **Critical**, **High or higher**, **Medium or higher**, or **All**. ![Screenshot of the "Required tools and alert thresholds" section of "Rulesets" settings.](/assets/images/help/repository/rulesets-require-code-scanning.png) diff --git a/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md b/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md index 598f7cfed8..a365d69d29 100644 --- a/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md +++ b/data/reusables/repositories/rulesets-unsupported-fnmatch-syntax.md @@ -2,8 +2,8 @@ **Note:** Not all expressions from the `fnmatch` syntax are supported in branch protection rules. Please be aware of the following constraints: -- You cannot use the backslash (`\`) character as a quoting character, as {% data variables.product.prodname_dotcom %} does not support the use of backslashes in branch protection rules. -- You can specify character sets within square brackets (`[]`), but you cannot currently complement a set with the `^` operator (e.g., `[^charset]`). -- Although {% data variables.product.prodname_dotcom %} supports `File::FNM_PATHNAME` in `fnmatch` syntax, `File::FNM_EXTGLOB` is not supported. +* You cannot use the backslash (`\`) character as a quoting character, as {% data variables.product.prodname_dotcom %} does not support the use of backslashes in branch protection rules. +* You can specify character sets within square brackets (`[]`), but you cannot currently complement a set with the `^` operator (e.g., `[^charset]`). +* Although {% data variables.product.prodname_dotcom %} supports `File::FNM_PATHNAME` in `fnmatch` syntax, `File::FNM_EXTGLOB` is not supported. {% endnote %} diff --git a/data/reusables/repositories/tracks-vulnerabilities.md b/data/reusables/repositories/tracks-vulnerabilities.md index 612b286f81..815902595d 100644 --- a/data/reusables/repositories/tracks-vulnerabilities.md +++ b/data/reusables/repositories/tracks-vulnerabilities.md @@ -1,12 +1,12 @@ We add advisories to the {% data variables.product.prodname_advisory_database %} from the following sources: -- Security advisories reported on {% data variables.product.prodname_dotcom %} -- The [National Vulnerability database](https://nvd.nist.gov/) -- The [npm Security advisories database](https://github.com/advisories?query=type%3Areviewed+ecosystem%3Anpm) -- The [FriendsOfPHP database](https://github.com/FriendsOfPHP/security-advisories) -- The [Go Vulncheck database](https://pkg.go.dev/vuln/) -- The [Python Packaging Advisory database](https://github.com/pypa/advisory-database) -- The [Ruby Advisory database](https://rubysec.com/) -- The [RustSec Advisory database](https://rustsec.org/) -- Community contributions. For more information, see [https://github.com/github/advisory-database/pulls](https://github.com/github/advisory-database/pulls). +* Security advisories reported on {% data variables.product.prodname_dotcom %} +* The [National Vulnerability database](https://nvd.nist.gov/) +* The [npm Security advisories database](https://github.com/advisories?query=type%3Areviewed+ecosystem%3Anpm) +* The [FriendsOfPHP database](https://github.com/FriendsOfPHP/security-advisories) +* The [Go Vulncheck database](https://pkg.go.dev/vuln/) +* The [Python Packaging Advisory database](https://github.com/pypa/advisory-database) +* The [Ruby Advisory database](https://rubysec.com/) +* The [RustSec Advisory database](https://rustsec.org/) +* Community contributions. For more information, see [https://github.com/github/advisory-database/pulls](https://github.com/github/advisory-database/pulls). If you know of another database we should be importing advisories from, tell us about it by opening an issue in [https://github.com/github/advisory-database](https://github.com/github/advisory-database). diff --git a/data/reusables/repositories/transfer-repository-steps.md b/data/reusables/repositories/transfer-repository-steps.md index 24b26b2c74..f40cb18953 100644 --- a/data/reusables/repositories/transfer-repository-steps.md +++ b/data/reusables/repositories/transfer-repository-steps.md @@ -1,17 +1,17 @@ {%- ifversion rename-and-transfer-repository %} 1. At the bottom of the page, in the "Danger Zone" section, click **Transfer**. 1. Read the information about transferring a repository, then, under "New owner", choose how to specify the new owner. - - To choose one of your organizations, select **Select one of my organizations**. + * To choose one of your organizations, select **Select one of my organizations**. - - Select the dropdown menu and click an organization. - - Optionally, in the "Repository name" field, type a new name for the repository. + * Select the dropdown menu and click an organization. + * Optionally, in the "Repository name" field, type a new name for the repository. {% note %} **Note:** You must be an owner of the target organization to rename the repository. {% endnote %} - - To specify an organization or username, select **Specify an organization or username**, then type the organization name or the new owner's username. + * To specify an organization or username, select **Specify an organization or username**, then type the organization name or the new owner's username. 1. Read the warnings about potential loss of features depending on the new owner's {% data variables.product.prodname_dotcom %} subscription. 1. Following **Type REPOSITORY NAME to confirm**, type the name of the repository you'd like to transfer, then click **I understand, transfer this repository**. {%- else %} diff --git a/data/reusables/rest-api/about-api-versions.md b/data/reusables/rest-api/about-api-versions.md index c1db7f0733..c0397de377 100644 --- a/data/reusables/rest-api/about-api-versions.md +++ b/data/reusables/rest-api/about-api-versions.md @@ -2,23 +2,23 @@ The {% data variables.product.product_name %} REST API is versioned. The API ver Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking changes include: -- removing an entire operation -- removing or renaming a parameter -- removing or renaming a response field -- adding a new required parameter -- making a previously optional parameter required -- changing the type of a parameter or response field -- removing enum values -- adding a new validation rule to an existing parameter -- changing authentication or authorization requirements +* removing an entire operation +* removing or renaming a parameter +* removing or renaming a response field +* adding a new required parameter +* making a previously optional parameter required +* changing the type of a parameter or response field +* removing enum values +* adding a new validation rule to an existing parameter +* changing authentication or authorization requirements Any additive (non-breaking) changes will be available in all supported API versions. Additive changes are changes that should not break an integration. Additive changes include: -- adding an operation -- adding an optional parameter -- adding an optional request header -- adding a response field -- adding a response header -- adding enum values +* adding an operation +* adding an optional parameter +* adding an optional request header +* adding a response field +* adding a response header +* adding enum values When a new REST API version is released, the previous API version will be supported for at least 24 more months following the release of the new API version. diff --git a/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md b/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md index 94d38171b7..fad9bc9b93 100644 --- a/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md +++ b/data/reusables/rest-api/secondary-rate-limit-rest-graphql.md @@ -2,10 +2,10 @@ In addition to primary rate limits, {% data variables.product.company_short %} e You may encounter a secondary rate limit if you: -- _Make too many concurrent requests._ No more than 100 concurrent requests are allowed. This limit is shared across the REST API and GraphQL API. -- _Make too many requests to a single endpoint per minute._ No more than 900 points per minute are allowed for REST API endpoints, and no more than 2,000 points per minute are allowed for the GraphQL API endpoint. For more information about points, see "[Calculating points for the secondary rate limit](#calculating-points-for-the-secondary-rate-limit)." -- _Make too many requests per minute._ No more than 90 seconds of CPU time per 60 seconds of real time is allowed. No more than 60 seconds of this CPU time may be for the GraphQL API. You can roughly estimate the CPU time by measuring the total response time for your API requests. -- _Create too much content on {% data variables.product.company_short %} in a short amount of time._ In general, no more than 80 content-generating requests per minute and no more than 500 content-generating requests per hour are allowed. Some endpoints have lower content creation limits. Content creation limits include actions taken on the {% data variables.product.company_short %} web interface as well as via the REST API and GraphQL API. +* _Make too many concurrent requests._ No more than 100 concurrent requests are allowed. This limit is shared across the REST API and GraphQL API. +* _Make too many requests to a single endpoint per minute._ No more than 900 points per minute are allowed for REST API endpoints, and no more than 2,000 points per minute are allowed for the GraphQL API endpoint. For more information about points, see "[Calculating points for the secondary rate limit](#calculating-points-for-the-secondary-rate-limit)." +* _Make too many requests per minute._ No more than 90 seconds of CPU time per 60 seconds of real time is allowed. No more than 60 seconds of this CPU time may be for the GraphQL API. You can roughly estimate the CPU time by measuring the total response time for your API requests. +* _Create too much content on {% data variables.product.company_short %} in a short amount of time._ In general, no more than 80 content-generating requests per minute and no more than 500 content-generating requests per hour are allowed. Some endpoints have lower content creation limits. Content creation limits include actions taken on the {% data variables.product.company_short %} web interface as well as via the REST API and GraphQL API. These secondary rate limits are subject to change without notice. You may also encounter a secondary rate limit for undisclosed reasons. diff --git a/data/reusables/saml/authorized-creds-info.md b/data/reusables/saml/authorized-creds-info.md index 5a3690a01e..5ae13046dd 100644 --- a/data/reusables/saml/authorized-creds-info.md +++ b/data/reusables/saml/authorized-creds-info.md @@ -1,7 +1,7 @@ Before you can authorize a {% data variables.product.pat_generic %} or SSH key, you must have a linked SAML identity. If you're a member of an organization where SAML SSO is enabled, you can create a linked identity by authenticating to your organization with your IdP at least once. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)." After you authorize a {% data variables.product.pat_generic %} or SSH key, the token or key will stay authorized until revoked in one of the following ways. -- An organization or enterprise owner revokes the authorization. -- You are removed from the organization. -- The scopes in a {% data variables.product.pat_generic %} are edited, or the token is regenerated. -- The {% data variables.product.pat_generic %} expired as defined during creation. +* An organization or enterprise owner revokes the authorization. +* You are removed from the organization. +* The scopes in a {% data variables.product.pat_generic %} are edited, or the token is regenerated. +* The {% data variables.product.pat_generic %} expired as defined during creation. diff --git a/data/reusables/saml/idp-saml-and-scim-explanation.md b/data/reusables/saml/idp-saml-and-scim-explanation.md index 36075a34f4..d0444b7dad 100644 --- a/data/reusables/saml/idp-saml-and-scim-explanation.md +++ b/data/reusables/saml/idp-saml-and-scim-explanation.md @@ -1,5 +1,5 @@ When you use an IdP for IAM on {% data variables.product.product_name %}, SAML SSO controls and secures access to enterprise resources like repositories, issues, and pull requests. SCIM automatically creates user accounts and manages access to {% data variables.location.product_location %} when you make changes on the IdP. You can also synchronize teams on {% data variables.product.product_name %} with groups on your IdP. For more information, see the following articles. -- "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam)" -- "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise)" -- "[AUTOTITLE](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)" +* "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/about-saml-for-enterprise-iam)" +* "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise)" +* "[AUTOTITLE](/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group)" diff --git a/data/reusables/saml/resources-without-sso.md b/data/reusables/saml/resources-without-sso.md index c5a1c750ff..0798fbc1f8 100644 --- a/data/reusables/saml/resources-without-sso.md +++ b/data/reusables/saml/resources-without-sso.md @@ -1,7 +1,7 @@ IdP authentication is not required for accessing public repositories in certain ways: -- Viewing the repository's overview page and file contents on {% data variables.product.prodname_dotcom %} -- Forking the repository -- Performing read operations via Git, such as cloning the repository +* Viewing the repository's overview page and file contents on {% data variables.product.prodname_dotcom %} +* Forking the repository +* Performing read operations via Git, such as cloning the repository Authentication is required for other access to public repositories, such as viewing issues, pull requests, projects, and releases. diff --git a/data/reusables/saml/saml-supported-idps.md b/data/reusables/saml/saml-supported-idps.md index 0d1a21369b..fa9d7f7956 100644 --- a/data/reusables/saml/saml-supported-idps.md +++ b/data/reusables/saml/saml-supported-idps.md @@ -2,9 +2,9 @@ {% data variables.product.company_short %} officially supports and internally tests the following IdPs. -- Microsoft Active Directory Federation Services (AD FS) -- Microsoft Entra ID (previously known as Azure AD) -- Okta -- OneLogin -- PingOne -- Shibboleth +* Microsoft Active Directory Federation Services (AD FS) +* Microsoft Entra ID (previously known as Azure AD) +* Okta +* OneLogin +* PingOne +* Shibboleth diff --git a/data/reusables/scim/scim-standard-prerequisite.md b/data/reusables/scim/scim-standard-prerequisite.md index 152cea96a4..eef6499e28 100644 --- a/data/reusables/scim/scim-standard-prerequisite.md +++ b/data/reusables/scim/scim-standard-prerequisite.md @@ -1,5 +1,5 @@ To provision users and groups with {% data variables.product.prodname_dotcom %}'s REST API, your identity management system must support the SCIM 2.0 standard. For more information, see the following RFCs on the IETF website. - - [RFC 7642: Definitions, Overview, Concepts, and Requirements](https://tools.ietf.org/html/rfc7642) - - [RFC 7643: Core Schema](https://tools.ietf.org/html/rfc7643) - - [RFC 7644: Protocol](https://tools.ietf.org/html/rfc7644) + * [RFC 7642: Definitions, Overview, Concepts, and Requirements](https://tools.ietf.org/html/rfc7642) + * [RFC 7643: Core Schema](https://tools.ietf.org/html/rfc7643) + * [RFC 7644: Protocol](https://tools.ietf.org/html/rfc7644) diff --git a/data/reusables/search/code-nav-supported-languages.md b/data/reusables/search/code-nav-supported-languages.md index 31e490ab27..d117e1a9d2 100644 --- a/data/reusables/search/code-nav-supported-languages.md +++ b/data/reusables/search/code-nav-supported-languages.md @@ -1,20 +1,20 @@ -- Bash -- C -- C# -- C++ -- CodeQL -- Elixir -- Go -- JSX -- Java -- JavaScript -- Lua -- PHP -- Protocol Buffers -- Python -- Ruby -- Rust -- Scala -- Starlark -- Swift -- Typescript +* Bash +* C +* C# +* C++ +* CodeQL +* Elixir +* Go +* JSX +* Java +* JavaScript +* Lua +* PHP +* Protocol Buffers +* Python +* Ruby +* Rust +* Scala +* Starlark +* Swift +* Typescript diff --git a/data/reusables/search/syntax_tips.md b/data/reusables/search/syntax_tips.md index 0c7bcf9757..8036e94853 100644 --- a/data/reusables/search/syntax_tips.md +++ b/data/reusables/search/syntax_tips.md @@ -1,8 +1,8 @@ {% tip %} **Tips:**{% ifversion ghes %} -- This article contains links to example searches on the {% data variables.product.prodname_dotcom_the_website %} website, but you can use the same search filters with {% data variables.product.product_name %}. In the linked example searches, replace `github.com` with the hostname for {% data variables.location.product_location %}.{% endif %} -- For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". -- Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. +* This article contains links to example searches on the {% data variables.product.prodname_dotcom_the_website %} website, but you can use the same search filters with {% data variables.product.product_name %}. In the linked example searches, replace `github.com` with the hostname for {% data variables.location.product_location %}.{% endif %} +* For a list of search syntaxes that you can add to any search qualifier to further improve your results, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax)". +* Use quotations around multi-word search terms. For example, if you want to search for issues with the label "In progress," you'd search for `label:"in progress"`. Search is not case sensitive. {% endtip %} diff --git a/data/reusables/secret-scanning/push-protection-bypass.md b/data/reusables/secret-scanning/push-protection-bypass.md index bca915c783..4c4a9a7728 100644 --- a/data/reusables/secret-scanning/push-protection-bypass.md +++ b/data/reusables/secret-scanning/push-protection-bypass.md @@ -1,4 +1,4 @@ If a contributor bypasses a push protection block for a secret, {% data variables.product.prodname_dotcom %}: -- Creates an alert in the **Security** tab of the repository. -- Adds the bypass event to the audit log.{% ifversion secret-scanning-push-protection-email %} -- Sends an email alert to organization or personal account owners, security managers, and repository administrators who are watching the repository, with a link to the secret and the reason why it was allowed.{% endif %} +* Creates an alert in the **Security** tab of the repository. +* Adds the bypass event to the audit log.{% ifversion secret-scanning-push-protection-email %} +* Sends an email alert to organization or personal account owners, security managers, and repository administrators who are watching the repository, with a link to the secret and the reason why it was allowed.{% endif %} diff --git a/data/reusables/secret-scanning/push-protection-choose-allow-secret-options.md b/data/reusables/secret-scanning/push-protection-choose-allow-secret-options.md index 63765a8f69..45b48b3e0a 100644 --- a/data/reusables/secret-scanning/push-protection-choose-allow-secret-options.md +++ b/data/reusables/secret-scanning/push-protection-choose-allow-secret-options.md @@ -1,4 +1,4 @@ 1. Choose the option that best describes why you should be able to push the secret. - - If the secret is only used in tests and poses no threat, click **It's used in tests**. - - If the detected string is not a secret, click **It's a false positive**. - - If the secret is real but you intend to fix it later, click **I'll fix it later**. + * If the secret is only used in tests and poses no threat, click **It's used in tests**. + * If the detected string is not a secret, click **It's a false positive**. + * If the secret is real but you intend to fix it later, click **I'll fix it later**. diff --git a/data/reusables/secret-scanning/push-protection-enterprise-note.md b/data/reusables/secret-scanning/push-protection-enterprise-note.md index 5f09ca78aa..a99fa4423d 100644 --- a/data/reusables/secret-scanning/push-protection-enterprise-note.md +++ b/data/reusables/secret-scanning/push-protection-enterprise-note.md @@ -2,7 +2,7 @@ **Notes:** -- To enable push protection for custom patterns, {% data variables.product.prodname_secret_scanning %} as push protection needs to be enabled at the enterprise level. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-your-enterprise)." -- Enabling push protection for commonly found custom patterns can be disruptive to contributors. +* To enable push protection for custom patterns, {% data variables.product.prodname_secret_scanning %} as push protection needs to be enabled at the enterprise level. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-your-enterprise)." +* Enabling push protection for commonly found custom patterns can be disruptive to contributors. {% endnote %} diff --git a/data/reusables/secret-scanning/push-protection-multiple-branch-note.md b/data/reusables/secret-scanning/push-protection-multiple-branch-note.md index 7ceaaf6f52..df569cb53e 100644 --- a/data/reusables/secret-scanning/push-protection-multiple-branch-note.md +++ b/data/reusables/secret-scanning/push-protection-multiple-branch-note.md @@ -2,7 +2,7 @@ **Notes**: -- If your Git configuration supports pushes to multiple branches, and not only to the current branch, your push may be blocked due to additional and unintended refs being pushed. For more information, see the [`push.default` options](https://git-scm.com/docs/git-config#Documentation/git-config.txt-pushdefault) in the Git documentation. -- If {% data variables.product.prodname_secret_scanning %} upon a push times out, {% data variables.product.prodname_dotcom %} will still scan your commits for secrets after the push. +* If your Git configuration supports pushes to multiple branches, and not only to the current branch, your push may be blocked due to additional and unintended refs being pushed. For more information, see the [`push.default` options](https://git-scm.com/docs/git-config#Documentation/git-config.txt-pushdefault) in the Git documentation. +* If {% data variables.product.prodname_secret_scanning %} upon a push times out, {% data variables.product.prodname_dotcom %} will still scan your commits for secrets after the push. {% endnote %} diff --git a/data/reusables/secret-scanning/push-protection-org-notes.md b/data/reusables/secret-scanning/push-protection-org-notes.md index ba2a710b49..5922abc4ae 100644 --- a/data/reusables/secret-scanning/push-protection-org-notes.md +++ b/data/reusables/secret-scanning/push-protection-org-notes.md @@ -1,8 +1,8 @@ {% note %} **Notes:** -- The option to enable push protection is visible for published patterns only. -- Push protection for custom patterns will only apply to repositories in your organization that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization)." -- Enabling push protection for commonly found custom patterns can be disruptive to contributors. +* The option to enable push protection is visible for published patterns only. +* Push protection for custom patterns will only apply to repositories in your organization that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-an-organization)." +* Enabling push protection for commonly found custom patterns can be disruptive to contributors. {% endnote %} diff --git a/data/reusables/secret-scanning/push-protection-repo-notes.md b/data/reusables/secret-scanning/push-protection-repo-notes.md index 2c40a82024..7d2844f6a2 100644 --- a/data/reusables/secret-scanning/push-protection-repo-notes.md +++ b/data/reusables/secret-scanning/push-protection-repo-notes.md @@ -2,7 +2,7 @@ **Notes:** -- Push protection for custom patterns will only apply to repositories that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-a-repository)." -- Enabling push protection for commonly found custom patterns can be disruptive to contributors. +* Push protection for custom patterns will only apply to repositories that have {% data variables.product.prodname_secret_scanning %} as push protection enabled. For more information, see "[AUTOTITLE](/code-security/secret-scanning/protecting-pushes-with-secret-scanning#enabling-secret-scanning-as-a-push-protection-for-a-repository)." +* Enabling push protection for commonly found custom patterns can be disruptive to contributors. {% endnote %} diff --git a/data/reusables/secret-scanning/secret-scanning-configure-notifications.md b/data/reusables/secret-scanning/secret-scanning-configure-notifications.md index fa0a89e3df..01b1694a2c 100644 --- a/data/reusables/secret-scanning/secret-scanning-configure-notifications.md +++ b/data/reusables/secret-scanning/secret-scanning-configure-notifications.md @@ -1,13 +1,13 @@ When a new secret is detected, {% data variables.product.product_name %} notifies all users with access to security alerts for the repository according to their notification preferences. These users include: -- Repository administrators -- Security managers -- Users with custom roles with read/write access -- Organization owners and enterprise owners, if they are administrators of repositories where secrets were leaked +* Repository administrators +* Security managers +* Users with custom roles with read/write access +* Organization owners and enterprise owners, if they are administrators of repositories where secrets were leaked > [!NOTE] > Commit authors who've accidentally committed secrets will be notified, regardless of their notification preferences. You will receive an email notification if: -- You are watching the repository. -- You have enabled notifications for "All Activity", or for custom "Security alerts" on the repository{% ifversion secret-scanning-notification-settings %}. -- In your notification settings, under "Subscriptions", then under "Watching", you have selected to receive notifications by email.{% endif %} +* You are watching the repository. +* You have enabled notifications for "All Activity", or for custom "Security alerts" on the repository{% ifversion secret-scanning-notification-settings %}. +* In your notification settings, under "Subscriptions", then under "Watching", you have selected to receive notifications by email.{% endif %} diff --git a/data/reusables/secret-scanning/view-custom-pattern.md b/data/reusables/secret-scanning/view-custom-pattern.md index 840abc08ce..01fb785318 100644 --- a/data/reusables/secret-scanning/view-custom-pattern.md +++ b/data/reusables/secret-scanning/view-custom-pattern.md @@ -1,3 +1,3 @@ 1. Navigate to where the custom pattern was created. A custom pattern can be created in a repository, organization, or enterprise account. - - For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)". - - For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](#defining-a-custom-pattern-for-an-enterprise-account)" above. + * For a repository or organization, display the "Security & analysis" settings for the repository or organization where the custom pattern was created. For more information, see "[Defining a custom pattern for a repository](#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](#defining-a-custom-pattern-for-an-organization)". + * For an enterprise, under "Policies" display the "Advanced Security" area, and then click **Security features**. For more information, see "[Defining a custom pattern for an enterprise account](#defining-a-custom-pattern-for-an-enterprise-account)" above. diff --git a/data/reusables/secret-scanning/what-is-scanned.md b/data/reusables/secret-scanning/what-is-scanned.md index 0a36ffbd26..0b605a1cae 100644 --- a/data/reusables/secret-scanning/what-is-scanned.md +++ b/data/reusables/secret-scanning/what-is-scanned.md @@ -1,9 +1,9 @@ {% ifversion fpt or ghec or ghes > 3.10 %}Additionally, {% data variables.product.prodname_secret_scanning %} scans:{% ifversion secret-scanning-issue-body-comments %} -- Descriptions and comments in issues{% endif %}{% ifversion secret-scanning-backfills-historical-issues %} -- Titles, descriptions, and comments, in open and closed _historical_ issues{% ifversion ghec %}. A notification is sent to the relevant partner when a historical partner pattern is detected.{% endif %}{% endif %}{% ifversion secret-scanning-enhancements-prs-discussions %} -- Titles, descriptions, and comments in pull requests -- Titles, descriptions, and comments in {% data variables.product.prodname_discussions %}{% endif %}{% ifversion secret-scanning-enhancements-wikis %} -- Wikis{% endif %} +* Descriptions and comments in issues{% endif %}{% ifversion secret-scanning-backfills-historical-issues %} +* Titles, descriptions, and comments, in open and closed _historical_ issues{% ifversion ghec %}. A notification is sent to the relevant partner when a historical partner pattern is detected.{% endif %}{% endif %}{% ifversion secret-scanning-enhancements-prs-discussions %} +* Titles, descriptions, and comments in pull requests +* Titles, descriptions, and comments in {% data variables.product.prodname_discussions %}{% endif %}{% ifversion secret-scanning-enhancements-wikis %} +* Wikis{% endif %} {% ifversion fpt or ghec %} This additional scanning is free for public repositories. diff --git a/data/reusables/security-advisory/private-vulnerability-reporting-benefits.md b/data/reusables/security-advisory/private-vulnerability-reporting-benefits.md index bbb4bd961c..d446e99647 100644 --- a/data/reusables/security-advisory/private-vulnerability-reporting-benefits.md +++ b/data/reusables/security-advisory/private-vulnerability-reporting-benefits.md @@ -1,6 +1,6 @@ -- Less risk of being contacted publicly, or via undesired means. -- Receive reports in the same platform you resolve them in for simplicity -- The security researcher creates or at least initiates the advisory report on the behalf of maintainers. -- Maintainers receive reports in the same platform as the one used to discuss and resolve the advisories. -- Vulnerability less likely to be in the public eye. -- The opportunity to discuss vulnerability details privately with security researchers and collaborate on the patch. +* Less risk of being contacted publicly, or via undesired means. +* Receive reports in the same platform you resolve them in for simplicity +* The security researcher creates or at least initiates the advisory report on the behalf of maintainers. +* Maintainers receive reports in the same platform as the one used to discuss and resolve the advisories. +* Vulnerability less likely to be in the public eye. +* The opportunity to discuss vulnerability details privately with security researchers and collaborate on the patch. diff --git a/data/reusables/security-advisory/private-vulnerability-reporting-configure-notifications.md b/data/reusables/security-advisory/private-vulnerability-reporting-configure-notifications.md index d6e1337cc3..ff13ca9f27 100644 --- a/data/reusables/security-advisory/private-vulnerability-reporting-configure-notifications.md +++ b/data/reusables/security-advisory/private-vulnerability-reporting-configure-notifications.md @@ -1,4 +1,4 @@ When a new vulnerability is privately reported on a repository where private vulnerability reporting is enabled, {% data variables.product.product_name %} notifies repository maintainers and security managers if: -- They're watching the repository for all activity. -- They have notifications enabled for the repository. +* They're watching the repository for all activity. +* They have notifications enabled for the repository. diff --git a/data/reusables/security-overview/filter-and-toggle.md b/data/reusables/security-overview/filter-and-toggle.md index 8b839eaf58..0e212f6996 100644 --- a/data/reusables/security-overview/filter-and-toggle.md +++ b/data/reusables/security-overview/filter-and-toggle.md @@ -1,6 +1,6 @@ 1. Use the options at the top of the overview page to filter the group of alerts you want to see metrics for. All of the data and metrics on the page will change as you adjust the filters. - - Use the date picker to set the time range that you want to view alert activity and metrics for. - - Click in the search box to add further filters on the alerts and metrics displayed. + * Use the date picker to set the time range that you want to view alert activity and metrics for. + * Click in the search box to add further filters on the alerts and metrics displayed. ![Screenshot of the overview page in security overview. Filtering options are outlined in dark orange, including the date picker and search field.](/assets/images/help/security-overview/security-overview-dashboard-filters.png) diff --git a/data/reusables/security-overview/settings-limitations.md b/data/reusables/security-overview/settings-limitations.md index 6654fea547..f993c80bfe 100644 --- a/data/reusables/security-overview/settings-limitations.md +++ b/data/reusables/security-overview/settings-limitations.md @@ -3,8 +3,8 @@ **Notes:** -- Enabling {% data variables.product.prodname_code_scanning %} default setup _will not_ override any existing configurations of advanced setup for the selected repositories, but it _will_ override any existing configurations of default setup. -- Enabling "Alerts" for {% data variables.product.prodname_secret_scanning %} enables high-confidence alerts. If you want to enable non-provider alerts, you need to edit the repository, organization, or enterprise settings. For more information about alert types, see "[Supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." +* Enabling {% data variables.product.prodname_code_scanning %} default setup _will not_ override any existing configurations of advanced setup for the selected repositories, but it _will_ override any existing configurations of default setup. +* Enabling "Alerts" for {% data variables.product.prodname_secret_scanning %} enables high-confidence alerts. If you want to enable non-provider alerts, you need to edit the repository, organization, or enterprise settings. For more information about alert types, see "[Supported secrets](/code-security/secret-scanning/secret-scanning-patterns#supported-secrets)." {% endnote %} diff --git a/data/reusables/security/compliance-report-list.md b/data/reusables/security/compliance-report-list.md index c8c46a6580..c95354edd3 100644 --- a/data/reusables/security/compliance-report-list.md +++ b/data/reusables/security/compliance-report-list.md @@ -1,15 +1,15 @@ {%- ifversion ghec %} -- SOC 1, Type 2 -- SOC 2, Type 1 ({% data variables.product.prodname_copilot_for_business %} only) -- SOC 2, Type 2 +* SOC 1, Type 2 +* SOC 2, Type 1 ({% data variables.product.prodname_copilot_for_business %} only) +* SOC 2, Type 2 {%- elsif fpt %} -- SOC 3 +* SOC 3 {%- endif %} -- Cloud Security Alliance CAIQ self-assessment (CSA CAIQ - Level 1) -- ISO/IEC 27001:2013 certification +* Cloud Security Alliance CAIQ self-assessment (CSA CAIQ - Level 1) +* ISO/IEC 27001:2013 certification {%- ifversion ghec %} -- ISO/IEC 27701:2019 (Processor) certification -- ISO/IEC 27018:2019 certification -- Cloud Security Alliance STAR certification (CSA STAR - Level 2) -- {% data variables.product.prodname_dotcom_the_website %} Services Continuity and Incident Management Plan +* ISO/IEC 27701:2019 (Processor) certification +* ISO/IEC 27018:2019 certification +* Cloud Security Alliance STAR certification (CSA STAR - Level 2) +* {% data variables.product.prodname_dotcom_the_website %} Services Continuity and Incident Management Plan {%- endif %} diff --git a/data/reusables/security/displayed-information.md b/data/reusables/security/displayed-information.md index acb54d22be..82f9bee013 100644 --- a/data/reusables/security/displayed-information.md +++ b/data/reusables/security/displayed-information.md @@ -1,8 +1,8 @@ When you enable one or more security and analysis features for existing repositories, you will see any results displayed on {% data variables.product.prodname_dotcom %} within minutes: -- All the existing repositories will have the selected configuration. -- New repositories will follow the selected configuration if you've enabled the checkbox for new repositories.{% ifversion GH-advisory-db-supports-malware %} -- We use the permissions to scan for manifest files to apply the relevant services. -- If enabled, you'll see dependency information in the dependency graph. -- If enabled, {% data variables.product.prodname_dotcom %} will generate {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies or malware.{% endif %} -- If enabled, {% data variables.product.prodname_dependabot %} security updates will create pull requests to upgrade vulnerable dependencies when {% data variables.product.prodname_dependabot_alerts %} are triggered. +* All the existing repositories will have the selected configuration. +* New repositories will follow the selected configuration if you've enabled the checkbox for new repositories.{% ifversion GH-advisory-db-supports-malware %} +* We use the permissions to scan for manifest files to apply the relevant services. +* If enabled, you'll see dependency information in the dependency graph. +* If enabled, {% data variables.product.prodname_dotcom %} will generate {% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies or malware.{% endif %} +* If enabled, {% data variables.product.prodname_dependabot %} security updates will create pull requests to upgrade vulnerable dependencies when {% data variables.product.prodname_dependabot_alerts %} are triggered. diff --git a/data/reusables/sponsors/edit-featured-work.md b/data/reusables/sponsors/edit-featured-work.md index 6fc2589768..24ce19c104 100644 --- a/data/reusables/sponsors/edit-featured-work.md +++ b/data/reusables/sponsors/edit-featured-work.md @@ -1,3 +1,3 @@ 1. Optionally, choose the repositories that are showcased on your {% data variables.product.prodname_sponsors %} profile. - - In the "Featured work" section, to the right of the section title, click **Edit**. - - In the modal that appears, select up to six repositories, then click **Save**. + * In the "Featured work" section, to the right of the section title, click **Edit**. + * In the modal that appears, select up to six repositories, then click **Save**. diff --git a/data/reusables/sponsors/meet-the-team.md b/data/reusables/sponsors/meet-the-team.md index e6ec7ccc62..25597be2e6 100644 --- a/data/reusables/sponsors/meet-the-team.md +++ b/data/reusables/sponsors/meet-the-team.md @@ -1,7 +1,7 @@ 1. Optionally, choose the organization members that are highlighted on your {% data variables.product.prodname_sponsors %} profile. - - In the "Meet the team" section, to the right of the section title, click **Edit**. - - Select up to six organization members, then click **Save**. + * In the "Meet the team" section, to the right of the section title, click **Edit**. + * Select up to six organization members, then click **Save**. ![Screenshot of a modal for adding organization members to an organization's {% data variables.product.prodname_sponsors %} profile.](/assets/images/help/sponsors/select-highlighted-org-members.png) - - Optionally, under each highlighted member's name, type a description of the member. + * Optionally, under each highlighted member's name, type a description of the member. diff --git a/data/reusables/sponsors/navigate-to-sponsorship-dashboard.md b/data/reusables/sponsors/navigate-to-sponsorship-dashboard.md index c6c797fb74..6f1ff819d8 100644 --- a/data/reusables/sponsors/navigate-to-sponsorship-dashboard.md +++ b/data/reusables/sponsors/navigate-to-sponsorship-dashboard.md @@ -1,5 +1,5 @@ 1. Navigate to your sponsorship dashboard for the account. - - To sponsor a developer, under the developer's name, click **Sponsor**. + * To sponsor a developer, under the developer's name, click **Sponsor**. ![Screenshot of the sidebar of @octocat's profile page. A button, labeled with a heart icon and "Sponsor", is outlined in dark orange.](/assets/images/help/profile/sponsor-button.png) - - To sponsor an organization, to the right of the organization's name, click **Sponsor**. + * To sponsor an organization, to the right of the organization's name, click **Sponsor**. diff --git a/data/reusables/sponsors/no-fees.md b/data/reusables/sponsors/no-fees.md index 2de8588fb5..b16728241a 100644 --- a/data/reusables/sponsors/no-fees.md +++ b/data/reusables/sponsors/no-fees.md @@ -1,6 +1,6 @@ {% data variables.product.prodname_sponsors %} does not charge any fees for sponsorships from personal accounts, so 100% of these sponsorships go to the sponsored developer or organization. {% data variables.product.prodname_sponsors %} charges a fee of up to 6% for sponsorships from organization accounts. The 6% fee is split between the following: -- 3% credit card processing fee -- 3% {% data variables.product.company_short %} service processing fee +* 3% credit card processing fee +* 3% {% data variables.product.company_short %} service processing fee Organizations can save the 3% credit card processing fee by switching to invoiced billing for sponsorships. For more information, see "[AUTOTITLE](/sponsors/sponsoring-open-source-contributors/paying-for-github-sponsors-by-invoice)." diff --git a/data/reusables/sponsors/sponsor-as-business.md b/data/reusables/sponsors/sponsor-as-business.md index b03aeee74f..efc9f841fb 100644 --- a/data/reusables/sponsors/sponsor-as-business.md +++ b/data/reusables/sponsors/sponsor-as-business.md @@ -1,6 +1,6 @@ 1. If you are sponsoring an account as a business, click **Yes**. Filling out the related fields will help your sponsored accounts calculate and pay taxes where appropriate. For more information, see "[Tax information for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors#sales-tax)." - - Select the "Country" dropdown menu, then click your business' country. - - Next, select the "Region" dropdown menu and click your business' region within your country. - - If applicable, click the "VAT number" text field, then type your value-added tax (VAT) identification number. + * Select the "Country" dropdown menu, then click your business' country. + * Next, select the "Region" dropdown menu and click your business' region within your country. + * If applicable, click the "VAT number" text field, then type your value-added tax (VAT) identification number. ![Screenshot of the sponsorship checkout page. The fields for sponsoring as a business are outlined in dark orange.](/assets/images/help/sponsors/bulk-sponsors-business-purchase.png) diff --git a/data/reusables/sponsors/sponsorship-dashboard.md b/data/reusables/sponsors/sponsorship-dashboard.md index c0b8044c9e..8c2f26039f 100644 --- a/data/reusables/sponsors/sponsorship-dashboard.md +++ b/data/reusables/sponsors/sponsorship-dashboard.md @@ -1,6 +1,6 @@ 1. Navigate to your sponsorship dashboard for the account. - - If you're sponsoring a personal account, under the user's name, click **Sponsoring**. + * If you're sponsoring a personal account, under the user's name, click **Sponsoring**. ![Screenshot of the sidebar of @octocat's profile page. A button, labeled with a heart icon and "Sponsoring", is outlined in dark orange.](/assets/images/help/profile/sponsoring-button.png) - - If you're sponsoring an organization, to the right of the organization's name, click {% octicon "heart-fill" aria-label="" %} **Sponsoring**. + * If you're sponsoring an organization, to the right of the organization's name, click {% octicon "heart-fill" aria-label="" %} **Sponsoring**. 1. Optionally, to manage a sponsorship on behalf of an organization, on the right side of the page, use the **Sponsoring as** dropdown menu, then click the organization. diff --git a/data/reusables/sponsors/tax-form-information-dev.md b/data/reusables/sponsors/tax-form-information-dev.md index 1c62431d28..8ebfdbc78f 100644 --- a/data/reusables/sponsors/tax-form-information-dev.md +++ b/data/reusables/sponsors/tax-form-information-dev.md @@ -1,4 +1,4 @@ For more information about the tax forms you need to complete, see the following instructions on the United States Internal Revenue Service website. -- [Instructions for Form W-9](https://www.irs.gov/pub/irs-pdf/iw9.pdf), for US residents -- [Instructions for Form W-8BEN](https://www.irs.gov/pub/irs-pdf/iw8ben.pdf), for non-US residents +* [Instructions for Form W-9](https://www.irs.gov/pub/irs-pdf/iw9.pdf), for US residents +* [Instructions for Form W-8BEN](https://www.irs.gov/pub/irs-pdf/iw8ben.pdf), for non-US residents diff --git a/data/reusables/sponsors/tier-details.md b/data/reusables/sponsors/tier-details.md index 4a5292471e..6a0e5851c4 100644 --- a/data/reusables/sponsors/tier-details.md +++ b/data/reusables/sponsors/tier-details.md @@ -1,10 +1,10 @@ You can publish up to 10 one-time sponsorship tiers and 10 monthly tiers for sponsors to choose from. Each tier has its own one-time or monthly payment amount in US dollars. Publishing tiers is optional. You can customize the rewards for each tier. For example, rewards for a tier could include: -- Early access to new versions -- Logo or name in README -- Weekly newsletter updates -- Other rewards your sponsors would enjoy ✨ +* Early access to new versions +* Logo or name in README +* Weekly newsletter updates +* Other rewards your sponsors would enjoy ✨ {% data reusables.sponsors.sponsors-only-repos %} For more information, see "[AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers#adding-a-repository-to-a-sponsorship-tier)." diff --git a/data/reusables/ssh/fingerprints.md b/data/reusables/ssh/fingerprints.md index 5ccc1824e2..9011592392 100644 --- a/data/reusables/ssh/fingerprints.md +++ b/data/reusables/ssh/fingerprints.md @@ -1,4 +1,4 @@ -- `SHA256:uNiVztksCsDhcc0u9e8BujQXVUpKZIDTMczCvj3tD2s` (RSA) -- `SHA256:br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ` (DSA - deprecated) -- `SHA256:p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM` (ECDSA) -- `SHA256:+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU` (Ed25519) +* `SHA256:uNiVztksCsDhcc0u9e8BujQXVUpKZIDTMczCvj3tD2s` (RSA) +* `SHA256:br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ` (DSA - deprecated) +* `SHA256:p2QAMXNIC1TJYWeIOttrVc98/R1BUFWu3/LiyKgUfQM` (ECDSA) +* `SHA256:+DiY3wvvV6TuJJhbpZisF/zLDA0zPMSvHdkr4UvCOqU` (Ed25519) diff --git a/data/reusables/ssh/rsa-sha-1-connection-failure-criteria.md b/data/reusables/ssh/rsa-sha-1-connection-failure-criteria.md index b08eeab7b8..ef6a6491b4 100644 --- a/data/reusables/ssh/rsa-sha-1-connection-failure-criteria.md +++ b/data/reusables/ssh/rsa-sha-1-connection-failure-criteria.md @@ -1,2 +1,2 @@ -- The RSA key was added to a user account on {% data variables.location.product_location %} after the cutoff date of midnight UTC on August 1, 2022. -- The SSH client signs the connection attempt with the SHA-1 hash function. +* The RSA key was added to a user account on {% data variables.location.product_location %} after the cutoff date of midnight UTC on August 1, 2022. +* The SSH client signs the connection attempt with the SHA-1 hash function. diff --git a/data/reusables/support/enterprise-comment-on-support-tickets.md b/data/reusables/support/enterprise-comment-on-support-tickets.md index a21632b1d4..c07ac51104 100644 --- a/data/reusables/support/enterprise-comment-on-support-tickets.md +++ b/data/reusables/support/enterprise-comment-on-support-tickets.md @@ -1,6 +1,6 @@ To comment on a ticket associated with your enterprise account that was opened by another user, one of two conditions must be met: -- An email address associated with your {% data variables.product.prodname_dotcom %} account is copied on the ticket -- Your enterprise on {% data variables.product.prodname_ghe_cloud %} has a verified domain and the person who opened the ticket selected their verified-domain email +* An email address associated with your {% data variables.product.prodname_dotcom %} account is copied on the ticket +* Your enterprise on {% data variables.product.prodname_ghe_cloud %} has a verified domain and the person who opened the ticket selected their verified-domain email For more information about verifying a domain, see "[AUTOTITLE](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)" and "[AUTOTITLE](/enterprise-cloud@latest/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)." diff --git a/data/reusables/support/help_resources.md b/data/reusables/support/help_resources.md index 45cc80df72..c6dca457e4 100644 --- a/data/reusables/support/help_resources.md +++ b/data/reusables/support/help_resources.md @@ -1,7 +1,7 @@ For questions, bug reports, and discussions about {% data variables.product.prodname_github_apps %}, {% data variables.product.prodname_oauth_apps %}, and API development, explore the {% data reusables.support.prodname_support_forum_with_url %}. The discussions are moderated and maintained by {% data variables.product.company_short %} staff, and answered by the {% data variables.product.company_short %} community. Consider reaching out to [GitHub Support](https://support.github.com/) directly using the contact form for: -- guaranteed response from {% data variables.product.product_name %} staff -- support requests involving sensitive data or private concerns -- feature requests -- feedback about {% data variables.product.product_name %} products +* guaranteed response from {% data variables.product.product_name %} staff +* support requests involving sensitive data or private concerns +* feature requests +* feedback about {% data variables.product.product_name %} products diff --git a/data/reusables/support/premium-support-features.md b/data/reusables/support/premium-support-features.md index 2e2ac3bcb8..cd71dbc865 100644 --- a/data/reusables/support/premium-support-features.md +++ b/data/reusables/support/premium-support-features.md @@ -1,14 +1,14 @@ In addition to all of the benefits of {% data variables.contact.enterprise_support %}, {% data variables.product.prodname_enterprise %} customers can purchase {% data variables.contact.premium_support %}, which offers: -- Written support, in English, through our support portal 24 hours per day, 7 days per week -- Phone support via callback request, in English, through our support portal 24 hours per day, 7 days per week (when required for ticket resolution) -- A Service Level Agreement (SLA) with guaranteed initial response times -- Escalation and incident management - - Support Engineers, for Premium customers, and Customer Reliability Engineers (CREs), for Premium Plus customers, have direct access to escalation engineering resources, if needed to expedite case resolution - - Available incident coordinator to manage technical resources within {% data variables.product.company_short %} until underlying issue is mitigated or fully resolved -- Access to premium content -- Health checks +* Written support, in English, through our support portal 24 hours per day, 7 days per week +* Phone support via callback request, in English, through our support portal 24 hours per day, 7 days per week (when required for ticket resolution) +* A Service Level Agreement (SLA) with guaranteed initial response times +* Escalation and incident management + * Support Engineers, for Premium customers, and Customer Reliability Engineers (CREs), for Premium Plus customers, have direct access to escalation engineering resources, if needed to expedite case resolution + * Available incident coordinator to manage technical resources within {% data variables.product.company_short %} until underlying issue is mitigated or fully resolved +* Access to premium content +* Health checks {%- ifversion ghes %} -- Crisis prevention: Guided incident simulations that help you prepare for—and experience—an incident without risk. ({% data variables.product.premium_plus_support_plan %} only) +* Crisis prevention: Guided incident simulations that help you prepare for—and experience—an incident without risk. ({% data variables.product.premium_plus_support_plan %} only) {%- endif %} -- Application upgrade assistance: Before your upgrade, we review your upgrade plans, playbooks, and other documentation and answer questions specific to your environment ({% data variables.product.premium_plus_support_plan %} only) -- Technical advisory hours ({% data variables.product.premium_plus_support_plan %} only) +* Application upgrade assistance: Before your upgrade, we review your upgrade plans, playbooks, and other documentation and answer questions specific to your environment ({% data variables.product.premium_plus_support_plan %} only) +* Technical advisory hours ({% data variables.product.premium_plus_support_plan %} only) diff --git a/data/reusables/support/scope-of-support.md b/data/reusables/support/scope-of-support.md index 465273cb04..130bc9b9cc 100644 --- a/data/reusables/support/scope-of-support.md +++ b/data/reusables/support/scope-of-support.md @@ -1,15 +1,15 @@ If your support request is outside of the scope of what our team can help you with, we may recommend next steps to resolve your issue outside of {% data variables.contact.github_support %}. Your support request is possibly out of {% data variables.contact.github_support %}'s scope if the request is primarily about: -- Third party integrations, such as Jira -- Enterprise Cloud Importer (available only with expert-led migrations){% ifversion ghes %} -- Hardware setup{% endif %} -- CI/CD, such as Jenkins -- Writing scripts -- Configuration of external authentication systems, such as SAML identity providers -- Open source projects -- Writing or debugging new queries for {% data variables.product.prodname_codeql %} -- Cloud provider configurations, such as virtual network setup, custom firewall, or proxy rules. -- Container orchestration, such as Kubernetes setup, networking, etc. -- Beta features. Support for beta features is out of {% data variables.contact.github_support %}'s scope. {% ifversion ghec or ghes %}For support with beta features, you can contact your account manager on {% data variables.contact.contact_enterprise_sales %}.{% endif %} +* Third party integrations, such as Jira +* Enterprise Cloud Importer (available only with expert-led migrations){% ifversion ghes %} +* Hardware setup{% endif %} +* CI/CD, such as Jenkins +* Writing scripts +* Configuration of external authentication systems, such as SAML identity providers +* Open source projects +* Writing or debugging new queries for {% data variables.product.prodname_codeql %} +* Cloud provider configurations, such as virtual network setup, custom firewall, or proxy rules. +* Container orchestration, such as Kubernetes setup, networking, etc. +* Beta features. Support for beta features is out of {% data variables.contact.github_support %}'s scope. {% ifversion ghec or ghes %}For support with beta features, you can contact your account manager on {% data variables.contact.contact_enterprise_sales %}.{% endif %} If you're uncertain if the issue is out of scope, open a ticket and we're happy to help you determine the best way to proceed. diff --git a/data/reusables/support/submit-a-ticket.md b/data/reusables/support/submit-a-ticket.md index 3fec8509d8..87248d3817 100644 --- a/data/reusables/support/submit-a-ticket.md +++ b/data/reusables/support/submit-a-ticket.md @@ -11,8 +11,8 @@ {% note %} **Notes:** - - For Premium, Premium Plus, or Engineering Direct support, you need to choose an enterprise account with a {% data variables.contact.premium_support %} plan. If you don't see an Enterprises section in the dropdown menu, you're not entitled to open support tickets on behalf of an enterprise account. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-github-support#about-support-entitlement)" - - To see a list of your enterprise accounts with a {% data variables.contact.premium_support %} plan, you must be signed into the {% data variables.contact.enterprise_portal %}. For more information, see "[AUTOTITLE](/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal)." + * For Premium, Premium Plus, or Engineering Direct support, you need to choose an enterprise account with a {% data variables.contact.premium_support %} plan. If you don't see an Enterprises section in the dropdown menu, you're not entitled to open support tickets on behalf of an enterprise account. For more information, see "[AUTOTITLE](/support/learning-about-github-support/about-github-support#about-support-entitlement)" + * To see a list of your enterprise accounts with a {% data variables.contact.premium_support %} plan, you must be signed into the {% data variables.contact.enterprise_portal %}. For more information, see "[AUTOTITLE](/support/contacting-github-support/getting-your-enterprise-started-with-the-github-support-portal)." {% endnote %} {% endif %} @@ -60,9 +60,9 @@ 1. Under "How can we help", provide any additional information that will help the Support team troubleshoot the problem. You can use markdown to format your message. Helpful information may include: - - Steps to reproduce the issue - - Any special circumstances surrounding the discovery of the issue (for example, the first occurrence or occurrence after a specific event, frequency of occurrence, business impact of the problem, and suggested urgency) - - Exact wording of error messages + * Steps to reproduce the issue + * Any special circumstances surrounding the discovery of the issue (for example, the first occurrence or occurrence after a specific event, frequency of occurrence, business impact of the problem, and suggested urgency) + * Exact wording of error messages You can attach files up to 50MB.{% ifversion ghes %} For larger attachments, such as support bundles, see "[AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)."{% endif %} diff --git a/data/reusables/support/support-portal-notes.md b/data/reusables/support/support-portal-notes.md index eb802eeb72..afa27b265e 100644 --- a/data/reusables/support/support-portal-notes.md +++ b/data/reusables/support/support-portal-notes.md @@ -2,7 +2,7 @@ **Notes:** -- Urgent priority and {% data variables.contact.premium_support %} SLAs only apply to tickets associated with your enterprise account. -- Tickets associated with an enterprise account can only be opened by owners, billing managers, and support-entitled members. +* Urgent priority and {% data variables.contact.premium_support %} SLAs only apply to tickets associated with your enterprise account. +* Tickets associated with an enterprise account can only be opened by owners, billing managers, and support-entitled members. {% endnote %} diff --git a/data/reusables/two_fa/enable-sms-number-method.md b/data/reusables/two_fa/enable-sms-number-method.md index 344fc7365e..453af2b88e 100644 --- a/data/reusables/two_fa/enable-sms-number-method.md +++ b/data/reusables/two_fa/enable-sms-number-method.md @@ -2,4 +2,4 @@ 1. Under "Verify account", select your country code and type your mobile phone number, including the area code. When your information is correct, click **Send authentication code**. 1. You'll receive a text message with a security code. On {% data variables.product.product_name %}, type the code into the field under "Verify the code sent to your phone" and click **Continue**. - - If you need to edit the phone number you entered, you'll need to complete another CAPTCHA challenge. + * If you need to edit the phone number you entered, you'll need to complete another CAPTCHA challenge. diff --git a/data/reusables/two_fa/enable-totp-app-method.md b/data/reusables/two_fa/enable-totp-app-method.md index 2112fea3e1..297f6aa103 100644 --- a/data/reusables/two_fa/enable-totp-app-method.md +++ b/data/reusables/two_fa/enable-totp-app-method.md @@ -1,7 +1,7 @@ 1. Under "Scan the QR code", do one of the following: - - Scan the QR code with your mobile device's app. After scanning, the app displays a six-digit code that you can enter on {% data variables.product.product_name %}. - - If you can't scan the QR code, click **setup key** to see a code, the TOTP secret, that you can manually enter in your TOTP app instead. + * Scan the QR code with your mobile device's app. After scanning, the app displays a six-digit code that you can enter on {% data variables.product.product_name %}. + * If you can't scan the QR code, click **setup key** to see a code, the TOTP secret, that you can manually enter in your TOTP app instead. ![Screenshot of the "Setup authenticator app" section of the 2FA settings. A link, labeled "setup key", is highlighted in orange.](/assets/images/help/2fa/ghes-3.8-and-higher-2fa-wizard-app-click-code.png) diff --git a/data/reusables/two_fa/manual-totp-app-setup.md b/data/reusables/two_fa/manual-totp-app-setup.md index 169578adcc..c0ef429d92 100644 --- a/data/reusables/two_fa/manual-totp-app-setup.md +++ b/data/reusables/two_fa/manual-totp-app-setup.md @@ -1,9 +1,9 @@ If you are unable to scan the setup QR code or wish to setup a TOTP app manually and require the parameters encoded in the QR code, they are: -- Type: `TOTP` -- Label: `GitHub:` where `` is your handle on {% data variables.product.prodname_dotcom %}, for example `monalisa` -- Secret: This is the encoded setup key, shown if you click "Setup key" during configuration -- Issuer: `GitHub` -- Algorithm: The default of SHA1 is used -- Digits: The default of 6 is used -- Period: The default of 30 (seconds) is used +* Type: `TOTP` +* Label: `GitHub:` where `` is your handle on {% data variables.product.prodname_dotcom %}, for example `monalisa` +* Secret: This is the encoded setup key, shown if you click "Setup key" during configuration +* Issuer: `GitHub` +* Algorithm: The default of SHA1 is used +* Digits: The default of 6 is used +* Period: The default of 30 (seconds) is used diff --git a/data/reusables/user-settings/patv2-filters.md b/data/reusables/user-settings/patv2-filters.md index d0fd8190c6..fca6c70077 100644 --- a/data/reusables/user-settings/patv2-filters.md +++ b/data/reusables/user-settings/patv2-filters.md @@ -1,4 +1,4 @@ 1. Optionally, use filters to only display certain tokens. - - Use the **Owner** dropdown to filter the tokens by the member who created the token. - - Use the **Repository** dropdown to filter the tokens by repository access. - - Use the **Permissions** dropdown to filter the tokens by permission. + * Use the **Owner** dropdown to filter the tokens by the member who created the token. + * Use the **Repository** dropdown to filter the tokens by repository access. + * Use the **Permissions** dropdown to filter the tokens by permission. diff --git a/data/reusables/user-settings/patv2-limitations.md b/data/reusables/user-settings/patv2-limitations.md index be4e4c1c4e..23dc88b02d 100644 --- a/data/reusables/user-settings/patv2-limitations.md +++ b/data/reusables/user-settings/patv2-limitations.md @@ -1,7 +1,7 @@ {% data variables.product.pat_v1_caps_plural %} are less secure. However, some features currently will only work with {% data variables.product.pat_v1_plural %}: -- Only {% data variables.product.pat_v1_plural %} have write access for public repositories that are not owned by you or an organization that you are not a member of.{% ifversion ghec or ghes %} -- Only {% data variables.product.pat_v1_plural %} automatically have write access for internal repositories that are owned by your enterprise. {% data variables.product.pat_v2_caps %}s must be granted access to internal repositories.{% endif %} -- Outside collaborators can only use {% data variables.product.pat_v1_plural %} to access organization repositories that they are a collaborator on.{% ifversion ghec or ghes %} -- Only {% data variables.product.pat_v1_plural %} can access enterprises. ({% data variables.product.pat_v2_caps %} can access organizations owned by enterprises.){% endif %} -- A few REST API endpoints are only available with a {% data variables.product.pat_v1_plural %}. To check whether an endpoint also supports {% data variables.product.pat_v2 %}s, see the documentation for that endpoint, or see "[AUTOTITLE](/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens)". +* Only {% data variables.product.pat_v1_plural %} have write access for public repositories that are not owned by you or an organization that you are not a member of.{% ifversion ghec or ghes %} +* Only {% data variables.product.pat_v1_plural %} automatically have write access for internal repositories that are owned by your enterprise. {% data variables.product.pat_v2_caps %}s must be granted access to internal repositories.{% endif %} +* Outside collaborators can only use {% data variables.product.pat_v1_plural %} to access organization repositories that they are a collaborator on.{% ifversion ghec or ghes %} +* Only {% data variables.product.pat_v1_plural %} can access enterprises. ({% data variables.product.pat_v2_caps %} can access organizations owned by enterprises.){% endif %} +* A few REST API endpoints are only available with a {% data variables.product.pat_v1_plural %}. To check whether an endpoint also supports {% data variables.product.pat_v2 %}s, see the documentation for that endpoint, or see "[AUTOTITLE](/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens)". diff --git a/data/reusables/webhooks/content_type.md b/data/reusables/webhooks/content_type.md index e0d5bc80b6..2d2dfddd58 100644 --- a/data/reusables/webhooks/content_type.md +++ b/data/reusables/webhooks/content_type.md @@ -1,7 +1,7 @@ Webhooks can be delivered using different content types: -- The `application/json` content type will deliver the JSON payload directly as the body of the `POST` request. -- The `application/x-www-form-urlencoded` content type will send the JSON payload as a form parameter +* The `application/json` content type will deliver the JSON payload directly as the body of the `POST` request. +* The `application/x-www-form-urlencoded` content type will send the JSON payload as a form parameter called `payload`. Choose the one that best fits your needs. diff --git a/data/reusables/webhooks/content_type_and_secret.md b/data/reusables/webhooks/content_type_and_secret.md index 9df0036c56..44d3004ec4 100644 --- a/data/reusables/webhooks/content_type_and_secret.md +++ b/data/reusables/webhooks/content_type_and_secret.md @@ -1,4 +1,4 @@ 1. Optionally, select the **Content type** drop-down menu, and click a data format to receive the webhook payload in. - - **application/json** will deliver the JSON payload directly as the body of the `POST` request. - - **application/x-www-form-urlencoded** will send the JSON payload as a form parameter called `payload`. + * **application/json** will deliver the JSON payload directly as the body of the `POST` request. + * **application/x-www-form-urlencoded** will send the JSON payload as a form parameter called `payload`. 1. Optionally, under "Secret", type a string to use as a `secret` key. You should choose a random string of text with high entropy. You can use the webhook secret to limit incoming requests to only those originating from {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/securing-your-webhooks)." diff --git a/data/reusables/webhooks/signature-troubleshooting.md b/data/reusables/webhooks/signature-troubleshooting.md index 95b9ffd099..6cc4dbbbd7 100644 --- a/data/reusables/webhooks/signature-troubleshooting.md +++ b/data/reusables/webhooks/signature-troubleshooting.md @@ -1,8 +1,8 @@ If you are sure that the payload is from {% data variables.product.company_short %} but the signature verification fails: -- Make sure that you have configured a secret for your webhook. The `X-Hub-Signature-256` header will not be present if you have not configured a secret for your webhook. For more information about configuring a secret for your webhook, see "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks)." -- Make sure you are using the correct header. {% data variables.product.company_short %} recommends that you use the `X-Hub-Signature-256` header, which uses the HMAC-SHA256 algorithm. The `X-Hub-Signature` header uses the HMAC-SHA1 algorithm and is only included for legacy purposes. -- Make sure that you are using the correct algorithm. If you are using the `X-Hub-Signature-256` header, you should use the HMAC-SHA256 algorithm. -- Make sure you are using the correct webhook secret. If you don't know the value of your webhook secret, you can update your webhook's secret. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks)." -- Make sure that the payload and headers are not modified before verification. For example, if you use a proxy or load balancer, make sure that the proxy or load balancer does not modify the payload or headers. -- If your language and server implementation specifies a character encoding, ensure that you handle the payload as UTF-8. Webhook payloads can contain unicode characters. +* Make sure that you have configured a secret for your webhook. The `X-Hub-Signature-256` header will not be present if you have not configured a secret for your webhook. For more information about configuring a secret for your webhook, see "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks)." +* Make sure you are using the correct header. {% data variables.product.company_short %} recommends that you use the `X-Hub-Signature-256` header, which uses the HMAC-SHA256 algorithm. The `X-Hub-Signature` header uses the HMAC-SHA1 algorithm and is only included for legacy purposes. +* Make sure that you are using the correct algorithm. If you are using the `X-Hub-Signature-256` header, you should use the HMAC-SHA256 algorithm. +* Make sure you are using the correct webhook secret. If you don't know the value of your webhook secret, you can update your webhook's secret. For more information, see "[AUTOTITLE](/webhooks/using-webhooks/editing-webhooks)." +* Make sure that the payload and headers are not modified before verification. For example, if you use a proxy or load balancer, make sure that the proxy or load balancer does not modify the payload or headers. +* If your language and server implementation specifies a character encoding, ensure that you handle the payload as UTF-8. Webhook payloads can contain unicode characters. diff --git a/data/reusables/webhooks/webhooks-rest-api-links.md b/data/reusables/webhooks/webhooks-rest-api-links.md index 84cf95f383..c093b43986 100644 --- a/data/reusables/webhooks/webhooks-rest-api-links.md +++ b/data/reusables/webhooks/webhooks-rest-api-links.md @@ -1,5 +1,5 @@ You can use the REST API to manage repository, organization, and app webhooks. You can list webhook deliveries for a webhook, or get and redeliver an individual delivery for a webhook, which can be integrated into an external app or service. You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret. For more information, see: -- [Repository Webhooks](/rest/webhooks#repository-webhooks) -- [Organization Webhooks](/rest/orgs/webhooks) -- [{% data variables.product.prodname_github_app %} Webhooks](/rest/apps/webhooks) +* [Repository Webhooks](/rest/webhooks#repository-webhooks) +* [Organization Webhooks](/rest/orgs/webhooks) +* [{% data variables.product.prodname_github_app %} Webhooks](/rest/apps/webhooks)