Skip to content
This repository has been archived by the owner on May 15, 2024. It is now read-only.

Peony-Inc/gh-runners

 
 

Repository files navigation

GitHub Actions Runner

Actions Status

The runner is the application that runs a job from a GitHub Actions workflow. It is used by GitHub Actions in the hosted virtual environments, or you can self-host the runner in your own environment.

Get Started

For more information about installing and using self-hosted runners, see Adding self-hosted runners and Using self-hosted runners in a workflow

Runner releases:

win Pre-reqs | Download

macOS Pre-reqs | Download

linux Pre-reqs | Download

Using Makefile

Create a .env file based on the example provided and provide a PAT with repo admin permissions. If you're creating runners across the org then the PAT needs org admin permissions.

> ⚠️ It is important that you do not delete the runners directory created as it will be required to remove the runners from your system background process.

Commands:

  1. make runners group=<group-here> labels=<label-here> - spawn 5 new GitHub self-hosted runners, assign runner to optional group with the required provided labels
  2. make create name=<name-here> labels=<label-here> - spawn an individual runner with specified name with the required provided labels
  3. make create-org name=<name-here> labels=<label-here> - spawn an individual runner with specified name in the defined group with the required provided labels
  4. make remove - removes all runners running as a service
  5. make delete - force deletes a runner from the service
  6. make clean - removes runners directory

Contribute

We accept contributions in the form of issues and pull requests. The runner typically requires changes across the entire system and we aim for issues in the runner to be entirely self contained and fixable here. Therefore, we will primarily handle bug issues opened in this repo and we kindly request you to create all feature and enhancement requests on the GitHub Feedback page. Read more about our guidelines here before contributing.

Releases

No releases published

Packages

No packages published

Languages

  • C# 95.0%
  • JavaScript 3.6%
  • Shell 1.3%
  • Batchfile 0.1%
  • TypeScript 0.0%
  • Dockerfile 0.0%