Skip to content

Commit 5094fff

Browse files
docs: edit README
1 parent 6ae9b84 commit 5094fff

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,14 @@
88
[![License](https://img.shields.io/github/license/MonolithProjects/ansible-github_actions_runner)](https://github.com/MonolithProjects/ansible-github_actions_runner/blob/main/LICENSE)
99

1010

11-
This role will deploy/redeploy/uninstall and register/unregister local GitHub Actions Runner.
11+
This role will deploy/redeploy/uninstall and register/unregister local GitHub Actions Runner on Linux and macOS Systems (see [compatibility list](#supported-operating-systems) ).
1212
It supports both, Organization and Repository Runners.
1313

1414
## Requirements
1515

16-
* System must have access to the GitHub.
16+
* System must have access to the GitHub API.
1717

18-
* The role require Personal Access Token to access the GitHub. The token has to be a value of `PERSONAL_ACCESS_TOKEN` variable.
19-
Export the token to the local host environment.
18+
* The role require Personal Access Token to access the GitHub. The token can be set as `PERSONAL_ACCESS_TOKEN` environment variable.
2019

2120
> **Note**
2221
> The token must have the `repo` scope (when creating a repo runner) or the `admin:org` scope (when creating a runner for an organization).
@@ -31,19 +30,27 @@ Personal Access Token for GitHub account can be created [here](https://github.co
3130
* CentOS systems require EPEL repository.
3231
Recommended role: `robertdebock.epel`
3332

34-
## Supported CPU architecture:
33+
## Supported CPU architecture
3534

3635
* ARM, ARM64 (dependencies installation is not covered by this role)
3736
* AMD64, x86_64
37+
38+
## Supported Operating Systems
39+
40+
* Red Hat Enterprise Linux 7
41+
* CentOS 7
42+
* Rocky Linux 8+
43+
* Fedora 29+
44+
* Debian 9+
45+
* Ubuntu 16.04+
46+
* macOS High Sierra +
3847
## Weekly tested on:
3948

4049
* Debian 11
4150
* Fedora 37
4251
* Rocky Linux 8
4352
* Ubuntu 20,22
4453

45-
**Note:** Fedora 32+ and Ubuntu 20 must use Ansible 2.9.8+. Other distros/releases will work also with older 2.8.0+ Ansible.
46-
4754
## Role Variables
4855

4956
This is a copy from `defaults/main.yml`

0 commit comments

Comments
 (0)