Add ci workflow and run.sh tasks file (#15)

Author: cmsirbu

.github/workflows/ci.yaml

@@ -0,0 +1,46 @@
+---
+name: "CI"
+concurrency: # Cancel any existing runs of this workflow for this same PR
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+on: # yamllint disable-line
+  push:
+    branches:
+      - "main"
+    tags:
+      - "v*"
+  pull_request:
+
+jobs:
+  shellcheck:
+    runs-on: "ubuntu-24.04"
+    steps:
+      - uses: "actions/checkout@v4"
+      - run: "shellcheck run.sh"
+
+  lint:
+    runs-on: "ubuntu-24.04"
+    steps:
+      - uses: "actions/checkout@v4"
+      - uses: "astral-sh/setup-uv@v5"
+        with:
+          version: "0.6.6"
+      - run: "./run.sh setup"
+      - run: "./run.sh lint"
+
+  # tests:
+  #   runs-on: "ubuntu-24.04"
+  #   strategy:
+  #     matrix:
+  #       python-version:
+  #         - "3.9"
+  #         - "3.10"
+  #         - "3.11"
+  #         - "3.12"
+  #         - "3.13"
+  #   steps:
+  #     - uses: "actions/checkout@v4"
+  #     - uses: "astral-sh/setup-uv@v5"
+  #       with:
+  #         version: "0.6.6"
+  #         python-version: "${{ matrix.python-version }}"

.readthedocs.yaml

@@ -17,7 +17,7 @@ build:
       - "asdf install uv latest"
       - "asdf global uv latest"
     install:
-      - "uv sync"
+      - "uv sync --no-dev"
     post_install:
       - "uv run ansible-galaxy collection install -r docs/requirements.yaml"
     build:

.yamllint.yaml

@@ -1,7 +1,8 @@
 ---
 extends: "default"
 rules:
-  comments: "enable"
+  comments:
+    min-spaces-from-content: 1
   indentation:
     spaces: 2
     indent-sequences: true

mkdocs.yaml

@@ -75,7 +75,7 @@ markdown_extensions:
 watch:
   - "README.md"
 
-nav:
+nav: # yamllint disable rule:indentation
   - "index.md"
   - "User Guide": "user_guide.md"
   - "Ansible Builtins": "ansible.builtin"

run.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o pipefail
+
+# -----------------------------------------------------------------------------
+# Helper functions start with _ and aren't listed in this script's help menu.
+# -----------------------------------------------------------------------------
+
+function _uvr {
+    uv run "$@"
+}
+
+# -----------------------------------------------------------------------------
+
+function setup {
+    echo "---------- Installing python environment via uv."
+    _uvr uv sync
+}
+
+function lint {
+    echo "---------- LINTING WITH RUFF"
+    _uvr ruff check mkdocs_ansible_collection
+    echo "---------- CHECKING FORMATTING WITH RUFF"
+    _uvr ruff format --check --diff mkdocs_ansible_collection
+    echo "---------- LINTING WITH YAMLLINT"
+    _uvr yamllint .
+}
+
+function autofix {
+    echo "---------- RUFF CHECK AUTOFIX"
+    _uvr ruff check --fix mkdocs_ansible_collection
+    echo "---------- FORMATTING WITH RUFF"
+    _uvr ruff format mkdocs_ansible_collection
+}
+
+# TODO: function test
+# TODO: function docs
+
+# -----------------------------------------------------------------------------
+
+function help {
+  printf "%s <task> [args]\n\nTasks:\n" "${0}"
+
+  compgen -A function | grep -v "^_" | cat -n
+
+  printf "\nExtended help:\n  Each task has comments for general usage\n"
+}
+
+TIMEFORMAT=$'\nTask completed in %3lR'
+time "${@:-help}"