1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Fix inconsistent alerts by using the markdown notation - part 4 (#35223)

Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com>
This commit is contained in:
Artur Kordowski
2024-11-12 23:42:57 +01:00
committed by GitHub
parent b7bbf37088
commit 9bb1b989ee
286 changed files with 754 additions and 1615 deletions

View File

@@ -2,7 +2,7 @@
This repo has configuration for debugging the codebase with VS Code's built-in Node Debugger. This repo has configuration for debugging the codebase with VS Code's built-in Node Debugger.
**Note**: These steps will only help with debugging issues in the Node.js codebase, not in the content files. **Note:** These steps will only help with debugging issues in the Node.js codebase, not in the content files.
1. After running the build steps, start the app by running `npm run debug`. 1. After running the build steps, start the app by running `npm run debug`.
1. In VS Code, click on the Debugging icon in the Activity Bar to bring up the Debug view. 1. In VS Code, click on the Debugging icon in the Activity Bar to bring up the Debug view.

View File

@@ -2,14 +2,9 @@ This means that there can be at most one running and one pending job in a concur
To also cancel any currently running job or workflow in the same concurrency group, specify `cancel-in-progress: true`. To conditionally cancel currently running jobs or workflows in the same concurrency group, you can specify `cancel-in-progress` as an expression with any of the allowed expression contexts. To also cancel any currently running job or workflow in the same concurrency group, specify `cancel-in-progress: true`. To conditionally cancel currently running jobs or workflows in the same concurrency group, you can specify `cancel-in-progress` as an expression with any of the allowed expression contexts.
{% note %} > [!NOTE]
> * The concurrency group name is case insensitive. For example, `prod` and `Prod` will be treated as the same concurrency group.
**Notes:** > * 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 %}
### Example: Using concurrency and the default behavior ### Example: Using concurrency and the default behavior

View File

@@ -2,8 +2,5 @@
* Docker is [installed](https://docs.docker.com/get-docker/) and running. * Docker is [installed](https://docs.docker.com/get-docker/) and running.
* [{% data variables.product.prodname_dotcom %} CLI](https://cli.github.com) is installed. * [{% data variables.product.prodname_dotcom %} CLI](https://cli.github.com) is installed.
{% note %} > [!NOTE]
> The {% data variables.product.prodname_actions_importer %} container and CLI do not need to be installed on the same server as your CI platform.
**Note**: The {% data variables.product.prodname_actions_importer %} container and CLI do not need to be installed on the same server as your CI platform.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> To enhance security, {% data variables.product.prodname_actions %} does not support redirects for actions or reusable workflows. This means that when the owner, name of an action's repository, or name of an action is changed, any workflows using that action with the previous name will fail.
**Note:** To enhance security, {% data variables.product.prodname_actions %} does not support redirects for actions or reusable workflows. This means that when the owner, name of an action's repository, or name of an action is changed, any workflows using that action with the previous name will fail.
{% endnote %}

View File

@@ -1,7 +1,4 @@
{% warning %} > [!WARNING]
> This {% data variables.product.prodname_actions_runner_controller %} customization option may be outside the scope of what {% data variables.contact.github_support %} can assist with and may cause unexpected behavior when configured incorrectly.
**Warning:** This {% data variables.product.prodname_actions_runner_controller %} customization option may be outside the scope of what {% data variables.contact.github_support %} can assist with and may cause unexpected behavior when configured incorrectly. >
> For more information about what {% data variables.contact.github_support %} can assist with, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-support-for-actions-runner-controller).
For more information about what {% data variables.contact.github_support %} can assist with, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/about-support-for-actions-runner-controller).
{% endwarning %}

View File

@@ -1,10 +1,9 @@
{% ifversion fpt %} {% ifversion fpt %}
{% note %}
**Note:** Organization-level secrets and variables are not accessible by private repositories for {% data variables.product.prodname_free_user %}. For more information about upgrading your {% data variables.product.company_short %} subscription, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)". > [!NOTE]
> Organization-level secrets and variables are not accessible by private repositories for {% data variables.product.prodname_free_user %}. For more information about upgrading your {% data variables.product.company_short %} subscription, see "[AUTOTITLE](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)".
{% endnote %}
{% endif %} {% endif %}
When creating a secret or variable in an organization, you can use a policy to limit access by repository. For example, you can grant access to all repositories, or limit access to only private repositories or a specified list of repositories. When creating a secret or variable in an organization, you can use a policy to limit access by repository. For example, you can grant access to all repositories, or limit access to only private repositories or a specified list of repositories.

View File

@@ -1,13 +1,7 @@
{% note %} > [!NOTE]
> Enterprise and organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %} can create runners from this page. To create a new runner, click **New runner** at the top right of the list of runners to add runners to the repository.
**Note:** Enterprise and organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %} can create runners from this page. To create a new runner, click **New runner** at the top right of the list of runners to add runners to the repository. >
> For more information, see {% ifversion actions-hosted-runners %}"[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners)" and {% endif %}"[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."
For more information, see {% ifversion actions-hosted-runners %}"[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners)" and {% endif %}"[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners)."
{% ifversion custom-org-roles %} {% ifversion custom-org-roles %}
>For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
{% endif %} {% endif %}
{% endnote %}

View File

@@ -21,11 +21,10 @@ When you choose {% data reusables.actions.policy-label-for-select-actions-workfl
You can use the `*` wildcard character to match patterns. For example, to allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in organizations that start with `space-org`, you can specify `space-org*/*`. To allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in repositories that start with octocat, you can use `*/octocat**@*`. For more information about using the `*` wildcard, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." You can use the `*` wildcard character to match patterns. For example, to allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in organizations that start with `space-org`, you can specify `space-org*/*`. To allow all actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} in repositories that start with octocat, you can use `*/octocat**@*`. For more information about using the `*` wildcard, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)."
{% ifversion fpt or ghec %} {% ifversion fpt or ghec %}
{% note %}
**Note:** For {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, or {% data variables.product.prodname_team %} plans, the **Allow specified actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}** option is only available in public repositories. > [!NOTE]
> For {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, or {% data variables.product.prodname_team %} plans, the **Allow specified actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %}** option is only available in public repositories.
{% endnote %}
{% endif %} {% endif %}
This procedure demonstrates how to add specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to the allow list. This procedure demonstrates how to add specific actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} to the allow list.

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Create the secret in the same namespace where the `gha-runner-scale-set` chart is installed. In this example, the namespace is `arc-runners` to match the quickstart documentation. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller#configuring-a-runner-scale-set)."
**Note:** Create the secret in the same namespace where the `gha-runner-scale-set` chart is installed. In this example, the namespace is `arc-runners` to match the quickstart documentation. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/quickstart-for-actions-runner-controller#configuring-a-runner-scale-set)."
{% endnote %}

View File

@@ -4,16 +4,11 @@ Use the following script to set up a subnet for Azure private networking. The sc
To use the script, fill in the placeholder environment variable values with the actual values and run the script from a bash shell or Windows Subsystem for Linux. To use the script, fill in the placeholder environment variable values with the actual values and run the script from a bash shell or Windows Subsystem for Linux.
{% note %} > [!NOTE]
> * Run the following script in the same directory where you saved the `actions-nsg-deployment.bicep` file.
**Notes**: > * When setting the `YOUR_AZURE_LOCATION` environment variable, use your regions name. This value is different than your regions 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.
* Run the following script in the same directory where you saved the `actions-nsg-deployment.bicep` file. > * 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.
* When setting the `YOUR_AZURE_LOCATION` environment variable, use your regions name. This value is different than your regions 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 %}
```bash copy ```bash copy
#!/bin/bash #!/bin/bash

