Merge pull request #67 from MonolithProjects/develop

Change the way how to set labels

Author: MonolithProjects

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Pull Request Template
+
+## Description
+
+Please include a summary of the change and which issue is fixed.
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes.
+
+## Destination branch
+
+Create a PR into `develop` branch

.github/PULL_REQUEST_TEMPLATE.md

@@ -4,8 +4,8 @@
 [![Galaxy Quality](https://img.shields.io/ansible/quality/47375?style=flat&logo=ansible)](https://galaxy.ansible.com/monolithprojects/github_actions_runner)
 [![Role version](https://img.shields.io/github/v/release/MonolithProjects/ansible-github_actions_runner)](https://galaxy.ansible.com/monolithprojects/github_actions_runner)
 [![Role downloads](https://img.shields.io/ansible/role/d/47375)](https://galaxy.ansible.com/monolithprojects/github_actions_runner)
-[![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)
+[![GitHub Actions](https://github.com/MonolithProjects/ansible-github_actions_runner/workflows/molecule%20test/badge.svg?branch=main)](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/main/LICENSE)
 
 
 This role will deploy/redeploy/uninstall and register/unregister local GitHub Actions Runner.  
@@ -82,8 +82,8 @@ runner_org: no
 # Name to assign to this runner in GitHub (System hostname as default)
 runner_name: "{{ ansible_hostname }}"
 
-# Labels to apply to the runner. For examle "'label1','label2'"
-runner_labels: "''"
+# Labels to apply to the runner
+runner_labels: []
 
 # Custom service name when usign Github Enterprise server
 # service_name: actions.runner._services.{{ runner_name }}.service
@@ -131,8 +131,8 @@ Same example as above, but runner will be added to an organization.
     - 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`.
-The runner service will be *stopped*.
+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.
 
 ```yaml
 ---
@@ -145,6 +145,9 @@ The runner service will be *stopped*.
     - github_account: github-access-user
     - github_repo: my_awesome_repo
     - runner_state: "stopped"
+    - runner_labels:
+        - production
+        - west
   roles:
     - role: monolithprojects.github_actions_runner
 ```

README.md

@@ -35,8 +35,8 @@ runner_org: no
 # Name to assign to this runner in GitHub (System hostname as default)
 runner_name: "{{ ansible_hostname }}"
 
-# Labels to apply to the runner. For examle "'label1','label2'"
-runner_labels: "''"
+# Labels to apply to the runner
+runner_labels: []
 
 # Custom service name when usign Github Enterprise server
 # service_name: actions.runner._services.{{ runner_name }}.service

defaults/main.yml

@@ -9,7 +9,9 @@
     - github_repo: ansible-github_actions_runner-testrepo
     - github_account: monolithprojects-testorg
     - runner_version: "latest"
-    - runner_labels: "'test1','test2'"
+    - runner_labels:
+        - label1
+        - repo-runner
   roles:
     - robertdebock.epel
     - ansible-github_actions_runner

molecule/default/converge.yml

@@ -6,7 +6,7 @@
   vars:
     - runner_user: ansible
     - github_repo: ansible-github_actions_runner-testrepo
-    - github_account: monolithprojects
+    - github_account: monolithprojects-testorg
     - runner_state: absent
   roles:
     - ansible-github_actions_runner

molecule/repo/cleanup.yml

@@ -9,7 +9,9 @@
     - github_repo: ansible-github_actions_runner-testrepo
     - github_account: monolithprojects-testorg
     - runner_version: "latest"
-    - runner_labels: "'test1','repo-runner'"
+    - runner_labels: 
+        - label1
+        - repo-runner
   roles:
     - robertdebock.epel
     - ansible-github_actions_runner

molecule/repo/converge.yml

@@ -77,7 +77,7 @@
 
 - name: Register runner (if new installation) for repo
   command: "{{ runner_dir }}/./config.sh --url {{ github_url }}/{{ github_owner | default(github_account) }}/{{ github_repo }} \
-            --token {{ registration.json.token }} --name {{ runner_name }} --labels {{ runner_labels }} --unattended"
+            --token {{ registration.json.token }} --name {{ runner_name }} --labels {{ runner_labels | join(',') }} --unattended"
   args:
     chdir: "{{ runner_dir }}"
   become: yes