move login from bash to puppet, add more info to readme, tag 0.1.2rc

Author: shimon

README.md

@@ -1,26 +1,44 @@
 # GitHub Actions Runner
 
-This module is designed to auto configure all requirements to have the GitHub Actions runner  ready to run on Debian hosts.
+This module is designed to automatically configure all requirements to have the GitHub Actions runner ready to run on Debian hosts as a service.
 
 #### Table of Contents
 
 1. [Description](#description)
-
 2. [Limitations - OS compatibility, etc.](#limitations)
 3. [Development - Guide for contributing to the module](#development)
 
-## Description
+### Description
+
+This module will setup all of the files and configuration needed for GitHub Actions runner to work on any Debian 9 hosts.
+
+
+#### hiera configuration
 
-This module will setup all of the file and configuration needed for GitHub Actions runner to  work on any Debian host.
+This module supports configuration through hiera. The following example
+creates repository level Actions runners. 
+```yaml
+github_actions_runner::ensure: present
+github_actions_runner::base_dir_name: '/data/actions-runner'
+github_actions_runner::package_name: 'actions-runner-linux-x64'
+github_actions_runner::package_ensure: '2.272.0'
+github_actions_runner::repository_url: 'https://github.com/actions/runner/releases/download'
+github_actions_runner::org_name: 'github_org'
+github_actions_runner::personal_access_token: 'PAT'
+github_actions_runner::user: 'root'
+github_actions_runner::group: 'root'
+github_actions_runner::labels:
+  - self-hosted-custom
+```
 
-## Limitations
+### Limitations
 
 Tested on Debian 9 stretch hosts only.
-full  operating systems support as describe in `metadata.json` file.
+full list of operating systems support and requirements are described in `metadata.json` file.
 
 
 If you don't specify repository name , make sure you `Personal Access Token` is org level admin.
 
-## Development
+### Development
 
 This module development should be just like any other puppet modules.

manifests/init.pp

@@ -63,6 +63,20 @@
 
   $root_dir = "${github_actions_runner::base_dir_name}-${github_actions_runner::package_ensure}"
 
+  if $github_actions_runner::labels {
+    $flattend_labels_list=join($github_actions_runner::labels, ',')
+    $assured_labels="--labels ${flattend_labels_list}"
+  }
+
+  if $github_actions_runner::repo_name {
+    $url="https://github.com/${github_actions_runner::org_name}/${github_actions_runner::repo_name}"
+    $token_url="https://api.github.com/repos/${github_actions_runner::org_name}/${github_actions_runner::repo_name}/actions/runners/registration-token"
+  }
+  else {
+    $url="https://github.com/${github_actions_runner::org_name}"
+    $token_url="https://api.github.com/repos/${github_actions_runner::org_name}/actions/runners/registration-token"
+  }
+
   class { '::github_actions_runner::config': }
   -> class { '::github_actions_runner::install': }
   ~> class { '::github_actions_runner::service': }

metadata.json

@@ -1,6 +1,6 @@
 {
-  "name": "github_actions_runner",
-  "version": "0.1.1",
+  "name": "tuenti-github_actions_runner",
+  "version": "0.1.2",
   "author": "Shimon Ohayon",
   "summary": "Module to configure our GitHub Actions runner on Debian hosts",
   "license": "Apache-2.0",

spec/classes/github_actions_runner_spec.rb

@@ -55,11 +55,24 @@
         end
       end
 
-      context 'is expected to create a github_actions_runner installation script with content' do
+      context 'is expected to create a github_actions_runner installation script with config in content' do
         it do
           is_expected.to contain_file('/tmp/actions-runner-1.0.1/configure_install_runner.sh').with_content(/\/tmp\/actions-runner-1.0.1\/config.sh/)
         end
       end
+
+      context 'is expected to create a github_actions_runner installation script with repo url in content' do
+        it do
+          is_expected.to contain_file('/tmp/actions-runner-1.0.1/configure_install_runner.sh').with_content(/https:\/\/github.com\/test_org\/test_repo/)
+        end
+      end
+
+      context 'is expected to create a github_actions_runner installation script with labels in content' do
+        it do
+          is_expected.to contain_file('/tmp/actions-runner-1.0.1/configure_install_runner.sh').with_content(/test_label1,test_label2/)
+        end
+      end
+
     end
   end
 end

templates/configure_install_runner.sh.epp

@@ -2,33 +2,18 @@
 # Configure the action runner after the package file has been downloaded.
 set -e
 
-#Set URL's
-URL="https://github.com/<%= $github_actions_runner::org_name %>"
-TOKEN_URL="https://api.github.com/orgs/<%= $github_actions_runner::org_name %>/actions/runners/registration-token"
-
-<% if $github_actions_runner::repo_name { -%>
-  URL="https://github.com/<%= $github_actions_runner::org_name %>/<%= $github_actions_runner::repo_name %>"
-  TOKEN_URL="https://api.github.com/repos/<%= $github_actions_runner::org_name %>/<%= $github_actions_runner::repo_name %>/actions/runners/registration-token"
-<% } -%>
-
-# Set labels if defined
-<% if $github_actions_runner::labels { -%>
-  LABELS="--labels <%= $github_actions_runner::labels.join(',') %>"
-<% } -%>
-
 # Get registration token.
 TOKEN=$(curl -s -XPOST                                                             \
     -H "authorization: token <%= $github_actions_runner::personal_access_token %>" \
-    ${TOKEN_URL} | jq -r .token)
+    <%= $github_actions_runner::token_url %> | jq -r .token)
 
 # Allow root
 export RUNNER_ALLOW_RUNASROOT=true
 
 
-
 # (Optional) Remove previous config.
 <%= $github_actions_runner::root_dir %>/config.sh remove       \
-  --url ${URL}                                                 \
+  --url <%= $github_actions_runner::url %>                     \
   --token ${TOKEN}                                             \
   --name <%= $github_actions_runner::hostname %> &>/dev/null
 
@@ -38,9 +23,9 @@ export RUNNER_ALLOW_RUNASROOT=true
   --unattended                                                 \
   --replace                                                    \
   --name <%= $github_actions_runner::hostname %>               \
-  --url ${URL}                                                 \
+  --url <%= $github_actions_runner::url %>                     \
   --token ${TOKEN}                                             \
-  ${LABELS} &>/dev/null
+  <%= $github_actions_runner::assured_labels %> &>/dev/null
 
 # Copy service endpoint script.
 if [ ! -f <%= $github_actions_runner::root_dir %>/runsvc.sh ]; then