View File

@@ -14,11 +14,8 @@ You will use a script to automate configuring your Azure resources.
If you use {% data variables.enterprise.data_residency %}, in the `AllowOutBoundGitHub` section, you must also include the egress IP ranges for {% data variables.enterprise.data_residency_site %}. See "[AUTOTITLE](/admin/data-residency/network-details-for-ghecom#ranges-for-egress-traffic)." If you use {% data variables.enterprise.data_residency %}, in the `AllowOutBoundGitHub` section, you must also include the egress IP ranges for {% data variables.enterprise.data_residency_site %}. See "[AUTOTITLE](/admin/data-residency/network-details-for-ghecom#ranges-for-egress-traffic)."
{% note %} > [!NOTE]
> As an alternative to using the following file, to allow {% data variables.product.prodname_actions %} to communicate with the runners, you can allow the same firewall domains that are required for communication between self-hosted runners and {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud)." To determine the appropriate subnet IP address range, we recommend adding a 30% buffer to the maximum job concurrency you anticipate. For instance, if your network configuration's runners are set to a maximum job concurrency of 300, it's recommended to utilize a subnet IP address range that can accommodate at least 390 runners. This buffer helps ensure that your network can handle unexpected increases in VM needs to meet job concurrency without running out of IP addresses.
**Note:** As an alternative to using the following file, to allow {% data variables.product.prodname_actions %} to communicate with the runners, you can allow the same firewall domains that are required for communication between self-hosted runners and {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud)." To determine the appropriate subnet IP address range, we recommend adding a 30% buffer to the maximum job concurrency you anticipate. For instance, if your network configuration's runners are set to a maximum job concurrency of 300, it's recommended to utilize a subnet IP address range that can accommodate at least 390 runners. This buffer helps ensure that your network can handle unexpected increases in VM needs to meet job concurrency without running out of IP addresses.
{% endnote %}
```bicep copy ```bicep copy
@description('NSG for outbound rules') @description('NSG for outbound rules')

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Name patterns must be configured for branches or tags individually.
**Note:** Name patterns must be configured for branches or tags individually.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> This event will only trigger a workflow run if the workflow file is on the default branch.
**Note:** This event will only trigger a workflow run if the workflow file is on the default branch.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Configuration variables for {% data variables.product.prodname_actions %} are in {% data variables.release-phases.public_preview %} and subject to change.
**Note:** Configuration variables for {% data variables.product.prodname_actions %} are in {% data variables.release-phases.public_preview %} and subject to change.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> This context is an example only. The contents of a context depends on the workflow that you are running. {% data reusables.actions.context-contents %}
**Note:** This context is an example only. The contents of a context depends on the workflow that you are running. {% data reusables.actions.context-contents %}
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% warning %} > [!WARNING]
> When creating workflows and actions, you should always consider whether your code might execute untrusted input from possible attackers. Certain contexts should be treated as untrusted input, as an attacker could insert their own malicious content. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#understanding-the-risk-of-script-injections)."
**Warning:** When creating workflows and actions, you should always consider whether your code might execute untrusted input from possible attackers. Certain contexts should be treated as untrusted input, as an attacker could insert their own malicious content. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#understanding-the-risk-of-script-injections)."
{% endwarning %}

View File

@@ -7,11 +7,8 @@ Always include a security admonition above this procedure. This is either one of
{% endcomment %} {% endcomment %}
{% note %} > [!NOTE]
> When creating a runner group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. To change which repositories and workflows can access the runner group, organization owners{% ifversion custom-org-roles %} and users with the “Manage organization runners and runner groups” permission{% endif %} can set a policy for the organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners)."
**Note:** When creating a runner group, you must choose a policy that defines which repositories{% ifversion restrict-groups-to-workflows %} and workflows{% endif %} have access to the runner group. To change which repositories and workflows can access the runner group, organization owners{% ifversion custom-org-roles %} and users with the “Manage organization runners and runner groups” permission{% endif %} can set a policy for the organization. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#disabling-repository-level-self-hosted-runners)."
{% endnote %}
All organizations have a single default runner group. {% ifversion fpt %}Organization owners using the {% data variables.product.prodname_team %} plan{% else %}Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %}{% endif %} can create additional organization-level runner groups. {% ifversion custom-org-roles %}For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."{% endif %} All organizations have a single default runner group. {% ifversion fpt %}Organization owners using the {% data variables.product.prodname_team %} plan{% else %}Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %}{% endif %} can create additional organization-level runner groups. {% ifversion custom-org-roles %}For more information about custom organization roles, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."{% endif %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Custom deployment protection rules are currently in {% data variables.release-phases.public_preview %} and subject to change.
**Note:** Custom deployment protection rules are currently in {% data variables.release-phases.public_preview %} and subject to change.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Any number of {% data variables.product.prodname_github_apps %}-based deployment protection rules can be installed on a repository. However, a maximum of 6 deployment protection rules can be enabled on any environment at the same time.
**Note:** Any number of {% data variables.product.prodname_github_apps %}-based deployment protection rules can be installed on a repository. However, a maximum of 6 deployment protection rules can be enabled on any environment at the same time.
{% endnote %}

View File

@@ -1,8 +1,5 @@
{% note %} > [!NOTE]
> If your workflows use Docker container actions, job containers, or service containers, then you must use a Linux runner:
**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 {% 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 self-hosted runners, you must use a Linux machine as your runner and Docker must be installed.
{% endnote %}

View File

@@ -1,9 +1,7 @@
* 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)." * Review the hardware requirements for {% data variables.product.prodname_actions %}. For more information, see "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)."
* TLS must be configured for {% data variables.product.prodname_ghe_server %}'s domain. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls)." * TLS must be configured for {% data variables.product.prodname_ghe_server %}'s domain. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-tls)."
{% note %} > [!NOTE]
> {% data reusables.actions.enterprise-self-signed-cert %}
**Note:** {% data reusables.actions.enterprise-self-signed-cert %}
{% endnote %}
* {% data reusables.actions.enterprise-http-proxy %} * {% data reusables.actions.enterprise-http-proxy %}

View File

