Skip to content

Commit

Permalink
Hack Week 2025: update product.product_name in data/reusables (1)…
Browse files Browse the repository at this point in the history
… (#54099)
  • Loading branch information
am-stead authored Jan 28, 2025
1 parent 5dfb569 commit c63afcb
Show file tree
Hide file tree
Showing 39 changed files with 42 additions and 42 deletions.
2 changes: 1 addition & 1 deletion data/reusables/accounts/accounts-billed-separately.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Each account on {% data variables.product.product_name %} is billed separately. Upgrading an organization account enables paid features for the organization's repositories only and does not affect the features available in repositories owned by any associated personal accounts. Similarly, upgrading a personal account enables paid features for the personal account's repositories only and does not affect the repositories of any organization accounts. For more information about account types, see [AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts).
Each account on {% data variables.product.github %} is billed separately. Upgrading an organization account enables paid features for the organization's repositories only and does not affect the features available in repositories owned by any associated personal accounts. Similarly, upgrading a personal account enables paid features for the personal account's repositories only and does not affect the repositories of any organization accounts. For more information about account types, see [AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts).
2 changes: 1 addition & 1 deletion data/reusables/accounts/marketing-emails.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% data variables.product.product_name %} occasionally sends the following types of marketing emails:
{% data variables.product.github %} occasionally sends the following types of marketing emails:

* Tips and tricks for getting started with your account
* Customized information about engaging projects or new features
Expand Down
2 changes: 1 addition & 1 deletion data/reusables/actions/about-triggers.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Workflow triggers are events that cause a workflow to run. These events can be:

* Events that occur in your workflow's repository
* Events that occur outside of {% data variables.product.product_name %} and trigger a `repository_dispatch` event on {% data variables.product.product_name %}
* Events that occur outside of {% data variables.product.github %} and trigger a `repository_dispatch` event on {% data variables.product.github %}
* Scheduled times
* Manual

Expand Down
2 changes: 1 addition & 1 deletion data/reusables/actions/actions-bundled-with-ghes.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Most official {% data variables.product.prodname_dotcom %}-authored actions are automatically bundled with {% data variables.product.product_name %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}.
Most official {% data variables.product.github %}-authored actions are automatically bundled with {% data variables.product.prodname_ghe_server %}, and are captured at a point in time from {% data variables.product.prodname_marketplace %}.
2 changes: 1 addition & 1 deletion data/reusables/actions/artifact-log-retention-statement.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy).
By default, {% data variables.product.github %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy).
2 changes: 1 addition & 1 deletion data/reusables/actions/azure-vnet-procedures-prereqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ 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).

