You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -164,7 +164,7 @@ You can configure a subject that filters for a specific [environment](/actions/d
164
164
165
165
#### Filtering for `pull_request` events
166
166
167
-
The subject claim includes the `pull_request` string when the workflow is triggered by a pull request event.
167
+
The subject claim includes the `pull_request` string when the workflow is triggered by a pull request event, but only if the job doesn't reference an environment.
168
168
169
169
You can configure a subject that filters for the [`pull_request`](/actions/learn-github-actions/events-that-trigger-workflows#pull_request) event. In this example, the workflow run must have been triggered by a `pull_request` event in a repository named `octo-repo` that is owned by the `octo-org` organization:
Copy file name to clipboardExpand all lines: content/actions/hosting-your-own-runners/about-self-hosted-runners.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,16 @@ versions:
12
12
type: overview
13
13
---
14
14
15
-
{% data reusables.actions.ae-self-hosted-runners-notice %}
16
15
{% data reusables.actions.enterprise-beta %}
17
16
{% data reusables.actions.enterprise-github-hosted-runners %}
18
17
19
18
## About self-hosted runners
20
19
21
-
{% data reusables.actions.self-hosted-runner-description %} Self-hosted runners can be physical, virtual, in a container, on-premises, or in a cloud.
20
+
A self-hosted runner is a system that you deploy and manage to execute jobs from {% data variables.product.prodname_actions %} on {% ifversion ghae or ghec %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For more information about {% data variables.product.prodname_actions %}, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions){% ifversion fpt %}."{% elsif ghec or ghes or ghae %}" and "[About {% data variables.product.prodname_actions %} for enterprises](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)."{% endif %}
21
+
22
+
{% data reusables.actions.self-hosted-runner-description %} {% data reusables.actions.self-hosted-runner-locations %}
23
+
24
+
{% data reusables.actions.self-hosted-runner-architecture %} {% data reusables.actions.runner-app-open-source %} When a new version is released, the runner application automatically updates itself when a job is assigned to the runner, or within a week of release if the runner hasn't been assigned any jobs.
22
25
23
26
You can add self-hosted runners at various levels in the management hierarchy:
24
27
- Repository-level runners are dedicated to a single repository.
@@ -59,7 +62,7 @@ You can use any machine as a self-hosted runner as long at it meets these requir
59
62
* The machine has enough hardware resources for the type of workflows you plan to run. The self-hosted runner application itself only requires minimal resources.
60
63
* If you want to run workflows that use Docker container actions or service containers, you must use a Linux machine and Docker must be installed.
61
64
62
-
{% ifversion fpt or ghes > 3.2 or ghec %}
65
+
{% ifversion fpt or ghes > 3.2 or ghec or ghae-issue-4462 %}
63
66
## Autoscaling your self-hosted runners
64
67
65
68
You can automatically increase or decrease the number of self-hosted runners in your environment in response to the webhook events you receive. For more information, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)."
@@ -133,12 +136,7 @@ The self-hosted runner polls {% data variables.product.product_name %} to retrie
133
136
134
137
{% data reusables.actions.self-hosted-runner-ports-protocols %}
135
138
136
-
{% ifversion ghae %}
137
-
You must ensure that the self-hosted runner has appropriate network access to communicate with the {% data variables.product.prodname_ghe_managed %} URL and its subdomains.
138
-
For example, if your instance name is `octoghae`, then you will need to allow the self-hosted runner to access `octoghae.githubenterprise.com`, `api.octoghae.githubenterprise.com`, and `codeload.octoghae.githubenterprise.com`.
139
-
140
-
If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/organizations/keeping-your-organization-secure/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)."
141
-
{% endif %}
139
+
{% data reusables.actions.self-hosted-runner-communications-for-ghae %}
142
140
143
141
{% ifversion fpt or ghec %}
144
142
@@ -242,3 +240,11 @@ Untrusted workflows running on your self-hosted runner pose significant security
242
240
* Persisting unwanted or dangerous data on the machine.
243
241
244
242
For more information about security hardening for self-hosted runners, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)."
243
+
244
+
{% ifversion ghec or ghes or ghae %}
245
+
246
+
## Further reading
247
+
248
+
- "[Getting started with self-hosted runners for your enterprise](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise)"
Copy file name to clipboardExpand all lines: content/actions/hosting-your-own-runners/adding-self-hosted-runners.md
+29-18Lines changed: 29 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,6 @@ type: tutorial
13
13
shortTitle: Add self-hosted runners
14
14
---
15
15
16
-
{% data reusables.actions.ae-self-hosted-runners-notice %}
17
16
{% data reusables.actions.enterprise-beta %}
18
17
{% data reusables.actions.enterprise-github-hosted-runners %}
19
18
@@ -33,6 +32,16 @@ For more information, see "[About self-hosted runners](/github/automating-your-w
33
32
{% endwarning %}
34
33
{% endif %}
35
34
35
+
{% ifversion fpt or ghec or ghes > 3.2 %}
36
+
37
+
You can set up automation to scale the number of self-hosted runners. For more information, see "[Autoscaling with self-hosted runners](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)."
38
+
39
+
{% endif %}
40
+
41
+
## Prerequisites
42
+
43
+
{% data reusables.actions.self-hosted-runners-prerequisites %}
44
+
36
45
## Adding a self-hosted runner to a repository
37
46
38
47
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)."
@@ -53,6 +62,8 @@ You can add self-hosted runners to a single repository. To add a self-hosted run
53
62
{% endif %}
54
63
{% data reusables.actions.self-hosted-runner-check-installation-success %}
55
64
65
+
For more information, see "[Monitoring and troubleshooting self-hosted runners](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners)."
66
+
56
67
## Adding a self-hosted runner to an organization
57
68
58
69
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)."
@@ -71,39 +82,31 @@ You can add self-hosted runners at the organization level, where they can be use
71
82
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 %}
72
83
{% data reusables.actions.self-hosted-runner-configure %}
73
84
{% endif %}
74
-
75
85
{% data reusables.actions.self-hosted-runner-check-installation-success %}
76
86
87
+
For more information, see "[Monitoring and troubleshooting self-hosted runners](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners)."
88
+
77
89
{% data reusables.actions.self-hosted-runner-public-repo-access %}
78
90
79
91
## Adding a self-hosted runner to an enterprise
80
92
81
93
{% ifversion fpt %}If you use {% data variables.product.prodname_ghe_cloud %}, you{% elsif ghec or ghes or ghae %}You{% endif %} can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. The organization admins are then able to control which repositories can use it. {% ifversion fpt %}For more information, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-enterprise).{% endif %}
82
94
83
95
{% ifversion ghec or ghes or ghae %}
84
-
85
96
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)."
86
97
87
98
{% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
88
-
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 endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runners).
89
99
90
-
{% data reusables.enterprise-accounts.access-enterprise %}
91
-
{% data reusables.enterprise-accounts.policies-tab %}
92
-
{% data reusables.enterprise-accounts.actions-tab %}
93
-
{% data reusables.enterprise-accounts.actions-runners-tab %}
94
-
1. Click **New runner**.
95
-
{% data reusables.actions.self-hosted-runner-configure %}
96
-
{% elsif ghae or ghes < 3.4 %}
97
-
To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator.
98
-
{% data reusables.enterprise-accounts.access-enterprise %}
99
-
{% data reusables.enterprise-accounts.policies-tab %}
100
-
{% data reusables.enterprise-accounts.actions-tab %}
101
-
{% data reusables.enterprise-accounts.actions-runners-tab %}
102
-
1. Click **Add new**, then click **New runner**.
103
-
{% data reusables.actions.self-hosted-runner-configure %}
100
+
To add a self-hosted runner to an enterprise, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runners).
101
+
104
102
{% endif %}
103
+
104
+
{% data reusables.actions.self-hosted-runner-add-to-enterprise %}
105
+
105
106
{% data reusables.actions.self-hosted-runner-check-installation-success %}
106
107
108
+
For more information, see "[Monitoring and troubleshooting self-hosted runners](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners)."
109
+
107
110
{% data reusables.actions.self-hosted-runner-public-repo-access %}
108
111
109
112
### Making enterprise runners available to repositories
@@ -114,3 +117,11 @@ To make an enterprise-level self-hosted runner group available to an organizatio
114
117
115
118
For more information on changing runner group access settings, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."
116
119
{% endif %}
120
+
121
+
{% ifversion ghec or ghes or ghae %}
122
+
123
+
## Further reading
124
+
125
+
- "[Getting started with self-hosted runners for your enterprise](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise)"
0 commit comments