@@ -1,7 +1,6 @@
{% ifversion ghes %} {% ifversion ghes %}
{% note %}
**Note:** {% data variables.product.prodname_dotcom %}-hosted runners are not currently supported on {% data variables.product.prodname_ghe_server %}. You can see more information about planned future support on the [{% data variables.product.prodname_roadmap %}](https://github.com/github/roadmap/issues/72). > [!NOTE]
> {% data variables.product.prodname_dotcom %}-hosted runners are not currently supported on {% data variables.product.prodname_ghe_server %}. You can see more information about planned future support on the [{% data variables.product.prodname_roadmap %}](https://github.com/github/roadmap/issues/72).
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,9 +1,6 @@
{% ifversion ghes %} {% ifversion ghes %}
{% note %} > [!NOTE]
> {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} may have limited access to actions on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom)" and contact your {% data variables.product.prodname_enterprise %} site administrator.
**Note:** {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} may have limited access to actions on {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_marketplace %}. For more information, see "[AUTOTITLE](/admin/github-actions/managing-access-to-actions-from-githubcom)" and contact your {% data variables.product.prodname_enterprise %} site administrator.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> To avoid issues, it's good practice to treat environment variables as case sensitive, irrespective of the behavior of the operating system and shell you are using.
**Note**: To avoid issues, it's good practice to treat environment variables as case sensitive, irrespective of the behavior of the operating system and shell you are using.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% warning %} > [!WARNING]
> When using the whole `github` context, be mindful that it includes sensitive information such as `github.token`. {% data variables.product.prodname_dotcom %} masks secrets when they are printed to the console, but you should be cautious when exporting or printing the context.
**Warning:** When using the whole `github` context, be mindful that it includes sensitive information such as `github.token`. {% data variables.product.prodname_dotcom %} masks secrets when they are printed to the console, but you should be cautious when exporting or printing the context.
{% endwarning %}

View File

@@ -1,5 +1,2 @@
{% warning %} > [!WARNING]
> {% data reusables.actions.hosted-runner-security %}
**Warning**: {% data reusables.actions.hosted-runner-security %}
{% endwarning %}

View File

@@ -1,12 +1,8 @@
{% ifversion actions-unified-inputs %} {% ifversion actions-unified-inputs %}
{% note %} > [!NOTE]
> * 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.
**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.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Ensure that you only commit valid workflow files to your repository. If `.github/workflows` contains an invalid workflow file, {% data variables.product.prodname_actions %} generates a failed workflow run for every new commit.
**Note:** Ensure that you only commit valid workflow files to your repository. If `.github/workflows` contains an invalid workflow file, {% data variables.product.prodname_actions %} generates a failed workflow run for every new commit.
{% endnote %}

View File

@@ -1,7 +1,4 @@
{% warning %} > [!WARNING]
> If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners{% ifversion actions-hosted-runners %} or {% data variables.product.prodname_dotcom %}-hosted larger runners with static IP address ranges{% endif %}. When using [Azure private networking](/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise), IPs from your Azure subnet must be used. To reduce the number of required IPs, we recommend creating a load balancer to provide a single IP range for the GitHub allow list. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" {% ifversion actions-hosted-runners %} or "[AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners)"{% endif %}.
**Warning**: If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners{% ifversion actions-hosted-runners %} or {% data variables.product.prodname_dotcom %}-hosted larger runners with static IP address ranges{% endif %}. When using [Azure private networking](/admin/configuration/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise), IPs from your Azure subnet must be used. To reduce the number of required IPs, we recommend creating a load balancer to provide a single IP range for the GitHub allow list. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" {% ifversion actions-hosted-runners %} or "[AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners)"{% endif %}.
{% endwarning %}
To allow your self-hosted {% ifversion actions-hosted-runners %}or larger hosted{% endif %} runners to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your runners to the IP allow list that you have configured for your enterprise. To allow your self-hosted {% ifversion actions-hosted-runners %}or larger hosted{% endif %} runners to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your runners to the IP allow list that you have configured for your enterprise.

View File

@@ -12,17 +12,11 @@ For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/abou
In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.product.prodname_dotcom %} offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of managed virtual machines with advanced features - for example, more cores and disk space, GPU-powered machines, and ARM-powered machines. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners)." In addition to the standard {% data variables.product.prodname_dotcom %}-hosted runners, {% data variables.product.prodname_dotcom %} offers customers on {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %} plans a range of managed virtual machines with advanced features - for example, more cores and disk space, GPU-powered machines, and ARM-powered machines. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners)."
{% note %} > [!NOTE]
> The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor.
**Note:** The `-latest` runner images are the latest stable images that {% data variables.product.prodname_dotcom %} provides, and might not be the most recent version of the operating system available from the operating system vendor. > [!WARNING]
> Beta and Deprecated Images are provided "as-is", "with all faults" and "as available" and are excluded from the service level agreement and warranty. Beta Images may not be covered by customer support.
{% endnote %}
{% warning %}
**Warning:** Beta and Deprecated Images are provided "as-is", "with all faults" and "as available" and are excluded from the service level agreement and warranty. Beta Images may not be covered by customer support.
{% endwarning %}
#### Example: Specifying an operating system #### Example: Specifying an operating system

View File

@@ -42,8 +42,5 @@ Use `jobs.<job_id>.runs-on` to define the type of machine to run the job on.
* If you would like to run your workflow on multiple machines, use [`jobs.<job_id>.strategy`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategy). * If you would like to run your workflow on multiple machines, use [`jobs.<job_id>.strategy`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategy).
{% note %} > [!NOTE]
> Quotation marks are not required around simple strings like `self-hosted`, but they are required for expressions like {% raw %} `"${{ inputs.chosen-os }}"`{% endraw %}.
**Note:** Quotation marks are not required around simple strings like `self-hosted`, but they are required for expressions like {% raw %} `"${{ inputs.chosen-os }}"`{% endraw %}.
{% endnote %}

View File

@@ -15,8 +15,5 @@ strategy:
runs-on: {% raw %}${{ matrix.os }}{% endraw %} runs-on: {% raw %}${{ matrix.os }}{% endraw %}
``` ```
{% note %} > [!NOTE]
> All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded.
**Note:** All `include` combinations are processed after `exclude`. This allows you to use `include` to add back combinations that were previously excluded.
{% endnote %}

View File

@@ -1,7 +1,4 @@
Use `jobs.<job_id>.container.options` to configure additional Docker container resource options. For a list of options, see "[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)." Use `jobs.<job_id>.container.options` to configure additional Docker container resource options. For a list of options, see "[`docker create` options](https://docs.docker.com/engine/reference/commandline/create/#options)."
{% warning %} > [!WARNING]
> The `--network` and `--entrypoint` options are not supported.
**Warning:** The `--network` and `--entrypoint` options are not supported.
{% endwarning %}

View File

@@ -2,11 +2,8 @@ Use `jobs.<job_id>.container` to create a container to run any steps in a job th
If you do not set a `container`, all steps will run directly on the host specified by `runs-on` unless a step refers to an action configured to run in a container. If you do not set a `container`, all steps will run directly on the host specified by `runs-on` unless a step refers to an action configured to run in a container.
{% note %} > [!NOTE]
> The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs.<job_id>.defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun) or [`jobs.<job_id>.steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell).
**Note:** The default shell for `run` steps inside a container is `sh` instead of `bash`. This can be overridden with [`jobs.<job_id>.defaults.run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iddefaultsrun) or [`jobs.<job_id>.steps[*].shell`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsshell).
{% endnote %}
### Example: Running a job within a container ### Example: Running a job within a container

View File

@@ -1,10 +1,7 @@
You can use the `jobs.<job_id>.if` conditional to prevent a job from running unless a condition is met. {% data reusables.actions.if-supported-contexts %} You can use the `jobs.<job_id>.if` conditional to prevent a job from running unless a condition is met. {% data reusables.actions.if-supported-contexts %}
{% note %} > [!NOTE]
> The `jobs.<job_id>.if` condition is evaluated before [`jobs.<job_id>.strategy.matrix`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) is applied.
**Note:** The `jobs.<job_id>.if` condition is evaluated before [`jobs.<job_id>.strategy.matrix`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) is applied.
{% endnote %}
{% data reusables.actions.expression-syntax-if %} For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions)." {% data reusables.actions.expression-syntax-if %} For more information, see "[AUTOTITLE](/actions/learn-github-actions/expressions)."

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Support for custom claims for OIDC is unavailable in AWS.
**Note:** Support for custom claims for OIDC is unavailable in AWS.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> When environments are used in workflows or in OIDC policies, we recommend adding protection rules to the environment for additional security. For example, you can configure deployment rules on an environment to restrict which branches and tags can deploy to the environment or access environment secrets. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-protection-rules)."
**Note**: When environments are used in workflows or in OIDC policies, we recommend adding protection rules to the environment for additional security. For example, you can configure deployment rules on an environment to restrict which branches and tags can deploy to the environment or access environment secrets. For more information, see "[AUTOTITLE](/actions/deployment/targeting-different-environments/managing-environments-for-deployment#deployment-protection-rules)."
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% warning %} > [!WARNING]
> For workflows that are triggered by the `pull_request_target` event, the `GITHUB_TOKEN` is granted read/write repository permission unless the `permissions` key is specified and the workflow can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the GitHub Security Lab website.
**Warning:** For workflows that are triggered by the `pull_request_target` event, the `GITHUB_TOKEN` is granted read/write repository permission unless the `permissions` key is specified and the workflow can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch. To help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the GitHub Security Lab website.
{% endwarning %}