> [!NOTE]
> As an alternative to using the following file, to allow {% data variables.product.prodname_actions %} to communicate with the runners, you can allow the same firewall domains that are required for communication between self-hosted runners and {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud). To determine the appropriate subnet IP address range, we recommend adding a 30% buffer to the maximum job concurrency you anticipate. For instance, if your network configuration's runners are set to a maximum job concurrency of 300, it's recommended to utilize a subnet IP address range that can accommodate at least 390 runners. This buffer helps ensure that your network can handle unexpected increases in VM needs to meet job concurrency without running out of IP addresses.
> As an alternative to using the following file, to allow {% data variables.product.prodname_actions %} to communicate with the runners, you can allow the same firewall domains that are required for communication between self-hosted runners and {% data variables.product.github %}. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-enterprise-cloud). To determine the appropriate subnet IP address range, we recommend adding a 30% buffer to the maximum job concurrency you anticipate. For instance, if your network configuration's runners are set to a maximum job concurrency of 300, it's recommended to utilize a subnet IP address range that can accommodate at least 390 runners. This buffer helps ensure that your network can handle unexpected increases in VM needs to meet job concurrency without running out of IP addresses.
```bicep copy
@description('NSG for outbound rules')
Expand Down
2 changes: 1 addition & 1 deletion data/reusables/actions/cd-templates-actions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{% data variables.product.product_name %} offers deployment workflow templates for several popular services, such as Azure Web App. To learn how to get started using a workflow template, see [AUTOTITLE](/actions/learn-github-actions/using-starter-workflows) or [browse the full list of deployment workflow templates](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as [AUTOTITLE](/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service).
{% data variables.product.github %} offers deployment workflow templates for several popular services, such as Azure Web App. To learn how to get started using a workflow template, see [AUTOTITLE](/actions/learn-github-actions/using-starter-workflows) or [browse the full list of deployment workflow templates](https://github.com/actions/starter-workflows/tree/main/deployments). You can also check out our more detailed guides for specific deployment workflows, such as [AUTOTITLE](/actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service).

Many service providers also offer actions on {% data variables.product.prodname_marketplace %} for deploying to their service. For the full list, see [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?category=deployment&type=actions).
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
There is no guarantee that self-hosted runners for {% data variables.product.product_name %} will be hosted on ephemeral, clean virtual machines. As a result, they may be compromised by untrusted code in a workflow.
There is no guarantee that self-hosted runners for {% data variables.product.github %} will be hosted on ephemeral, clean virtual machines. As a result, they may be compromised by untrusted code in a workflow.

Similarly, anyone who can fork the repository and open a pull request (generally those with read access to the repository) can compromise the self-hosted runner environment, including gaining access to secrets and the `GITHUB_TOKEN` which, depending on its settings, can grant write access to the repository. Although workflows can control access to environment secrets by using environments and required reviews, these workflows are not run in an isolated environment and are still susceptible to the same risks when run on a self-hosted runner.

Expand Down
2 changes: 1 addition & 1 deletion data/reusables/actions/enterprise-no-internet-actions.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{% data variables.product.prodname_actions %} on {% data variables.product.product_name %} is designed to work in environments without full internet access. By default, workflows cannot use actions from {% data variables.product.prodname_dotcom_the_website %} and [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions).
{% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %} is designed to work in environments without full internet access. By default, workflows cannot use actions from {% data variables.product.prodname_dotcom_the_website %} and [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions).
4 changes: 2 additions & 2 deletions data/reusables/actions/gai-inspect-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ The output from a successful run of the `migrate` command contains a link to the
Some important elements of the pull request include:

* In the pull request description, a section called **Manual steps**, which lists steps that you must manually complete before you can finish migrating your pipelines to {% data variables.product.prodname_actions %}. For example, this section might tell you to create any secrets used in your workflows.
* The converted workflows file. Select the **Files changed** tab in the pull request to view the workflow file that will be added to your {% data variables.product.product_name %} repository.
* The converted workflows file. Select the **Files changed** tab in the pull request to view the workflow file that will be added to your {% data variables.product.github %} repository.

When you are finished inspecting the pull request, you can merge it to add the workflow to your {% data variables.product.product_name %} repository.
When you are finished inspecting the pull request, you can merge it to add the workflow to your {% data variables.product.github %} repository.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
You can control how job failures are handled with `jobs.<job_id>.strategy.fail-fast` and `jobs.<job_id>.continue-on-error`.

`jobs.<job_id>.strategy.fail-fast` applies to the entire matrix. If `jobs.<job_id>.strategy.fail-fast` is set to `true` or its expression evaluates to `true`, {% data variables.product.product_name %} will cancel all in-progress and queued jobs in the matrix if any job in the matrix fails. This property defaults to `true`.
`jobs.<job_id>.strategy.fail-fast` applies to the entire matrix. If `jobs.<job_id>.strategy.fail-fast` is set to `true` or its expression evaluates to `true`, {% data variables.product.github %} will cancel all in-progress and queued jobs in the matrix if any job in the matrix fails. This property defaults to `true`.

`jobs.<job_id>.continue-on-error` applies to a single job. If `jobs.<job_id>.continue-on-error` is `true`, other jobs in the matrix will continue running even if the job with `jobs.<job_id>.continue-on-error: true` fails.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
By default, {% data variables.product.product_name %} will maximize the number of jobs run in parallel depending on runner availability. To set the maximum number of jobs that can run simultaneously when using a `matrix` job strategy, use `jobs.<job_id>.strategy.max-parallel`.
By default, {% data variables.product.github %} will maximize the number of jobs run in parallel depending on runner availability. To set the maximum number of jobs that can run simultaneously when using a `matrix` job strategy, use `jobs.<job_id>.strategy.max-parallel`.

For example, the following workflow will run a maximum of two jobs at a time, even if there are runners available to run all six jobs at once.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Each job runs in a runner environment specified by `runs-on`.

You can run an unlimited number of jobs as long as you are within the workflow usage limits. For more information, see [AUTOTITLE](/actions/learn-github-actions/usage-limits-billing-and-administration) for {% data variables.product.prodname_dotcom %}-hosted runners and [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#usage-limits) for self-hosted runner usage limits.

If you need to find the unique identifier of a job running in a workflow run, you can use the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API. For more information, see [AUTOTITLE](/rest/actions#workflow-jobs).
If you need to find the unique identifier of a job running in a workflow run, you can use the {% data variables.product.github %} API. For more information, see [AUTOTITLE](/rest/actions#workflow-jobs).
4 changes: 2 additions & 2 deletions data/reusables/actions/jobs/using-matrix-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
A job will run for each possible combination of the variables. In this example, the workflow will run six jobs, one for each combination of the `os` and `version` variables.

By default, {% data variables.product.product_name %} will maximize the number of jobs run in parallel depending on runner availability. The order of the variables in the matrix determines the order in which the jobs are created. The first variable you define will be the first job that is created in your workflow run. For example, the above matrix will create the jobs in the following order:
By default, {% data variables.product.github %} will maximize the number of jobs run in parallel depending on runner availability. The order of the variables in the matrix determines the order in which the jobs are created. The first variable you define will be the first job that is created in your workflow run. For example, the above matrix will create the jobs in the following order:

* `{version: 10, os: ubuntu-latest}`
* `{version: 10, os: windows-latest}`
Expand All @@ -20,6 +20,6 @@ By default, {% data variables.product.product_name %} will maximize the number o
* `{version: 14, os: ubuntu-latest}`
* `{version: 14, os: windows-latest}`

A matrix will generate a maximum of 256 jobs per workflow run. This limit applies to both {% data variables.product.product_name %}-hosted and self-hosted runners.
A matrix will generate a maximum of 256 jobs per workflow run. This limit applies to both {% data variables.product.github %}-hosted and self-hosted runners.

The variables that you define become properties in the `matrix` context, and you can reference the property in other areas of your workflow file. In this example, you can use `matrix.version` and `matrix.os` to access the current value of `version` and `os` that the job is using. For more information, see [AUTOTITLE](/actions/learn-github-actions/contexts).
2 changes: 1 addition & 1 deletion data/reusables/actions/self-hosted-runner-architecture.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Your runner machine connects to {% data variables.product.product_name %} using the {% data variables.product.prodname_actions %} self-hosted runner application.
Your runner machine connects to {% data variables.product.github %} using the {% data variables.product.prodname_actions %} self-hosted runner application.
2 changes: 1 addition & 1 deletion data/reusables/actions/self-hosted-runner-auto-removal.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
A self-hosted runner is automatically removed from {% data variables.product.product_name %} if it has not connected to {% data variables.product.prodname_actions %} for more than 14 days. An ephemeral self-hosted runner is automatically removed from {% data variables.product.product_name %} if it has not connected to {% data variables.product.prodname_actions %} for more than 1 day.
A self-hosted runner is automatically removed from {% data variables.product.github %} if it has not connected to {% data variables.product.prodname_actions %} for more than 14 days. An ephemeral self-hosted runner is automatically removed from {% data variables.product.github %} if it has not connected to {% data variables.product.prodname_actions %} for more than 1 day.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@

After completing the steps to add a self-hosted runner, the runner and its status are now listed under {% ifversion fpt or ghec %}"Runners"{% elsif ghes %}"Self-hosted runners"{% endif %}.

The self-hosted runner application must be active for the runner to accept jobs. When the runner application is connected to {% data variables.product.product_name %} and ready to receive jobs, you will see the following message on the machine's terminal.
The self-hosted runner application must be active for the runner to accept jobs. When the runner application is connected to {% data variables.product.github %} and ready to receive jobs, you will see the following message on the machine's terminal.

{% data reusables.actions.self-hosted-runner-connected-output %}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
The connection between self-hosted runners and {% data variables.product.product_name %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/admin/configuration/hardening-security-for-your-enterprise/configuring-tls).{% endif %}
The connection between self-hosted runners and {% data variables.product.github %} is over {% ifversion ghes %}HTTP (port 80) or {% endif %}HTTPS (port 443). {% ifversion ghes %}To ensure connectivity over HTTPS, configure TLS for {% data variables.product.prodname_ghe_server %}. For more information, see [AUTOTITLE](/admin/configuration/hardening-security-for-your-enterprise/configuring-tls).{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@

The removal command does the following tasks:

* Removes the runner from {% data variables.product.product_name %}.
* Removes the runner from {% data variables.product.github %}.
* Removes any self-hosted runner application configuration files on the machine.
* Removes any services configured if not running in interactive mode.

* **If you don't have access to the machine:** Click **Force remove this runner** to force {% data variables.product.product_name %} to remove the runner.
* **If you don't have access to the machine:** Click **Force remove this runner** to force {% data variables.product.github %} to remove the runner.
2 changes: 1 addition & 1 deletion data/reusables/actions/self-hosted-runner-reusing.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Alternatively, if you don't have access to the repository{% ifversion fpt %} or organization{% elsif ghes or ghec %}, organization, or enterprise{% endif %} on {% data variables.product.product_name %} to remove a runner, but you would like to re-use the runner machine, then you can delete the `.runner` file inside the self-hosted runner application directory (that is, the directory into which you downloaded and unpacked the runner software). This allows the runner to be registered without having to re-download the self-hosted runner application.
Alternatively, if you don't have access to the repository{% ifversion fpt %} or organization{% elsif ghes or ghec %}, organization, or enterprise{% endif %} on {% data variables.product.github %} to remove a runner, but you would like to re-use the runner machine, then you can delete the `.runner` file inside the self-hosted runner application directory (that is, the directory into which you downloaded and unpacked the runner software). This allows the runner to be registered without having to re-download the self-hosted runner application.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{%- ifversion ghes %}
* {% data variables.product.prodname_actions %} must be enabled for {% data variables.product.product_name %}. A site administrator can enable and configure {% data variables.product.prodname_actions %} for your instance. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server).
* {% data variables.product.prodname_actions %} must be enabled for {% data variables.product.prodname_ghe_server %}. A site administrator can enable and configure {% data variables.product.prodname_actions %} for your instance. For more information, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server).
{%- endif %}

* You must have access to the machine you will use as a self-hosted runner in your environment.
Expand Down
2 changes: 1 addition & 1 deletion data/reusables/actions/usage-matrix-limits.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
A job matrix can generate a maximum of 256 jobs per workflow run. This limit applies to both {% data variables.product.product_name %}-hosted and self-hosted runners.
A job matrix can generate a maximum of 256 jobs per workflow run. This limit applies to both {% data variables.product.github %}-hosted and self-hosted runners.
Loading

0 comments on commit c63afcb

Please sign in to comment.