refactor: Added per-playbook subdirs and automation for linting and releasing

Added linting CI jobs to process all .yml files within the ./playbooks/<item name>/ subdirectories

BREAKING CHANGE: All playbook files migrated from root dir to per-playbook subdirs

Author: slothkong

.ansible-lint-ignore

@@ -0,0 +1,2 @@
+playbooks/jupytherhub-flavour/jupytherhub-flavour.yml var-naming[no-role-prefix]
+playbooks/ecmwf-data-flavour/ecmwf-data-flavour.yml var-naming[no-role-prefix]

.github/workflows/lint.yml

@@ -0,0 +1,39 @@
+name: Ansible Lint
+
+on:
+  push:
+    paths:
+      - '**/*.yml'
+  pull_request:
+    paths:
+      - '**/*.yml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    strategy:
+      matrix:
+        python-version: ['3.9']
+    env:
+      ANSIBLE_PATH: ./playbooks
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install ansible~=8.7 ansible-lint~=6.22
+
+      - name: Run ansible-lint
+        run: ansible-lint --offline ${{ env.ANSIBLE_PATH }}

.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Semantic Release
+
+on:
+  workflow_run:
+    workflows: ["Ansible Lint"]
+    types:
+      - completed
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_branch == 'main' }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Verify dependency signatures
+        run: npm audit signatures || echo "Some dependency signatures could not be verified!"
+
+      - name: Run semantic-release
+        run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create and push release branch
+        if: env.VERSION != ''
+        run: |
+          git checkout main
+          git pull origin main
+          git checkout -b release/${{ env.VERSION }}
+          git push origin release/${{ env.VERSION }}
+          echo "Created and pushed release branch: release/${{ env.VERSION }}"

.releaserc