View File

@@ -1,9 +1,6 @@
Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. You can use runner groups or labels to define where your jobs run. Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. You can use runner groups or labels to define where your jobs run.
{% note %} > [!NOTE]
> {% data variables.actions.hosted_runner_caps %}s are automatically assigned a default label that corresponds to the runner name. You cannot add custom labels to {% data variables.actions.hosted_runner %}s, but you can use the default labels or the runner's group to send jobs to specific types of runners.
**Note:** {% data variables.actions.hosted_runner_caps %}s are automatically assigned a default label that corresponds to the runner name. You cannot add custom labels to {% data variables.actions.hosted_runner %}s, but you can use the default labels or the runner's group to send jobs to specific types of runners.
{% endnote %}
Only owner or administrator accounts can see the runner settings. Non-administrative users can contact the organization owner to find out which runners are enabled. Your organization owner can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-a-runner-group)." Only owner or administrator accounts can see the runner settings. Non-administrative users can contact the organization owner to find out which runners are enabled. Your organization owner can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. For more information, see "[AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners#allowing-repositories-to-access-a-runner-group)."

View File

@@ -1,9 +1,6 @@
{% ifversion custom-org-roles %} {% ifversion custom-org-roles %}
{% note %} > [!NOTE]
> The "Actions secrets and variables" page may not show distinct tabs for secrets and variables depending on your permissions. Organization owners and users with both the "Manage organization Actions variables" and "Manage organization Actions secrets" permissions will see the **Variables** and **Secrets** tabs. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
**Note:** The "Actions secrets and variables" page may not show distinct tabs for secrets and variables depending on your permissions. Organization owners and users with both the "Manage organization Actions variables" and "Manage organization Actions secrets" permissions will see the **Variables** and **Secrets** tabs. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)."
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,5 +1,2 @@
{% warning %} > [!WARNING]
> If a secret was used in the job, {% data variables.product.prodname_dotcom %} automatically redacts secrets printed to the log. You should avoid printing secrets to the log intentionally.
**Warning:** If a secret was used in the job, {% data variables.product.prodname_dotcom %} automatically redacts secrets printed to the log. You should avoid printing secrets to the log intentionally.
{% endwarning %}

View File

@@ -6,11 +6,8 @@
Open a shell on your self-hosted runner machine and run each shell command in the order shown. Open a shell on your self-hosted runner machine and run each shell command in the order shown.
{% note %} > [!NOTE]
> On Windows, if you want to install the self-hosted runner application as a service, you must open a shell with administrator privileges. We also recommend that you use `C:\actions-runner` as the directory for the self-hosted runner application so that Windows system accounts can access the runner directory.
**Note:** On Windows, if you want to install the self-hosted runner application as a service, you must open a shell with administrator privileges. We also recommend that you use `C:\actions-runner` as the directory for the self-hosted runner application so that Windows system accounts can access the runner directory.
{% endnote %}
The instructions walk you through completing these tasks: The instructions walk you through completing these tasks:
* Downloading and extracting the self-hosted runner application. * Downloading and extracting the self-hosted runner application.

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> For security reasons, public repositories can't use runners in a runner group by default, but you can override this in the runner group's settings. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
**Note:** For security reasons, public repositories can't use runners in a runner group by default, but you can override this in the runner group's settings. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
{% endnote %}

View File

@@ -1,7 +1,4 @@
{% warning %} > [!WARNING]
> {% data reusables.actions.self-hosted-runner-security %}
**Warning**: {% data reusables.actions.self-hosted-runner-security %} >
> For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)."
{% endwarning %}

View File

@@ -1,8 +1,3 @@
{% note %} > [!NOTE]
> * This workflow template contains an action that is not certified by {% data variables.product.prodname_dotcom %}. Actions provided by third parties are governed by separate terms of service, privacy policy, and support documentation.
**Notes**: > * 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 workflow template contains an action that is not certified by {% data variables.product.prodname_dotcom %}. Actions provided by third parties are governed by separate terms of service, privacy policy, and support documentation.
* If you use actions from third parties you should use a version specified by a commit SHA. If the action is revised and you want to use the newer version, you will need to update the SHA. You can specify a version by referencing a tag or a branch, however the action may change without warning. For more information, see "[AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#using-third-party-actions)."
{% endnote %}

View File

@@ -1,9 +1,6 @@
{% note %} > [!NOTE]
> {% data variables.product.company_short %} no longer supports required workflows for {% data variables.product.prodname_actions %}. To require workflows to pass before merging, upgrade {% data variables.product.prodname_ghe_server %} to the latest version and use repository rulesets instead.
**Note:** {% data variables.product.company_short %} no longer supports required workflows for {% data variables.product.prodname_actions %}. To require workflows to pass before merging, upgrade {% data variables.product.prodname_ghe_server %} to the latest version and use repository rulesets instead. >
> For more information about upgrading {% data variables.product.prodname_ghe_server %}, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)."
For more information about upgrading {% data variables.product.prodname_ghe_server %}, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)." >
> For more information about repository rulesets, see "[AUTOTITLE](/enterprise-server@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)."
For more information about repository rulesets, see "[AUTOTITLE](/enterprise-server@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-workflows-to-pass-before-merging)."
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> A job that is skipped will report its status as "Success". It will not prevent a pull request from merging, even if it is a required check.
**Note:** A job that is skipped will report its status as "Success". It will not prevent a pull request from merging, even if it is a required check.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!TIP]
> Ensure the `working-directory` you assign exists on the runner before you run your shell in it.
**Tip:** Ensure the `working-directory` you assign exists on the runner before you run your shell in it.
{% endnote %}

View File

@@ -1,6 +1,6 @@
{% ifversion ghes or ghec %} {% ifversion ghes or ghec %}
{% note %}
**Note:** If you enable {% data variables.product.prodname_GH_advanced_security %}, active committers to these repositories will use {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %}. This option is deactivated if you have exceeded your license capacity. {% ifversion fpt or ghec %}See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %} > [!NOTE]
{% endnote %} > If you enable {% data variables.product.prodname_GH_advanced_security %}, active committers to these repositories will use {% data variables.product.prodname_GH_advanced_security %} {% ifversion ghas-billing-UI-update %}licenses{% else %}seats{% endif %}. This option is deactivated if you have exceeded your license capacity. {% ifversion fpt or ghec %}See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security)."{% endif %}
{% endif %} {% endif %}

View File

@@ -1,11 +1,7 @@
1. Optionally, to enable push protection for your custom pattern, click **Enable**. 1. Optionally, to enable push protection for your custom pattern, click **Enable**.
{% 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)."
**Note:** > * 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 %}
![Screenshot of custom pattern page with the button to enable push protection emphasized.](/assets/images/help/repository/secret-scanning-custom-pattern-enable-push-protection.png) ![Screenshot of custom pattern page with the button to enable push protection emphasized.](/assets/images/help/repository/secret-scanning-custom-pattern-enable-push-protection.png)

View File

