|
1 | 1 | # On-demand self-hosted AWS EC2 runner for GitHub Actions |
2 | 2 |
|
| 3 | +⚠️ If you like the project, please consider [supporting Ukraine](https://bit.ly/3KeY7dc) in a [war](https://en.wikipedia.org/wiki/2022_Russian_invasion_of_Ukraine) against russian occupants. Any help would be much appreciated! |
| 4 | + |
| 5 | +[<img src="https://user-images.githubusercontent.com/2857712/156607570-8c9fd15b-8b44-41b3-bec3-312267af324f.png" width="500">](https://supportukrainenow.org) |
| 6 | + |
| 7 | +(image by [Nina Dzyvulska](https://www.behance.net/ninadz)) |
| 8 | + |
| 9 | +--- |
| 10 | + |
3 | 11 | [](https://github.com/jonico/awesome-runners) |
4 | 12 |
|
5 | 13 | Start your EC2 [self-hosted runner](https://docs.github.com/en/free-pro-team@latest/actions/hosting-your-own-runners) right before you need it. |
@@ -193,6 +201,7 @@ Now you're ready to go! |
193 | 201 | | `ec2-instance-id` | Required if you use the `stop` mode. | EC2 Instance Id of the created runner. <br><br> The id is provided by the output of the action in the `start` mode. <br><br> The id is used to terminate the EC2 instance when the runner is not needed anymore. | |
194 | 202 | | `iam-role-name` | Optional. Used only with the `start` mode. | IAM role name to attach to the created EC2 runner. <br><br> This allows the runner to have permissions to run additional actions within the AWS account, without having to manage additional GitHub secrets and AWS users. <br><br> Setting this requires additional AWS permissions for the role launching the instance (see above). | |
195 | 203 | | `aws-resource-tags` | Optional. Used only with the `start` mode. | Specifies tags to add to the EC2 instance and any attached storage. <br><br> This field is a stringified JSON array of tag objects, each containing a `Key` and `Value` field (see example below). <br><br> Setting this requires additional AWS permissions for the role launching the instance (see above). | |
| 204 | +| `runner-home-dir` | Optional. Used only with the `start` mode. | Specifies a directory where pre-installed actions-runner software and scripts are located.<br><br> | |
196 | 205 |
|
197 | 206 | ### Environment variables |
198 | 207 |
|
@@ -235,7 +244,7 @@ jobs: |
235 | 244 | aws-region: ${{ secrets.AWS_REGION }} |
236 | 245 | - name: Start EC2 runner |
237 | 246 | id: start-ec2-runner |
238 | | - uses: machulav/ec2-github-runner@v2.2.0 |
| 247 | + uses: machulav/ec2-github-runner@v2 |
239 | 248 | with: |
240 | 249 | mode: start |
241 | 250 | github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }} |
@@ -271,7 +280,7 @@ jobs: |
271 | 280 | aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} |
272 | 281 | aws-region: ${{ secrets.AWS_REGION }} |
273 | 282 | - name: Stop EC2 runner |
274 | | - uses: machulav/ec2-github-runner@v2.2.0 |
| 283 | + uses: machulav/ec2-github-runner@v2 |
275 | 284 | with: |
276 | 285 | mode: stop |
277 | 286 | github-token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }} |
|
0 commit comments