@@ -0,0 +1,39 @@
+{
+    "branches": [
+        "main"
+    ],
+    "tagFormat": "${version}",
+    "plugins": [
+        [
+            "@semantic-release/commit-analyzer",
+            {
+                "preset": "angular"
+            }
+        ],
+        [
+            "@semantic-release/release-notes-generator",
+            {
+                "preset": "angular"
+            }
+        ],
+        [
+            "@semantic-release/changelog",
+            {
+                "changelogTitle": "# Changelog\n\nAll notable changes to this project are documented in this file. See\n[Conventional Commits](https://conventionalcommits.org) for commit guidelines."
+            }
+        ],
+        [
+            "@semantic-release/exec",
+            {
+                "successCmd": "echo 'VERSION=${nextRelease.version}' >> $GITHUB_ENV"
+            }
+        ],
+        [
+            "@semantic-release/git",
+            {
+                "assets": ["CHANGELOG.md"],
+                "message": "chore: ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+            }
+        ]
+  ]
+}

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# How to Contribute
+
+This project is [licensed](./LICENSE) and accepts contributions via GitHub pull 
+requests. In this document, we outline some of the conventions on development 
+workflow, commit message formatting, contact points and other resources to make
+it easier to get your contribution accepted.
+
+## Getting Started
+
+* Fork the repository.
+* Read the [README.md](./README.md) for usage/test instructions.
+* Play with the project, submit bugs or patches.
+
+### Contribution Flow
+
+>💡 This repository uses [GitHub Actions](.github/workflows) 
+for automation. Changes merged into the main branch trigger the creation of 
+new tag, an auto-generated [CHANGELOG.md](./CHANGELOG.md) and a new release 
+branch.
+
+On the contributors' side:
+1. Create a topic branch from the main brach to base your work on.
+2. Make commits of logical units.
+3. Push changes to a topic branch in your GitHub fork of this
+repository.
+4. Make sure to validate changes by running tests on a 
+EWC environment.
+5. Submit a pull request to this repository, including details on
+the steps necessary to reproduce your tests; assign maintainers for
+review/approval.
+
+On the maintainers' side:
+
+1. Review, validate/test internally, and provide feedback prior to approving the 
+pull request.
+2. Upon approval, squash-merge the changes, making sure to provide a relevant
+conventional commit message title (checkout 
+[commit guidelines](#commit-guidelines) below).
+3. Verify the CI automation updates the [CHANGELOG.md](./CHANGELOG.md),
+creates a new `git tag` on the main branch and a release branch.
+
+
+### Commit Guidelines
+
+This repository enforces
+[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+to mark breaking, major and minor code changes in accordance with the
+[Semantic Versioning](https://semver.org/) standard:
+- Commits that land on to the main branch should always be prefixed by a
+specific keyword (i.e. `docs`, `style`, `feat`, `fix`, `refactor`, `ci`, 
+`chore` or `test`)
+- Value is communicated to the end-users by three of the prefixes:
+  - `fix:` Patches a bug in your codebase.
+  - `feat:` Introduces a new feature to the codebase.
+  - `BREAKING CHANGE:` Introduces a breaking API change. A 
+`BREAKING CHANGE` can be part of commits of any type.
+
+## Reporting Security Vulnerabilities
+
+Due to their public nature, GitHub and RocketChat are not appropriate places
+for reporting vulnerabilities. If you suspect you have found a security 
+vulnerability, please do not file a GitHub issue, but instead email 
+[support@europeanweather.cloud](mailto:support@europeanweather.cloud) with the 
+full details, including steps to reproduce the issue.

README.md

@@ -1,59 +1,27 @@
 EWC Automation of EWC Instance Flavours
 =======================================
 
-This repository contains Ansible playbooks for customising EWC instances with specific software stacks:
 
-- **ECMWF data flavour**: includes the basic ECMWF software stack, with MARS client and an environment with ecCodes, Metview, Earthkit and Aviso.
-- **Jupyterhub flavour**: installs and run jupyterhub on your instance, offering a convenient way to access it through the web.
+This repository contains Ansible playbooks for customizing EWC instances with specific software stacks:
+
+1. [ECMWF data flavour](./playbooks/ecmwf-data-flavour/): includes the basic ECMWF software stack, with MARS client and an environment with ecCodes, Metview, Earthkit and Aviso.
+2. [Jupyterhub flavour](./playbooks/jupyterhub-flavour/): installs and run JupyterHub on your instance, offering a convenient way to access it through the web.
 
 Getting started
 ---------------
 
 - Install ansible and other dependencies. You may want to do it in its own virtual environment (`pip install -r requirements.txt`)
 - Fetch the external requirements
-  
-  ```bash
-  ansible-galaxy role install -r requirements.yml roles/
-  ```
-
-- Define your inventory in `inventory`
-- Run the apropriate playbook:
-
-  ```bash
-  ansible-playbook -i inventory playbookname.yml
-  ```
-
-Available Playbooks
--------------------
-
-- **ECMWF data flavour**. You may use the following ansible variables to customise this playbook:
-  - `reboot_if_required`: Boolean to reboot the instance if required after an update. Default: true
-  - `ecmwf_toolbox_env_wipe`: Boolean to decide whether to wipe the environment if exists prior to a reinstallation. Default: no
-  - `ecmwf_toolbox_env_name`: Name of the environment containing the ECMWF toolbox. Default: ecmwf-toolbox
-  - `ecmwf_toolbox_create_ipykernel`: Boolean to create a system-wide kernel available. Default: yes
-  - `conda_prefix`: Prefix where conda is installed. Default: `/opt/conda`
-  - `conda_user`: User owning the conda installation. Default: `root`
-
-  Example usage:
 
   ```bash
-  ansible-playbook -i inventory ecmwf-data-flavour.yml
+  ansible-galaxy role install -r requirements.yml -p roles/
   ```
-  
-- **Jupyterhub flavour**. You may use the following ansible variables to customise this playbook:
-  - `jupyterhub_local_cert_email`: If ran outside Morpheus, **pass this variable explicitly when running the ansible playbook.**
-  - `dns_domain`: **Pass this variable explicitly when running the ansible playbook**. If not present, will try to guess from instance configured hostname in /etc/hostname.
-  - `jupyterhub_local_env_wipe`: Boolean to decide whether to wipe the environment if exists prior to a reinstallation. Default: no
-  - `jupyterhub_local_env_name`: Name of the environment containing the Jupyerhub. Default: jupyterhub-local
-  - `jupyterhub_local_test_cert`: Use Lets encrypt test certificate. Default: false
-  - `jupyterhub_local_with_otp`: Use OTP authentication for Jupyterhub. It requires manual run of `google-authenticator` by the user to configure your TOTP device after running this playbook Default: false
-  - `conda_prefix`: Prefix where conda is installed. Default: `/opt/conda`
-  - `conda_user`: User owning the conda installation. Default: `root`
 
-  Example Usage for an instance with Fully Qualified Domain name `jupyterhub.mytenancy.f.ewcloud.host` and registered to the email address `myemail@myorg.com`:
+- Define your inventory in `inventory`
+- Run the appropriate playbook:
 
   ```bash
-  ansible-playbook -e jupyterhub_local_cert_email=myemail@myorg.com -e dns_domain=jupyterhub.mytenancy.f.ewcloud.host -i inventory jupyterhub-flavour.yml
+  ansible-playbook -i inventory path/to/playbook/filename
   ```
 
 License