@@ -1,11 +1,8 @@
1. In the "Pattern name" field, type a name for your pattern. 1. In the "Pattern name" field, type a name for your pattern.
1. On the top right, click **Generate with AI**. 1. On the top right, click **Generate with AI**.
{% note %} > [!NOTE]
> You can enter a regular expression manually instead of using the generator, by typing a regular expression for the format of your secret pattern in the "Secret format" field. For more information, see "[Defining a custom pattern for a repository](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization)."
**Note:** You can enter a regular expression manually instead of using the generator, by typing a regular expression for the format of your secret pattern in the "Secret format" field. For more information, see "[Defining a custom pattern for a repository](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-a-repository)" or "[Defining a custom pattern for an organization](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns/defining-custom-patterns-for-secret-scanning#defining-a-custom-pattern-for-an-organization)."
{% endnote %}
1. In the sliding panel that is displayed: 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 "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.

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Workflow templates for {% data variables.product.prodname_advanced_security %} have been consolidated in a "Security" category in the **Actions** tab of a repository.
**Note:** Workflow templates for {% data variables.product.prodname_advanced_security %} have been consolidated in a "Security" category in the **Actions** tab of a repository.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% warning %} > [!WARNING]
> Revoking all permission from an {% data variables.product.prodname_oauth_app %} deletes any SSH keys the application generated on behalf of the user, including [deploy keys](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys).
**Warning**: Revoking all permission from an {% data variables.product.prodname_oauth_app %} deletes any SSH keys the application generated on behalf of the user, including [deploy keys](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys).
{% endwarning %}

View File

@@ -29,8 +29,5 @@
For more information about this endpoint, see "[AUTOTITLE](/rest/apps/apps)". For more information about this endpoint, see "[AUTOTITLE](/rest/apps/apps)".
{% note %} > [!NOTE]
> {% data reusables.getting-started.bearer-vs-token %}
**Note:** {% data reusables.getting-started.bearer-vs-token %}
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> The addresses in the IP allow list of a {% data variables.product.prodname_github_app %} only affect requests made by installations of the {% data variables.product.prodname_github_app %}. The automatic addition of a {% data variables.product.prodname_github_app %}'s IP address to an organization's allow list does not allow access to a {% data variables.product.product_name %} user who connects from that IP address.
**Note:** The addresses in the IP allow list of a {% data variables.product.prodname_github_app %} only affect requests made by installations of the {% data variables.product.prodname_github_app %}. The automatic addition of a {% data variables.product.prodname_github_app %}'s IP address to an organization's allow list does not allow access to a {% data variables.product.product_name %} user who connects from that IP address.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Display of token data for Git events in the audit log is in {% data variables.release-phases.public_preview %} and subject to change.
**Note**: Display of token data for Git events in the audit log is in {% data variables.release-phases.public_preview %} and subject to change.
{% endnote %}

View File

@@ -7,9 +7,7 @@ Token data appears in the audit log for the following authentication methods.
* Deploy key * Deploy key
* SSH key * SSH key
{% note %} > [!NOTE]
> Display of token data for SSH keys and deploy keys in the audit log is in {% data variables.release-phases.public_preview %} and subject to change.
**Note**: Display of token data for SSH keys and deploy keys in the audit log is in {% data variables.release-phases.public_preview %} and subject to change.
{%- endnote %}
{% endif %} {% endif %}

View File

@@ -1,7 +1,6 @@
{% ifversion ghec %} {% ifversion ghec %}
{% note %}
**Note:** When you export Git events, events that were initiated via the web browser or the REST or GraphQL APIs are not included. For example, when a user merges a pull request in the web browser, changes are pushed to the base branch, but the Git event for that push is not included in the export. > [!NOTE]
> When you export Git events, events that were initiated via the web browser or the REST or GraphQL APIs are not included. For example, when a user merges a pull request in the web browser, changes are pushed to the base branch, but the Git event for that push is not included in the export.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,7 +1,6 @@
{% ifversion git-events-audit-log %} {% ifversion git-events-audit-log %}
{% note %}
**Note:** Git events are not included in search results. > [!NOTE]
> Git events are not included in search results.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,10 +1,7 @@
While searching the audit log on {% data variables.product.prodname_dotcom %}, include `hashed_token:"VALUE"` in your search query, replacing `VALUE` with the SHA-256 hash of the token. While searching the audit log on {% data variables.product.prodname_dotcom %}, include `hashed_token:"VALUE"` in your search query, replacing `VALUE` with the SHA-256 hash of the token.
{% note %} > [!NOTE]
> Make sure to wrap the hashed token value in quotation marks.
**Note:** Make sure to wrap the hashed token value in quotation marks.
{% endnote %}
{% ifversion token-audit-log-more-metadata %} {% ifversion token-audit-log-more-metadata %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> The {% data variables.product.prodname_codespaces %} Education benefit is currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %} release, your organization will not be charged if you exceed the free allowance.
**Note**: The {% data variables.product.prodname_codespaces %} Education benefit is currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %} release, your organization will not be charged if you exceed the free allowance.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% warning %} > [!WARNING]
> Be careful where you share invitation URLs. Anyone with an invitation URL for an assignment can accept the invitation and associate a personal account on {% data variables.product.product_name %} with an identifier in your roster.
**Warning**: Be careful where you share invitation URLs. Anyone with an invitation URL for an assignment can accept the invitation and associate a personal account on {% data variables.product.product_name %} with an identifier in your roster.
{% endwarning %}

View File

@@ -12,10 +12,7 @@ Using LTI helps keep your information safe and secure. LTI is an industry-standa
* Sakai * Sakai
* Google Classroom * Google Classroom
{% note %} > [!NOTE]
> Other LMSes that implement LTI 1.3 may also work with {% data variables.product.prodname_classroom %}, but have not yet been verified. LMS admins may need to configure custom settings around privacy and button placement and may need to provide teachers with documentation on how to launch into {% data variables.product.prodname_classroom %} from the LMS.
**Note:** Other LMSes that implement LTI 1.3 may also work with {% data variables.product.prodname_classroom %}, but have not yet been verified. LMS admins may need to configure custom settings around privacy and button placement and may need to provide teachers with documentation on how to launch into {% data variables.product.prodname_classroom %} from the LMS.
{% endnote %}
{% data reusables.classroom.google-classroom-note %} {% data reusables.classroom.google-classroom-note %}

View File

