add enterprise support

Author: danielefranceschi

README.md

@@ -9,7 +9,7 @@
 
 
 This role will deploy/redeploy/uninstall and register/unregister local GitHub Actions Runner on Linux and macOS Systems (see [compatibility list](#supported-operating-systems) ).
-It supports both, Organization and Repository Runners.
+It supports Enterprise, Organization and Repository Runners.
 
 ## Requirements
 
@@ -18,7 +18,8 @@ It supports both, Organization and Repository Runners.
 * The role require Personal Access Token to access the GitHub. The token can be set as `PERSONAL_ACCESS_TOKEN` environment variable.
 
 > **Note**  
-> The token must have the `repo` scope (when creating a repo runner) or the `admin:org` scope (when creating a runner for an organization).
+> The token must have the `repo` scope (when creating a repo runner), the `admin:org` scope (when creating a runner for an organization),
+> the `manage_runners:enterprise` scope (when creating a enterprise runner).
 Personal Access Token for GitHub account can be created [here](https://github.com/settings/tokens).
 
 > **Warning**  
@@ -112,6 +113,9 @@ runner_name: "{{ ansible_hostname }}"
 # Github repository name
 # github_repo: "yourrepo"
 
+# GitHub Enterprise name
+# github_enterprise: "yourenterprise"
+
 # Configuring a custom .env file
 # custom_env: |
 # http_proxy=YOUR_URL_HERE
@@ -122,7 +126,7 @@ runner_name: "{{ ansible_hostname }}"
 # HTTP_PROXY=
 ```
 
-## Example Playbook
+## Example Playbooks
 
 In this example the Ansible role will install (or update) the GitHub Actions Runner service (latest available version). The runner will be registered for *my_awesome_repo* GitHub repo.
 Runner service will be stated and will run under the same user as the Ansible is using for ssh connection (*ansible*).
@@ -156,6 +160,20 @@ Same example as above, but runner will be added to an organization and deployed
     - role: monolithprojects.github_actions_runner
 ```
 
+If you have a Github Enterprise Cloud license and you want to manage all the self-hosted runners from the enterprise:
+```yaml
+---
+- name: Install GitHub Actions Runner
+  hosts: all
+  user: automation
+  become: yes
+  vars:
+    - github_enterprise: my_awesome_enterprise
+    - runner_org: no
+  roles:
+    - role: monolithprojects.github_actions_runner
+```
+
 In this example the Ansible role will deploy (or update) the GitHub Actions runner service (version 2.165.2) and register the runner for the GitHub repo. Runner service will run under the user `runner-user`. Runner will be registered with two labels.
 The runner service will be *stopped* and disabled. Runner will use custom environment variables (from file named `.env` in the self-hosted runner application directory).
 

defaults/main.yml

@@ -54,6 +54,9 @@ runner_name: "{{ ansible_hostname }}"
 # Github repository name
 # github_repo: "yourrepo"
 
+# GitHub Enterprise name
+# github_enterprise: "yourenterprise"
+
 # Configuring a custom .env file
 # custom_env: |
 # http_proxy=YOUR_URL_HERE

tasks/assert.yml

@@ -5,6 +5,7 @@
       - github_account is defined
     fail_msg: "github_account is not defined"
   run_once: true
+  when: not github_enterprise
 
 - name: Check access_token variable (RUN ONCE)
   ansible.builtin.assert:
@@ -20,6 +21,7 @@
       - runner_org | bool == True or runner_org == False
     fail_msg: "runner_org should be a boolean value"
   run_once: true
+  when: not github_enterprise
 
 - name: Check github_repo variable (RUN ONCE)
   ansible.builtin.assert:
@@ -28,4 +30,4 @@
       - github_repo | length > 0
     fail_msg: "github_repo was not found or is using an invalid format."
   run_once: true
-  when: not runner_org
+  when: not runner_org and not github_enterprise

tasks/collect_info.yml

@@ -5,12 +5,17 @@
   - name: Set complete API url for repo runner
     ansible.builtin.set_fact:
       github_full_api_url: "{{ github_api_url }}/repos/{{ github_owner | default(github_account) }}/{{ github_repo }}/actions/runners"
-    when: not runner_org
+    when: not runner_org and not runner_enterprise
 
   - name: Set complete API url for org runner
     ansible.builtin.set_fact:
       github_full_api_url: "{{ github_api_url }}/orgs/{{ github_owner | default(github_account) }}/actions/runners"
-    when: runner_org | bool
+    when: runner_org | bool and not runner_enterprise
+
+  - name: Set complete API url for enterprise runner
+    ansible.builtin.set_fact:
+      github_full_api_url: "{{ github_api_url }}/enterprises/{{ github_enterprise }}/actions/runners"
+    when: runner_enterprise
 
   - name: Get registration token (RUN ONCE)
     ansible.builtin.uri:
@@ -24,7 +29,7 @@
     register: registration
     run_once: true
 
-  - name: Check currently registered runners for repo (RUN ONCE)
+  - name: Check currently registered runners (RUN ONCE)
     ansible.builtin.uri:
       url: "{{ github_full_api_url }}"
       headers:

tasks/install_runner.yml

@@ -51,12 +51,17 @@
 - name: Set complete GitHub url for repo runner
   ansible.builtin.set_fact:
     github_full_url: "{{ github_url }}/{{ github_owner | default(github_account) }}/{{ github_repo }}"
-  when: not runner_org
+  when: not runner_org and not runner_enterprise
 
 - name: Set complete GitHub url for org runner
   ansible.builtin.set_fact:
     github_full_url: "{{ github_url }}/{{ github_owner | default(github_account) }}"
-  when: runner_org | bool
+  when: runner_org | bool and not runner_enterprise
+
+- name: Set complete GitHub url for enterprise runner
+  ansible.builtin.set_fact:
+    github_full_url: "{{ github_url }}/enterprises/{{ github_enterprise }}"
+  when: runner_enterprise
 
 - name: Register runner
   environment: