👌 IMPROVE: Update to GH Actions (#4)

Author: chrisjsewell

.ansible-lint

@@ -0,0 +1,5 @@
+# use `# noqa xxx` at the end of a line, to ignore a particular error
+# or add to the warn_list, to ignore for the whole project
+warn_list:
+- '208'  # File permissions unset or incorrect
+- '503'  # Tasks that run when changed should likely be handlers

.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+    tags:
+    - 'v*'
+  pull_request:
+
+env:
+  galaxy-name: "marvel-nccr.yambo"
+
+jobs:
+
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+    - uses: pre-commit/action@v2.0.0
+
+  molecule:
+
+    strategy:
+      matrix:
+        distro: [ubuntu1604, ubuntu1804, ubuntu2004]
+      fail-fast: false
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - uses: actions/checkout@v2
+      with:
+        path: ${{ env.galaxy-name }}
+
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Upgrade pip
+      run: |
+        pip install --upgrade pip
+        pip --version
+
+    - name: Install requirements
+      run: |
+        pip install wheel
+        pip install -r requirements.txt
+      working-directory: ${{ env.galaxy-name }}
+
+    - name: Run molecule
+      run: molecule test
+      working-directory: ${{ env.galaxy-name }}
+      env:
+        MOLECULE_DISTRO: ${{ matrix.distro }}
+
+  release:
+    name: Publish to ansible-galaxy
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+    needs: [pre-commit, molecule]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: robertdebock/galaxy-action@1.0.3
+      with:
+        galaxy_api_key: ${{ secrets.GALAXY_API_KEY }}

.gitignore

@@ -1 +1,5 @@
 *.swp
+.DS_Store
+.galaxy_install_info
+.vscode/
+.tox/

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+# For use with pre-commit.
+# See usage instructions at https://pre-commit.com
+repos:
+
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v1.5.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, "2", --preserve-quotes]
+
+- repo: https://github.com/adrienverge/yamllint
+  rev: v1.25.0
+  hooks:
+  - id: yamllint
+
+- repo: https://github.com/ansible/ansible-lint
+  rev: v4.3.5
+  hooks:
+  - id: ansible-lint

.travis.yml

@@ -0,0 +1,9 @@
+extends: default
+rules:
+  document-start: disable
+  line-length:
+    max: 200
+    level: warning
+  indentation:
+    spaces: 2
+    indent-sequences: false

.yamllint

@@ -1,3 +1,7 @@
+[![CI](https://github.com/marvel-nccr/ansible-role-yambo/workflows/CI/badge.svg)](https://github.com/marvel-nccr/ansible-role-yambo/actions)
+[![Ansible Role](https://img.shields.io/ansible/role/25529.svg)](https://galaxy.ansible.com/marvel-nccr/yambo)
+[![Release](https://img.shields.io/github/tag/marvel-nccr/ansible-role-yambo.svg)](https://github.com/marvel-nccr/ansible-role-yambo/releases)
+
 # Ansible Role: marvel-nccr.yambo
 
 An ansible role that installs [yambo](http://www.yambo-code.org/) on Ubuntu.
@@ -12,12 +16,54 @@ See `defaults/main.yml`
 
 ## Example Playbook
 
+```yaml
+- hosts: servers
+  roles:
+  - role: marvel-nccr.yambo
+```
+
+## Development and testing
+
+This role uses [Molecule](https://molecule.readthedocs.io/en/latest/#) and [Docker](https://www.docker.com/) for tests.
+
+After installing [Docker](https://www.docker.com/):
+
+Clone the repository into a package named `marvel-nccr.yambo` (the folder must be named the same as the Ansible Galaxy name)
+
+```bash
+git clone https://github.com/marvel-nccr/ansible-role-yambo marvel-nccr.yambo
+cd marvel-nccr.yambo
+```
+
+Then run:
+
+```bash
+pip install -r requirements.txt  # Installs molecule
+molecule test  # runs tests
 ```
-  - hosts: servers
-    roles:
-    - role: marvel-nccr.yambo
+
+or use tox (see `tox.ini`):
+
+```bash
+pip install tox
+tox
 ```
 
+## Code style
+
+Code style is formatted and linted with [pre-commit](https://pre-commit.com/).
+
+```bash
+pip install pre-commit
+pre-commit run -all
+```
+
+## Deployment
+
+Deployment to Ansible Galaxy is automated *via* GitHub Actions.
+Simply tag a release `vX.Y.Z` to initiate the CI and release workflow.
+Note, the release will only complete if the CI tests pass.
+
 ## License
 
 MIT

.yamllint.yml

@@ -1,4 +1,3 @@
----
 yambo_version: "4.5.2"
 yambo_src: yambo-{{ yambo_version }}
 yambo_src_archive: "{{ yambo_src }}.tar.gz"
@@ -7,14 +6,14 @@ yambo_prefix: "/usr/local"
 yambo_url: "https://github.com/yambo-code/yambo/archive/{{ yambo_version }}.tar.gz"
 yambo_topdir: "{{ yambo_code_folder }}/{{yambo_src}}"
 yambo_executables:
-  - name: yambo
-    folder: "{{ yambo_prefix }}/bin"
-    plugin: yambo.yambo
-    version: "{{ yambo_version }}"
-  - name: p2y
-    folder: "{{ yambo_prefix }}/bin"
-    plugin: yambo.yambo
-    version: "{{ yambo_version }}"
-  - name: ypp
-    folder: "{{ yambo_prefix }}/bin"
-    version: "{{ yambo_version }}"
+- name: yambo
+  folder: "{{ yambo_prefix }}/bin"
+  plugin: yambo.yambo
+  version: "{{ yambo_version }}"
+- name: p2y
+  folder: "{{ yambo_prefix }}/bin"
+  plugin: yambo.yambo
+  version: "{{ yambo_version }}"
+- name: ypp
+  folder: "{{ yambo_prefix }}/bin"
+  version: "{{ yambo_version }}"

README.md

@@ -1,4 +1,3 @@
----
 allow_duplicates: false
 
 galaxy_info:
@@ -8,11 +7,11 @@ galaxy_info:
   license: MIT
   min_ansible_version: 2.7
   platforms:
-    - name: Ubuntu
-      versions:
-        - xenial
-        - bionic
+  - name: Ubuntu
+    versions:
+    - xenial
+    - bionic
   galaxy_tags:
-    - ubuntu
-    - application
-    - science
+  - ubuntu
+  - application
+  - science