@@ -1,7 +1,4 @@
You can optionally choose a template repository as starter code for the assignment. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository)." You can optionally choose a template repository as starter code for the assignment. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/create-an-assignment-from-a-template-repository)."
{% note %} > [!NOTE]
> The template repository must belong to your organization or be a public repository on {% data variables.product.product_name %}.
**Note:** The template repository must belong to your organization or be a public repository on {% data variables.product.product_name %}.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% tip %} > [!TIP]
> You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue list`](https://cli.github.com/manual/gh_issue_list)" or "[`gh pr list`](https://cli.github.com/manual/gh_pr_list)" in the {% data variables.product.prodname_cli %} documentation.
**Tip**: You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue list`](https://cli.github.com/manual/gh_issue_list)" or "[`gh pr list`](https://cli.github.com/manual/gh_pr_list)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %}

View File

@@ -1,10 +1,8 @@
{% ifversion code-scanning-task-lists %} {% ifversion code-scanning-task-lists %}
{% note %} > [!NOTE]
> The tracking of {% data variables.product.prodname_code_scanning %} alerts in issues is in {% data variables.release-phases.public_preview %} and subject to change.
>
> This feature supports running analysis natively using {% data variables.product.prodname_actions %} or externally using existing CI/CD infrastructure, as well as third-party {% data variables.product.prodname_code_scanning %} tools, but _not_ third-party tracking tools.
**Note:** The tracking of {% data variables.product.prodname_code_scanning %} alerts in issues is in {% data variables.release-phases.public_preview %} and subject to change.
This feature supports running analysis natively using {% data variables.product.prodname_actions %} or externally using existing CI/CD infrastructure, as well as third-party {% data variables.product.prodname_code_scanning %} tools, but _not_ third-party tracking tools.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Support for {% data variables.actions.hosted_runners %} for {% data variables.product.prodname_code_scanning %} default setup is currently in {% data variables.release-phases.public_preview %} and subject to change.
**Note:** Support for {% data variables.actions.hosted_runners %} for {% data variables.product.prodname_code_scanning %} default setup is currently in {% data variables.release-phases.public_preview %} and subject to change.
{% endnote %}

View File

@@ -1,9 +1,6 @@
{% ifversion codeql-model-packs %} {% ifversion codeql-model-packs %}
{% note %} > [!NOTE]
> {% data variables.product.prodname_codeql %} model packs and the {% data variables.product.prodname_codeql %} model editor are currently in {% data variables.release-phases.public_preview %} and subject to change. Model packs are supported by {% data variables.code-scanning.codeql_model_packs_support %} analysis.
**Note:** {% data variables.product.prodname_codeql %} model packs and the {% data variables.product.prodname_codeql %} model editor are currently in {% data variables.release-phases.public_preview %} and subject to change. Model packs are supported by {% data variables.code-scanning.codeql_model_packs_support %} analysis.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,9 +1,6 @@
{% ifversion ghes = 3.10 %} {% ifversion ghes = 3.10 %}
{% note %} > [!NOTE]
> The ability to enable and disable default setup for {% data variables.product.prodname_code_scanning %} for eligible repositories in an organization is currently in {% data variables.release-phases.public_preview %} and subject to change.
**Note:** The ability to enable and disable default setup for {% data variables.product.prodname_code_scanning %} for eligible repositories in an organization is currently in {% data variables.release-phases.public_preview %} and subject to change.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,9 +1,6 @@
{% ifversion codeql-cli-threat-models %} {% ifversion codeql-cli-threat-models %}
{% note %} > [!NOTE]
> Threat models are currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %}, threat models are supported only by analysis for {% data variables.code-scanning.code_scanning_threat_model_support %}.
**Note:** Threat models are currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %}, threat models are supported only by analysis for {% data variables.code-scanning.code_scanning_threat_model_support %}.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,9 +1,6 @@
{% ifversion codeql-threat-models %} {% ifversion codeql-threat-models %}
{% note %} > [!NOTE]
> Threat models are currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %}, threat models are supported only by analysis for {% data variables.code-scanning.code_scanning_threat_model_support %}.
**Note:** Threat models are currently in {% data variables.release-phases.public_preview %} and subject to change. During the {% data variables.release-phases.public_preview %}, threat models are supported only by analysis for {% data variables.code-scanning.code_scanning_threat_model_support %}.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,10 +1,7 @@
{% ifversion ghes %} {% ifversion ghes %}
{% note %} > [!NOTE]
> This article describes the features available with the version of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql_cli %} bundle included in the initial release of this version of {% data variables.product.product_name %}. If your enterprise uses a more recent version of the {% data variables.product.prodname_codeql %} action, see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features.
**Note:** This article describes the features available with the version of the {% data variables.product.prodname_codeql %} action and associated {% data variables.product.prodname_codeql_cli %} bundle included in the initial release of this version of {% data variables.product.product_name %}. If your enterprise uses a more recent version of the {% data variables.product.prodname_codeql %} action, see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features.
For information on using the latest version, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)." For information on using the latest version, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)."
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,9 +1,8 @@
{% ifversion ghes %} {% ifversion ghes %}
{% note %}
**Note:** This article describes the features available with the {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %} bundle included in the initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}. > [!NOTE]
> This article describes the features available with the {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %} bundle included in the initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}.
>
> If your site administrator has updated your {% data variables.product.prodname_codeql_cli %} version to a newer release, please see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features.
If your site administrator has updated your {% data variables.product.prodname_codeql_cli %} version to a newer release, please see the [{% data variables.product.prodname_ghe_cloud %} version](/enterprise-cloud@latest/{{ currentArticle }}) of this article for information on the latest features.
{% endnote %}
{% endif %} {% endif %}

View File

@@ -11,11 +11,8 @@
| Ruby | `ruby` | Ruby | `ruby`
| Swift | `swift` | Swift | `swift`
{% note %} > [!NOTE]
> If you specify one of the alternative identifiers, this is equivalent to using the standard language identifier. For example, specifying `javascript` instead of `javascript-typescript` will not exclude analysis of TypeScript code. You can do this in an advanced setup workflow with the `--paths-ignore` option. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan)."
**Note:** If you specify one of the alternative identifiers, this is equivalent to using the standard language identifier. For example, specifying `javascript` instead of `javascript-typescript` will not exclude analysis of TypeScript code. You can do this in an advanced setup workflow with the `--paths-ignore` option. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#specifying-directories-to-scan)."
{% endnote %}
{% else %} {% else %}

View File

@@ -8,13 +8,8 @@
* Ruby * Ruby
* Swift * Swift
{% note %} > [!NOTE]
> * Use {% ifversion codeql-language-identifiers-311 %}`java-kotlin`{% else %}`java`{% endif %} to analyze code written in Java, Kotlin or both.
**Notes**: > * Use {% ifversion codeql-language-identifiers-311 %}`javascript-typescript`{% else %}`javascript`{% endif %} to analyze code written in JavaScript, TypeScript or both.
* Use {% ifversion codeql-language-identifiers-311 %}`java-kotlin`{% else %}`java`{% endif %} to analyze code written in Java, Kotlin or both.
* Use {% ifversion codeql-language-identifiers-311 %}`javascript-typescript`{% else %}`javascript`{% endif %} to analyze code written in JavaScript, TypeScript or both.
{% endnote %}
For more information, see the documentation on the {% data variables.product.prodname_codeql %} website: "[Supported languages and frameworks](https://codeql.github.com/docs/codeql-overview/supported-languages-and-frameworks/)." For more information, see the documentation on the {% data variables.product.prodname_codeql %} website: "[Supported languages and frameworks](https://codeql.github.com/docs/codeql-overview/supported-languages-and-frameworks/)."

View File

@@ -2,10 +2,7 @@ This table lists the queries available with the latest release of the {% data va
{% ifversion ghes %} {% ifversion ghes %}
{% note %} > [!NOTE]
> The initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }} included {% data variables.product.prodname_codeql %} action and {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %}, which may not include all of these queries. Your site administrator can update your {% data variables.product.prodname_codeql %} version to a newer release. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)."
**Note:** The initial release of {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }} included {% data variables.product.prodname_codeql %} action and {% data variables.product.prodname_codeql_cli %} {% data variables.product.codeql_cli_ghes_recommended_version %}, which may not include all of these queries. Your site administrator can update your {% data variables.product.prodname_codeql %} version to a newer release. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)."
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,9 +1,6 @@
{% ifversion ghes %} {% ifversion ghes %}
{% note %} > [!NOTE]
> Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. If you want to use {% data variables.product.prodname_actions %} to scan your code, the site administrator must also enable {% data variables.product.prodname_actions %} and set up the infrastructure required. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)."
**Note:** Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. If you want to use {% data variables.product.prodname_actions %} to scan your code, the site administrator must also enable {% data variables.product.prodname_actions %} and set up the infrastructure required. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)."
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,11 +1,8 @@
{% ifversion ghes %} {% ifversion ghes %}
{% note %} > [!NOTE]
> Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)."
**Note:** Your site administrator must enable {% data variables.product.prodname_code_scanning %} before you can use this feature. For more information, see "[AUTOTITLE](/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance)." >
> You may not be able to enable or disable {% data variables.product.prodname_code_scanning %} if an enterprise owner has set a {% data variables.product.prodname_GH_advanced_security %} (GHAS) policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)."
You may not be able to enable or disable {% data variables.product.prodname_code_scanning %} if an enterprise owner has set a {% data variables.product.prodname_GH_advanced_security %} (GHAS) policy at the enterprise level. For more information, see "[AUTOTITLE](/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise)."
{% endnote %}
{% endif %} {% endif %}

