Merge pull request #71 from MonolithProjects/main

Mysterious Ansible Galaxy issue

Author: MonolithProjects

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

@@ -31,9 +31,10 @@ cd ansible-github_actions_runner
 molecule test
 ```
 
+> You will need to edit the files in `molecule/default` directory (please do not commit those changes)
+
 ## 5. Create a pull request
 
 Please create a pull request into the `develop` branch. Here is [how to do it](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
 
-
 Please consider to [sponsor](https://github.com/sponsors/monolithprojects) me :-)

.github/PULL_REQUEST_TEMPLATE.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/workflows/galaxy.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   release:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: galaxy
         uses: robertdebock/[email protected]

.github/workflows/lint.yml

@@ -11,7 +11,7 @@ on:
         types: [opened, synchronize, reopened]
 jobs:
   lint:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
       fail-fast: true
     steps:
@@ -20,6 +20,6 @@ jobs:
         with:
           path: "${{ github.repository }}"
       - name: Molecule for Ansible - lint
-        uses: MonolithProjects/[email protected].0
+        uses: MonolithProjects/[email protected].1
         with:
           molecule_command: lint

.github/workflows/main.yml

@@ -3,41 +3,61 @@ name: molecule test
 on:
     pull_request:
         branches:
-            - master
+            - main
         types: [opened, synchronize, reopened]
     schedule:
         - cron: '0 6 * * 0'
 jobs:
   repo:
     name: Test Repo Runner
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
-      fail-fast: true
+      fail-fast: false
+      matrix:
+        config:
+          - os: "centos7"
+            tag: "latest"
+          - os: "centos8"
+            tag: "latest"
+          - os: "debian9"
+            tag: "latest"
+          - os: "debian10"
+            tag: "latest"
+          - os: "fedora33"
+            tag: "latest"
+          - os: "ubuntu18"
+            tag: "latest"
+          - os: "ubuntu20"
+            tag: "latest"
     steps:
       - name: checkout
         uses: actions/checkout@v2
         with:
           path: "${{ github.repository }}"
       - name: Molecule for Ansible - GHR Repository
-        uses: MonolithProjects/[email protected].0
+        uses: MonolithProjects/[email protected].1
         env:
           PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
         with:
+          os: ${{ matrix.config.os }}
+          tag: ${{ matrix.config.tag }}
           molecule_command: test
+          scenario: repo
+
   org:
     name: Test Org Runner
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     strategy:
-      fail-fast: true
+      fail-fast: false
     steps:
       - name: checkout
         uses: actions/checkout@v2
         with:
           path: "${{ github.repository }}"
       - name: Molecule for Ansible - GHR Organization
-        uses: MonolithProjects/[email protected].0
+        uses: MonolithProjects/[email protected].1
         env:
           PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
         with:
           molecule_command: test
-          scenario: organization
+          scenario: org

README.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.  
@@ -32,7 +32,7 @@ Personal Access Token for GitHub account can be created [here](https://github.co
 
 * ARM, ARM64 (dependencies installation is not covered by this role)
 * AMD64, x86_64
-## Weekly tested on:
+## Tested on:
 
 * CentOS/RHEL 7,8
 * Debian 9,10
@@ -83,7 +83,7 @@ runner_org: no
 runner_name: "{{ ansible_hostname }}"
 
 # Labels to apply to the runner
-runner_labels: "''"
+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
 ```

defaults/main.yml

@@ -36,7 +36,7 @@ runner_org: no
 runner_name: "{{ ansible_hostname }}"
 
 # Labels to apply to the runner
-runner_labels: "''"
+runner_labels: []
 
 # Custom service name when usign Github Enterprise server
 # service_name: actions.runner._services.{{ runner_name }}.service

handlers/main.yml

@@ -1,5 +1,5 @@
 ---
-# handlers file for ansible-github_actions_runner
+# handlers file for ansible-github_actions_runner (currently not used)
 - name: Restart runner service
   service:
    name: "{{ runner_service }}"

meta/main.yml

@@ -1,7 +1,7 @@
 ---
   galaxy_info:
     author: Michal Muransky
-    role_name: Github_Actions_runner
+    role_name: github_actions_runner
     description: Deploy Github Actions private runner
     company: MonolithProjects
     license: "license (MIT)"