Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romnn/github-actions-runner-launcher
automatic setup and registration of bare-metal GitHub actions runner instances.
https://github.com/romnn/github-actions-runner-launcher
action-runners actions bare-metal ci cloud-native devops github provisioning runners self-hosted setup
Last synced: about 1 month ago
JSON representation
automatic setup and registration of bare-metal GitHub actions runner instances.
- Host: GitHub
- URL: https://github.com/romnn/github-actions-runner-launcher
- Owner: romnn
- License: mit
- Created: 2020-05-07T10:47:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-09T14:21:11.000Z (over 4 years ago)
- Last Synced: 2024-06-20T06:26:58.367Z (6 months ago)
- Topics: action-runners, actions, bare-metal, ci, cloud-native, devops, github, provisioning, runners, self-hosted, setup
- Language: Go
- Homepage:
- Size: 55.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## github-actions-runner-launcher
[](https://travis-ci.com/romnnn/github-actions-runner-launcher)
[](https://github.com/romnnn/github-actions-runner-launcher)
[](https://godoc.org/github.com/romnnn/github-actions-runner-launcher) [](https://hub.docker.com/r/romnn/github-actions-runner-launcher) [](https://codecov.io/gh/romnnn/github-actions-runner-launcher)
[](https://github.com/romnnn/github-actions-runner-launcher/releases/latest)
Automatic setup and registration of GitHub actions runner instances. If you have tried [github.com/myoung34/docker-github-actions-runner](https://github.com/myoung34/docker-github-actions-runner) or similiar options for running the action runners as docker containers for the convenience, but want to run them on bare-metal, this is just right for you!
Configuration works just like with docker-compose as shown in this `sample.yml`:
```yaml
version: '3.3'
services:
my-runner:
environment:
REPO_URL: https://github.com/my-org/repo
# Use access token to automatically obtain runner tokens from the github API (see 1.)
ACCESS_TOKEN:
# The runner token must be specified otherwise (see 2.)
RUNNER_TOKEN:
RUNNER_NAME: my-runner
RUNNER_WORKDIR: /my/runners/work/dir
ORG_RUNNER: "false"
ORG_NAME: my-org
LABELS: linux,x64
```
**Important notes**:
1. Youy can obtain an access token to automatically create `RUNNER_TOKEN`s for you with the GitHub API. You can create a token at [https://github.com/settings/tokens](https://github.com/settings/tokens). When you want the runners to work with public repos only, choose the `public_repo` scope, otherwise choose the `repo` scope. Always remember to keep the token and your runner config private!
2. You can get a new `RUNNER_TOKEN` at [https://github.com/organizations/my-org/settings/actions/add-new-runner](https://github.com/organizations/my-org/settings/actions/add-new-runner). Note that you only have to copy the token used for `./config.sh`.
You can then start with
```bash
GO111MODULE=on go get -u github.com/romnnn/github-actions-runner-launcher/cmd/github-actions-runner-launcher
# To install the runners dependencies, the first run needs sudo privileges
sudo github-actions-runner-launcher --config sample.yml install
github-actions-runner-launcher --config sample.yml run
```
You can also download pre built binaries from the [releases page](https://github.com/romnnn/github-actions-runner-launcher/releases), or use the `docker` image:
```bash
docker pull romnn/github-actions-runner-launcher
```
For a list of options, run with `--help`.
#### Troubleshooting
- `Failed to prepare runner: Failed to install runner dependencies: fork/exec` usually indicates that you should run the script as a binary instead of with `go run`.
#### Development
###### Prerequisites
Before you get started, make sure you have installed the following tools::
$ python3 -m pip install -U cookiecutter>=1.4.0
$ python3 -m pip install pre-commit bump2version invoke ruamel.yaml halo
$ go get -u golang.org/x/tools/cmd/goimports
$ go get -u golang.org/x/lint/golint
$ go get -u github.com/fzipp/gocyclo
$ go get -u github.com/mitchellh/gox # if you want to test building on different architectures
**Remember**: To be able to excecute the tools downloaded with `go get`,
make sure to include `$GOPATH/bin` in your `$PATH`.
If `echo $GOPATH` does not give you a path make sure to run
(`export GOPATH="$HOME/go"` to set it). In order for your changes to persist,
do not forget to add these to your shells `.bashrc`.
With the tools in place, it is strongly advised to install the git commit hooks to make sure checks are passing in CI:
```bash
invoke install-hooks
```
You can check if all checks pass at any time:
```bash
invoke pre-commit
```
Note for Maintainers: After merging changes, tag your commits with a new version and push to GitHub to create a release:
```bash
bump2version (major | minor | patch)
git push --follow-tags
```
#### Note
This project is still in the alpha stage and should not be considered production ready.