View File

@@ -1,12 +1,8 @@
{% note %} > [!NOTE] {% 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/)."
**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/)."
{%- elsif ghec %} {%- 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 %} {%- 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 %} {% endif %}
* {% data reusables.code-scanning.non-glibc-linux-support %} > * {% data reusables.code-scanning.non-glibc-linux-support %}
{% endnote %}

View File

@@ -9,8 +9,5 @@
* {% 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 %} > [!NOTE]
> The `max-paths` setting affects the results of all dataflow queries.
**Note:** The `max-paths` setting affects the results of all dataflow queries.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Uploading SARIF data to display as {% data variables.product.prodname_code_scanning %} results in {% data variables.product.product_name %} is supported for organization-owned repositories with {% data variables.product.prodname_GH_advanced_security %} enabled{% ifversion fpt or ghec %}, and public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)."
**Note:** Uploading SARIF data to display as {% data variables.product.prodname_code_scanning %} results in {% data variables.product.product_name %} is supported for organization-owned repositories with {% data variables.product.prodname_GH_advanced_security %} enabled{% ifversion fpt or ghec %}, and public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)."
{% endnote %}

View File

@@ -1,10 +1,7 @@
{% note %} > [!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:
**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/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/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 dont 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 its easiest to use database analyze to directly generate interpreted results.
Queries run with these commands dont 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 its easiest to use database analyze to directly generate interpreted results.
{% endnote %}

View File

@@ -4,8 +4,5 @@ You can save your files, close and stop your codespace, and come back to your wo
However, if you delete an unpublished codespace, or if it's automatically deleted by being left unused for the duration of the retention period, then your work will be deleted too. To persist your work, and to allow others to work on your project, you will need to publish your codespace to a repository on {% data variables.product.prodname_dotcom %}. However, if you delete an unpublished codespace, or if it's automatically deleted by being left unused for the duration of the retention period, then your work will be deleted too. To persist your work, and to allow others to work on your project, you will need to publish your codespace to a repository on {% data variables.product.prodname_dotcom %}.
{% note %} > [!NOTE]
> If an unpublished codespace is currently billed to an organization, publishing the codespace transfers ownership and billing of the codespace to your personal account. See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#how-billing-is-handled-for-github-codespaces-templates)."
**Note:** If an unpublished codespace is currently billed to an organization, publishing the codespace transfers ownership and billing of the codespace to your personal account. See "[AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#how-billing-is-handled-for-github-codespaces-templates)."
{% endnote %}

View File

@@ -1,8 +1,3 @@
{% note %} > [!NOTE]
> * Using {% data variables.product.prodname_github_codespaces %} with JetBrains IDEs is currently in {% data variables.release-phases.public_preview %} and is subject to change.
**Notes:** > * 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 {% data variables.release-phases.public_preview %} 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 %}

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> Codespaces policies only apply to codespaces that your organizations pays for. If someone creates a codespace for a repository in your organization at their own expense, then the codespace will not be bound by these policies. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization)."
**Note**: Codespaces policies only apply to codespaces that your organizations pays for. If someone creates a codespace for a repository in your organization at their own expense, then the codespace will not be bound by these policies. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization)."
{% endnote %}

View File

@@ -2,11 +2,8 @@
![Screenshot of the repository selection dropdown, showing the options "All repositories" and "Selected repositories."](/assets/images/help/codespaces/selected-repositories.png) ![Screenshot of the repository selection dropdown, showing the options "All repositories" and "Selected repositories."](/assets/images/help/codespaces/selected-repositories.png)
{% note %} > [!NOTE]
> If you're adding a constraint to an existing policy that already contains the "Maximum codespaces per user" constraint, you won't be able to apply the policy to selected repositories. This is because the "Maximum codespaces per user" constraint always applies to all repositories in the organization.
**Note**: If you're adding a constraint to an existing policy that already contains the "Maximum codespaces per user" constraint, you won't be able to apply the policy to selected repositories. This is because the "Maximum codespaces per user" constraint always applies to all repositories in the organization.
{% endnote %}
With **Selected repositories** selected: With **Selected repositories** selected:
1. Click {% octicon "gear" aria-label="The settings icon" %}. 1. Click {% octicon "gear" aria-label="The settings icon" %}.

View File

@@ -17,8 +17,5 @@ After you connect your account on {% data variables.product.github %} to the {%
1. If prompted to choose a dev container configuration file, choose a file from the list. 1. If prompted to choose a dev container configuration file, choose a file from the list.
1. Click the machine type you want to use. 1. Click the machine type you want to use.
{% note %} > [!NOTE]
> {% data reusables.codespaces.codespaces-machine-type-availability %}
**Note**: {% data reusables.codespaces.codespaces-machine-type-availability %}
{% endnote %}

View File

@@ -16,8 +16,5 @@
1. Copy the token. 1. Copy the token.
{% note %} > [!IMPORTANT]
> Don't share this access token with anyone.
**Important**: Don't share this access token with anyone.
{% endnote %}

View File

@@ -1,5 +1,2 @@
{% tip %} > [!TIP]
> You may occasionally want to perform a full rebuild to clear your cache and rebuild your container with fresh images. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace#about-rebuilding-a-container)."
**Tip:** You may occasionally want to perform a full rebuild to clear your cache and rebuild your container with fresh images. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace#about-rebuilding-a-container)."
{% endtip %}

View File

@@ -2,11 +2,8 @@
You can create links to your existing codespaces. This is useful if you have a long-lived codespace that you return to frequently. You can save the link in a location of your choice, as an alternative to using the link on https://github.com/codespaces. You can create links to your existing codespaces. This is useful if you have a long-lived codespace that you return to frequently. You can save the link in a location of your choice, as an alternative to using the link on https://github.com/codespaces.
{% note %} > [!NOTE]
> You can only open your own codespaces. If someone clicks a link to one of your codespaces they will see a 404 error message.
**Note**: You can only open your own codespaces. If someone clicks a link to one of your codespaces they will see a 404 error message.
{% endnote %}
Create a link using one of the following URL patterns. In these URLs `CODESPACE-NAME` represents the unique, permanent name of the codespace, such as `literate-space-parakeet-w5vg5ww5p793g7g9`, not the codespace's display name. You can find the name of a codespace by copying the link to the codespace on your https://github.com/codespaces page and extracting the codespace name from the URL. Create a link using one of the following URL patterns. In these URLs `CODESPACE-NAME` represents the unique, permanent name of the codespace, such as `literate-space-parakeet-w5vg5ww5p793g7g9`, not the codespace's display name. You can find the name of a codespace by copying the link to the codespace on your https://github.com/codespaces page and extracting the codespace name from the URL.

View File

@@ -19,14 +19,9 @@ Alternatively, you can also open the JetBrains Gateway and select an existing co
1. Click **Connect**. 1. Click **Connect**.
{% note %} > [!NOTE]
> * 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**.
**Notes**: >
> 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.<br><br>
* 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 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 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.<br><br>
* 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 %}

View File

