diff --git a/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md b/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md index b1bd8075ff..52cc87e50c 100644 --- a/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md @@ -37,19 +37,18 @@ For more information, see "[About self-hosted runners](/github/automating-your-w You can add self-hosted runners to a single repository. To add a self-hosted runner to a user repository, you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. For information about how to add a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." -{% ifversion fpt or ghec %} +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.github-actions.settings-sidebar-actions %} {% data reusables.github-actions.settings-sidebar-actions-runners-updated %} 1. Click **New self-hosted runner**. {% data reusables.github-actions.self-hosted-runner-configure %} -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.github-actions.settings-sidebar-actions-runners %} -1. Under {% ifversion fpt or ghes > 3.1 or ghae or ghec %}"Runners"{% else %}"Self-hosted runners"{% endif %}, click **Add runner**. +1. Under {% ifversion ghes > 3.1 or ghae or ghec %}"Runners"{% else %}"Self-hosted runners"{% endif %}, click **Add runner**. {% data reusables.github-actions.self-hosted-runner-configure %} {% endif %} {% data reusables.github-actions.self-hosted-runner-check-installation-success %} @@ -58,19 +57,18 @@ You can add self-hosted runners to a single repository. To add a self-hosted run You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner. For information about how to add a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." -{% ifversion fpt or ghec %} +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.github-actions.settings-sidebar-actions %} {% data reusables.github-actions.settings-sidebar-actions-runners-updated %} 1. Click **New runner**. {% data reusables.github-actions.self-hosted-runner-configure %} -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.github-actions.settings-sidebar-actions-runners %} -1. Under {% ifversion fpt or ghes > 3.1 or ghae or ghec %}"Runners"{% else %}"Self-hosted runners"{% endif %}, click **Add runner**. +1. Under {% ifversion ghes > 3.1 or ghae %}"Runners", click **Add new**, then click **New runner**.{% elsif ghes < 3.2 %}"Self-hosted runners", click **Add runner**."{% endif %} {% data reusables.github-actions.self-hosted-runner-configure %} {% endif %} @@ -86,7 +84,7 @@ You can add self-hosted runners at the organization level, where they can be use New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "[Managing access to self-hosted runners](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." -{% ifversion ghec %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} To add a self-hosted runner to an enterprise account, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). {% data reusables.enterprise-accounts.access-enterprise %} @@ -95,8 +93,7 @@ To add a self-hosted runner to an enterprise account, you must be an enterprise {% data reusables.enterprise-accounts.actions-runners-tab %} 1. Click **New runner**. {% data reusables.github-actions.self-hosted-runner-configure %} -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} @@ -105,11 +102,9 @@ To add a self-hosted runner at the enterprise level of {% data variables.product 1. Click **Add new**, then click **New runner**. {% data reusables.github-actions.self-hosted-runner-configure %} {% endif %} -{% ifversion ghec or ghae or ghes %} {% data reusables.github-actions.self-hosted-runner-check-installation-success %} {% data reusables.github-actions.self-hosted-runner-public-repo-access %} -{% endif %} ### Making enterprise runners available to repositories diff --git a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index a0afa6e963..a77a01a315 100644 --- a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -45,7 +45,7 @@ Self-hosted runners are automatically assigned to the default group when created When creating a group, you must choose a policy that defines which repositories have access to the runner group. -{% ifversion ghec %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.github-actions.settings-sidebar-actions-runner-groups %} @@ -60,12 +60,11 @@ When creating a group, you must choose a policy that defines which repositories {% endwarning %} {% data reusables.github-actions.self-hosted-runner-create-group %} -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.github-actions.settings-sidebar-actions-runners %} -1. In the "Self-hosted runners" section, click **Add new**, and then **New group**. +1. Under {% ifversion ghes > 3.1 or ghae %}"Runners"{% elsif ghes < 3.2 %}"Self-hosted runners"{% endif %}, click **Add new**, and then **New group**. ![Add runner group](/assets/images/help/settings/actions-org-add-runner-group.png) 1. Enter a name for your runner group, and assign a policy for repository access. @@ -94,7 +93,7 @@ Self-hosted runners are automatically assigned to the default group when created When creating a group, you must choose a policy that defines which organizations have access to the runner group. -{% ifversion ghec %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} @@ -112,8 +111,7 @@ When creating a group, you must choose a policy that defines which organizations {% endwarning %} {% data reusables.github-actions.self-hosted-runner-create-group %} -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} @@ -143,7 +141,7 @@ When creating a group, you must choose a policy that defines which organizations ## Changing the access policy of a self-hosted runner group You can update the access policy of a runner group, or rename a runner group. -{% ifversion fpt or ghec %} +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.github-actions.self-hosted-runner-groups-navigate-to-repo-org-enterprise %} {% data reusables.github-actions.settings-sidebar-actions-runner-groups-selection %} 1. Modify the access options, or change the runner group name. @@ -157,8 +155,7 @@ You can update the access policy of a runner group, or rename a runner group. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." {% endwarning %} -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.github-actions.self-hosted-runner-configure-runner-group-access %} {% endif %} @@ -180,20 +177,21 @@ Could not find any self-hosted runner group named "rg-runnergroup". ## Moving a self-hosted runner to a group If you don't specify a runner group during the registration process, your new self-hosted runners are automatically assigned to the default group, and can then be moved to another group. -{% ifversion ghec or ghes > 3.1 or ghae %} + {% data reusables.github-actions.self-hosted-runner-navigate-to-org-enterprise %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} 1. In the "Runners" list, click the runner that you want to configure. 2. Select the Runner group dropdown menu. 3. In "Move runner to group", choose a destination group for the runner. -{% endif %} -{% ifversion ghes < 3.2 or ghae %} -1. In the "Self-hosted runners" section of the settings page, locate the current group of the runner you want to move and expand the list of group members. +{% elsif ghae or ghes < 3.4 %} +1. In the {% ifversion ghes > 3.1 or ghae %}"Runner groups"{% elsif ghes < 3.2 %}"Self-hosted runners"{% endif %} section of the settings page, locate the current group of the runner you want to move and expand the list of group members. ![View runner group members](/assets/images/help/settings/actions-org-runner-group-members.png) 2. Select the checkbox next to the self-hosted runner, and then click **Move to group** to see the available destinations. ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move.png) 3. To move the runner, click on the destination group. ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move-destination.png) {% endif %} + ## Removing a self-hosted runner group Self-hosted runners are automatically returned to the default group when their group is removed. @@ -203,8 +201,7 @@ Self-hosted runners are automatically returned to the default group when their g 1. In the list of groups, to the right of the group you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. 2. To remove the group, click **Remove group**. 3. Review the confirmation prompts, and click **Remove this runner group**. -{% endif %} -{% ifversion ghes < 3.2 or ghae %} +{% elsif ghes < 3.2 %} 1. In the "Self-hosted runners" section of the settings page, locate the group you want to delete, and click the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} button. ![View runner group settings](/assets/images/help/settings/actions-org-runner-group-kebab.png) diff --git a/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md b/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md index 49a1a6d3d0..759f3c3332 100644 --- a/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md @@ -30,20 +30,20 @@ shortTitle: Remove self-hosted runners To remove a self-hosted runner from a user repository you must be the repository owner. For an organization repository, you must be an organization owner or have admin access to the repository. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." {% data reusables.github-actions.self-hosted-runner-reusing %} -{% ifversion fpt or ghec %} +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.github-actions.settings-sidebar-actions %} {% data reusables.github-actions.settings-sidebar-actions-runners-updated %} {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.github-actions.settings-sidebar-actions-runners %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner %} {% endif %} + ## Removing a runner from an organization {% note %} @@ -57,19 +57,20 @@ To remove a self-hosted runner from a user repository you must be the repository To remove a self-hosted runner from an organization, you must be an organization owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see "[Self-hosted runners](/rest/reference/actions#self-hosted-runners)." {% data reusables.github-actions.self-hosted-runner-reusing %} -{% ifversion fpt or ghes > 3.1 or ghae or ghec %} +{% ifversion fpt or ghes > 3.3 or ghec %} {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.github-actions.settings-sidebar-actions %} {% data reusables.github-actions.settings-sidebar-actions-runners-updated %} {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} -{% else %} +{% elsif ghes < 3.4 or ghae %} {% data reusables.organizations.navigate-to-org %} {% data reusables.organizations.org_settings %} {% data reusables.github-actions.settings-sidebar-actions-runners %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner %} {% endif %} + ## Removing a runner from an enterprise {% ifversion fpt %} @@ -84,18 +85,17 @@ If you use {% data variables.product.prodname_ghe_cloud %}, you can also remove {% endnote %} -{% data reusables.github-actions.self-hosted-runner-reusing %} +To remove a self-hosted runner from an enterprise, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). -{% ifversion ghec %} -To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions). +{% data reusables.github-actions.self-hosted-runner-reusing %} +{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.enterprise-accounts.actions-runners-tab %} {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} {% data reusables.github-actions.self-hosted-runner-removing-a-runner-updated %} -{% elsif ghae or ghes %} -To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. +{% elsif ghae or ghes < 3.4 %} {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.policies-tab %} {% data reusables.enterprise-accounts.actions-tab %} diff --git a/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md index 42ac880513..4b4b6edb5b 100644 --- a/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md @@ -19,14 +19,14 @@ For information on how to use labels to route jobs to specific types of self-hos {% data reusables.github-actions.self-hosted-runner-management-permissions-required %} ## Creating a custom label -{% ifversion fpt or ghec %} + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %} {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} 1. In the "Labels" section, click {% octicon "gear" aria-label="The Gear icon" %}. 1. In the "Find or create a label" field, type the name of your new label and click **Create new label**. The custom label is created and assigned to the self-hosted runner. Custom labels can be removed from self-hosted runners, but they currently can't be manually deleted. {% data reusables.github-actions.actions-unused-labels %} -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %} {% data reusables.github-actions.self-hosted-runner-list %} {% data reusables.github-actions.self-hosted-runner-list-group %} @@ -36,34 +36,37 @@ For information on how to use labels to route jobs to specific types of self-hos The custom label is created and assigned to the self-hosted runner. Custom labels can be removed from self-hosted runners, but they currently can't be manually deleted. {% data reusables.github-actions.actions-unused-labels %} {% endif %} + ## Assigning a label to a self-hosted runner -{% ifversion fpt or ghec %} + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %} {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} {% data reusables.github-actions.runner-label-settings %} 1. To assign a label to your self-hosted runner, in the "Find or create a label" field, click the label. -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %} {% data reusables.github-actions.self-hosted-runner-list %} {% data reusables.github-actions.self-hosted-runner-list-group %} {% data reusables.github-actions.self-hosted-runner-labels-view-assigned-labels %} 1. Click on a label to assign it to your self-hosted runner. {% endif %} + ## Removing a custom label from a self-hosted runner -{% ifversion fpt or ghec %} + +{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %} {% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %} {% data reusables.github-actions.settings-sidebar-actions-runner-selection %} {% data reusables.github-actions.runner-label-settings %} 1. In the "Find or create a label" field, assigned labels are marked with the {% octicon "check" aria-label="The Check icon" %} icon. Click on a marked label to unassign it from your self-hosted runner. -{% endif %} -{% ifversion ghae or ghes %} +{% elsif ghae or ghes < 3.4 %} {% data reusables.github-actions.self-hosted-runner-navigate-to-repo-org-enterprise %} {% data reusables.github-actions.self-hosted-runner-list %} {% data reusables.github-actions.self-hosted-runner-list-group %} {% data reusables.github-actions.self-hosted-runner-labels-view-assigned-labels %} 1. Click on the assigned label to remove it from your self-hosted runner. {% data reusables.github-actions.actions-unused-labels %} {% endif %} + ## Using the configuration script to create and assign labels You can use the configuration script on the self-hosted runner to create and assign custom labels. For example, this command assigns a label named `gpu` to the self-hosted runner. diff --git a/data/reusables/github-actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md b/data/reusables/github-actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md index 2efea4d2c3..39720ea972 100644 --- a/data/reusables/github-actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md +++ b/data/reusables/github-actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md @@ -12,6 +12,6 @@ 2. In the left sidebar, click **Enterprise overview**. 3. In the enterprise sidebar, click {% octicon "law" aria-label="The law icon" %} **Policies**.{% endif %} 2. Navigate to the "Runner groups" settings: - * **In an organization**: Click **Actions** in the left sidebar{% ifversion fpt or ghec %}, then click **Runner groups** below it{% endif %}.{% ifversion ghec or ghes or ghae %} - * {% ifversion ghec %}**If using an enterprise account**:{% elsif ghes or ghae %}**If using an enterprise-level runner**:{% endif %} Click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies"{% ifversion ghec %}, then click the **Runners groups** tab{% endif %}.{% endif %} + * **In an organization**: Click **Actions** in the left sidebar, then click {% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5091 %}**Runner groups**{% elsif ghae or ghes < 3.4 %}**Runners**{% endif %} below it.{% ifversion ghec or ghes or ghae %} + * {% ifversion ghec %}**If using an enterprise account**:{% elsif ghes or ghae %}**If using an enterprise-level runner**:{% endif %} Click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies", then click the {% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}**Runners groups**{% elsif ghae or ghes < 3.4 %}**Runners**{% endif %} tab.{% endif %} {% endif %}