Skip to content

Develop #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 26, 2020
Merged

Develop #22

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dbb6c90
Better docs
Jul 26, 2020
96195df
Better docs
Jul 26, 2020
82078d0
Better docs
MonolithProjects Jul 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,10 @@
[![GitHub Actions](https://github.com/MonolithProjects/ansible-github_actions_runner/workflows/molecule%20test/badge.svg?branch=master)](https://github.com/MonolithProjects/ansible-github_actions_runner/actions)
[![License](https://img.shields.io/github/license/MonolithProjects/ansible-github_actions_runner)](https://github.com/MonolithProjects/ansible-github_actions_runner/blob/master/LICENSE)

This role will deploy or redeploy or uninstall and register or unregister local GitHub Actions Runner.
This role will deploy/redeploy/uninstall and register/unregister local GitHub Actions Runner.

## Requirements

* Supported Linux distros:
* CentOS/RHEL 7,8
* Debian 9,10
* Fedora 32,31,30,29,28
* Ubuntu 16,18,20

**Note:** Fedora 32 and Ubuntu 20 must use Ansible 2.9.8+. Other distros/releases will work also with older 2.8.0+ Ansible.

* System must have access to the GitHub.

* The role require Personal Access Token for the GitHub user. The token has to be a value of `PERSONAL_ACCESS_TOKEN` variable.
Expand All @@ -31,6 +23,14 @@ Personal Access Token for GitHub account can be created [here](https://github.co
* CentOS systems require EPEL repository.
Recommended role: `robertdebock.epel`

* Weekly tested on:
* CentOS/RHEL 7,8
* Debian 9,10
* Fedora 31,32
* Ubuntu 16,18,20

**Note:** Fedora 32 and Ubuntu 20 must use Ansible 2.9.8+. Other distros/releases will work also with older 2.8.0+ Ansible.

## Role Variables

This is a copy from `defaults/main.yml`
Expand Down Expand Up @@ -64,7 +64,7 @@ github_server: "https://github.com"
# github_repo: "yourrepo"
```

## Example Playbook
## Example Playbook

In this example the role will deploy (or redeploy) the GitHub Actions runner service (latest available version) and register the runner for the GitHub repo.
Runner service will run under the same user as the Ansible is using for ssh connection (*ansible*).
Expand All @@ -82,7 +82,7 @@ Runner service will run under the same user as the Ansible is using for ssh conn
- role: monolithprojects.github_actions_runner
```

In this example the role will deploy (or redeploy) the GitHub Actions runner service (version 2.165.2) and register the runner for the GitHub repo.
In this example the role will deploy (or redeploy) the GitHub Actions runner service (version 2.165.2) and register the runner for the GitHub repo. Runner service will run under the used `runner-user`.

```yaml
---
Expand All @@ -98,7 +98,7 @@ In this example the role will deploy (or redeploy) the GitHub Actions runner ser
- role: monolithprojects.github_actions_runner
```

By using tag `uninstall`, GitHub Actions runner will be removed from the host and unregistered from the GitHub.
By using tag `uninstall`, GitHub Actions runner will be removed from the host and unregistered from the GitHub repository.

```bash
ansible-playbook playbook.yml --tags uninstall
Expand Down