@@ -2,11 +2,8 @@ When an application running inside a codespace prints output to the terminal tha
You can edit the dev container configuration for the repository to automatically forward one or more ports. You can also forward a port manually, label forwarded ports, share forwarded ports with members of your organization, share forwarded ports publicly, and add forwarded ports to the codespace configuration. You can edit the dev container configuration for the repository to automatically forward one or more ports. You can also forward a port manually, label forwarded ports, share forwarded ports with members of your organization, share forwarded ports publicly, and add forwarded ports to the codespace configuration.
{% note %} > [!NOTE]
> {% data reusables.codespaces.restrict-port-visibility %}
**Note**: {% data reusables.codespaces.restrict-port-visibility %}
{% endnote %}
## Forwarding a port ## Forwarding a port

View File

@@ -1,15 +1,9 @@
## Sharing a port ## Sharing a port
{% note %} > [!NOTE]
> You can only make a port private to an organization if your organization uses {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}.
**Note:** You can only make a port private to an organization if your organization uses {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %}.
{% endnote %}
If you want to share a forwarded port with others, you can either make the port private to your organization or make the port public. After you make a port private to your organization, anyone in the organization with the port's URL can view the running application. After you make a port public, anyone who knows the URL and port number can view the running application without needing to authenticate. If you want to share a forwarded port with others, you can either make the port private to your organization or make the port public. After you make a port private to your organization, anyone in the organization with the port's URL can view the running application. After you make a port public, anyone who knows the URL and port number can view the running application without needing to authenticate.
{% note %} > [!NOTE]
> Your choice of port visibility options may be limited by a policy configured for your organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)."
**Note:** Your choice of port visibility options may be limited by a policy configured for your organization. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)."
{% endnote %}

View File

@@ -6,8 +6,5 @@
Click **Authorize and continue** to grant these permissions for creation of prebuilds. Alternatively, you can click **Continue without authorizing** but, if you do so, codespaces created from the resulting prebuilds may not work properly. Click **Authorize and continue** to grant these permissions for creation of prebuilds. Alternatively, you can click **Continue without authorizing** but, if you do so, codespaces created from the resulting prebuilds may not work properly.
{% note %} > [!NOTE]
> Users who create codespaces using this prebuild will also be asked to grant these permissions.
**Note**: Users who create codespaces using this prebuild will also be asked to grant these permissions.
{% endnote %}

View File

@@ -5,11 +5,9 @@ If you're working in a codespace, you can publish it from the {% data variables.
![Screenshot of the "Source control" side bar with the staging button (a plus sign), to the right of "Changes," highlighted with a dark orange outline.](/assets/images/help/codespaces/codespaces-commit-stage.png) ![Screenshot of the "Source control" side bar with the staging button (a plus sign), to the right of "Changes," highlighted with a dark orange outline.](/assets/images/help/codespaces/codespaces-commit-stage.png)
{% note %} > [!NOTE]
> If you start from {% data variables.product.company_short %}'s blank template, you will not see a list of changes unless you have already initialized your directory as a Git repository. To publish codespaces created from the blank template, click **Publish to {% data variables.product.company_short %}** in the "Source Control" view, then skip to step 5.
**Note:** If you start from {% data variables.product.company_short %}'s blank template, you will not see a list of changes unless you have already initialized your directory as a Git repository. To publish codespaces created from the blank template, click **Publish to {% data variables.product.company_short %}** in the "Source Control" view, then skip to step 5.
{% endnote %}
1. To commit your staged changes, type a commit message describing the change you've made, then click **Commit**. 1. To commit your staged changes, type a commit message describing the change you've made, then click **Commit**.
![Screenshot of the "Source control" side bar with a commit message and, below it, the "Commit" button both highlighted with a dark orange outline.](/assets/images/help/codespaces/vscode-commit-button.png) ![Screenshot of the "Source control" side bar with a commit message and, below it, the "Commit" button both highlighted with a dark orange outline.](/assets/images/help/codespaces/vscode-commit-button.png)

View File

@@ -1,5 +1,2 @@
{% note %} > [!NOTE]
> When you rebuild the container in a codespace, changes you have made outside the `/workspaces` directory are cleared. Changes you have made inside the `/workspaces` directory, which includes the clone of the repository or template from which you created the codespace, are preserved over a rebuild. For more information, see "[AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace)."
**Note:** When you rebuild the container in a codespace, changes you have made outside the `/workspaces` directory are cleared. Changes you have made inside the `/workspaces` directory, which includes the clone of the repository or template from which you created the codespace, are preserved over a rebuild. For more information, see "[AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace)."
{% endnote %}

View File

@@ -1,9 +1,6 @@
{% note %} > [!NOTE]
> If the Remote Explorer is not displayed in the Activity Bar:
**Note**: If the Remote Explorer is not displayed in the Activity Bar: >
> 1. Access the Command Palette. For example, by pressing <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>P</kbd> (Mac) / <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux).
1. Access the Command Palette. For example, by pressing <kbd>Shift</kbd>+<kbd>Command</kbd>+<kbd>P</kbd> (Mac) / <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux). > 1. Type: `details`.
1. Type: `details`. > 1. Click **Codespaces: Details**.
1. Click **Codespaces: Details**.
{% endnote %}

View File

@@ -1,7 +1,4 @@
Your list of trusted repositories for {% data variables.product.prodname_github_codespaces %} is shared between the GPG verification and Settings Sync features. Assuming you have both features enabled, if you have added a selected list of trusted repositories for GPG verification, Settings Sync is turned on in codespaces created from these repositories. If you trust a new repository for Settings Sync, GPG verification is enabled for the same repository. Although the features share the same list of trusted repositories, you can enable or disable GPG verification and Settings Sync independently. Your list of trusted repositories for {% data variables.product.prodname_github_codespaces %} is shared between the GPG verification and Settings Sync features. Assuming you have both features enabled, if you have added a selected list of trusted repositories for GPG verification, Settings Sync is turned on in codespaces created from these repositories. If you trust a new repository for Settings Sync, GPG verification is enabled for the same repository. Although the features share the same list of trusted repositories, you can enable or disable GPG verification and Settings Sync independently.
{% note %} > [!NOTE]
> If you have previously enabled GPG verification for all repositories, we recommend changing your preferences to use a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)."
**Note:** If you have previously enabled GPG verification for all repositories, we recommend changing your preferences to use a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)."
{% endnote %}

View File

@@ -8,11 +8,8 @@ When you create a codespace from a template repository or a template on the "You
{% data reusables.codespaces.create-or-switch-branch %} {% data reusables.codespaces.create-or-switch-branch %}
{% tip %} > [!TIP]
> If someone has recently changed a file on the remote repository, in the branch you switched to, you may not see those changes until you pull the changes into your codespace.
**Tip**: If someone has recently changed a file on the remote repository, in the branch you switched to, you may not see those changes until you pull the changes into your codespace.
{% endtip %}
## Committing your changes ## Committing your changes

View File

@@ -1,7 +1,4 @@
1. To change your trusted repositories for GPG verification and Settings Sync, under "Trusted repositories," either select **All repositories**, or select **Selected repositories** and use the "Select repositories" dropdown to add repositories you trust. 1. To change your trusted repositories for GPG verification and Settings Sync, under "Trusted repositories," either select **All repositories**, or select **Selected repositories** and use the "Select repositories" dropdown to add repositories you trust.
{% note %} > [!NOTE]
> We recommend using a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)."
**Note:** We recommend using a selected list of trusted repositories. For more information, see "[AUTOTITLE](/codespaces/codespaces-reference/security-in-github-codespaces#using-settings-sync)."
{% endnote %}

Some files were not shown because too many files have changed in this diff Show More