✨ Add CI/CD workflows for linting, validation, and documentation checks

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci-summary:
+    name: CI Summary
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: CI Status
+        run: |
+          echo "✅ Running CI checks for azuredevops-lib"
+          echo "📦 Repository: ${{ github.repository }}"
+          echo "🔀 Branch: ${{ github.ref_name }}"
+          echo "👤 Actor: ${{ github.actor }}"
+
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            echo "🔍 PR #${{ github.event.pull_request.number }}: ${{ github.event.pull_request.title }}"
+          fi

.github/workflows/documentation-check.yml

@@ -0,0 +1,41 @@
+name: Documentation Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**.md'
+      - '.github/workflows/documentation-check.yml'
+
+jobs:
+  markdown-lint:
+    name: Lint Markdown Files
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run markdown linter
+        uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          globs: '**/*.md'
+          config: '.markdownlint.json'
+
+  link-checker:
+    name: Check Links
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check links in markdown files
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          use-quiet-mode: 'yes'
+          config-file: '.markdown-link-check.json'

.github/workflows/validate-templates.yml

@@ -0,0 +1,40 @@
+name: Validate Templates
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**.yaml'
+      - '**.yml'
+      - '.github/workflows/validate-templates.yml'
+
+jobs:
+  validate-yaml-syntax:
+    name: Validate YAML Syntax
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install PyYAML
+        run: |
+          pip install pyyaml
+
+      - name: Validate YAML files
+        run: |
+          echo "Validating YAML syntax for all templates..."
+          find . -type f \( -name "*.yaml" -o -name "*.yml" \) ! -path "./.git/*" | while read file; do
+            echo "Checking: $file"
+            python -c "import yaml, sys; yaml.safe_load(open('$file'))" || exit 1
+          done
+          echo "✅ All YAML files are valid!"

.github/workflows/yaml-lint.yml

@@ -0,0 +1,35 @@
+name: YAML Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**.yaml'
+      - '**.yml'
+      - '.github/workflows/yaml-lint.yml'
+
+jobs:
+  yaml-lint:
+    name: Lint YAML Files
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install yamllint
+        run: |
+          pip install yamllint
+
+      - name: Run yamllint
+        run: |
+          yamllint -f parsable -c .yamllint.yml .

.gitignore

@@ -0,0 +1,46 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+ENV/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Logs
+*.log
+
+# Temporary files
+tmp/
+temp/
+*.tmp

.markdown-link-check.json

@@ -0,0 +1,12 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^https://github.com/bancey/azuredevops-lib/(wiki|discussions)"
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": true,
+  "retryCount": 3,
+  "fallbackRetryDelay": "30s",
+  "aliveStatusCodes": [200, 206]
+}

.markdownlint.json

@@ -0,0 +1,10 @@
+{
+  "default": true,
+  "MD013": {
+    "line_length": 200,
+    "code_blocks": false,
+    "tables": false
+  },
+  "MD033": false,
+  "MD041": false
+}

.yamllint.yml

@@ -0,0 +1,50 @@
+---
+extends: default
+
+rules:
+  # Azure DevOps templates often have long lines
+  line-length:
+    max: 200
+    level: warning
+
+  # Allow inline mappings for Azure DevOps template syntax
+  braces:
+    max-spaces-inside: 1
+    level: warning
+
+  # Azure DevOps uses templates with specific indentation
+  indentation:
+    spaces: 2
+    indent-sequences: true
+
+  # Allow empty values for Azure DevOps parameters with defaults
+  empty-values:
+    forbid-in-block-mappings: false
+    forbid-in-flow-mappings: false
+
+  # Azure DevOps templates use anchors and aliases
+  anchors:
+    forbid-undeclared-aliases: true
+    forbid-duplicated-anchors: true
+
+  # Allow duplicate keys for Azure DevOps template overrides
+  key-duplicates: disable
+
+  # Comments are important in templates
+  comments:
+    min-spaces-from-content: 1
+
+  # Allow truthy values common in Azure DevOps
+  truthy:
+    allowed-values: ['true', 'false', 'yes', 'no', 'on', 'off']
+    check-keys: false
+
+  # Allow document start for some files
+  document-start: disable
+
+  # Allow new lines for compatibility
+  new-lines:
+    type: unix
+
+  # Allow trailing spaces to be fixed automatically
+  trailing-spaces: enable

README.md

@@ -1,5 +1,10 @@
 # azuredevops-lib
 
+[![YAML Lint](https://github.com/bancey/azuredevops-lib/actions/workflows/yaml-lint.yml/badge.svg)](https://github.com/bancey/azuredevops-lib/actions/workflows/yaml-lint.yml)
+[![Validate Templates](https://github.com/bancey/azuredevops-lib/actions/workflows/validate-templates.yml/badge.svg)](https://github.com/bancey/azuredevops-lib/actions/workflows/validate-templates.yml)
+[![Documentation Check](https://github.com/bancey/azuredevops-lib/actions/workflows/documentation-check.yml/badge.svg)](https://github.com/bancey/azuredevops-lib/actions/workflows/documentation-check.yml)
+[![CI](https://github.com/bancey/azuredevops-lib/actions/workflows/ci.yml/badge.svg)](https://github.com/bancey/azuredevops-lib/actions/workflows/ci.yml)
+
 A comprehensive collection of reusable Azure DevOps pipeline templates and components for infrastructure automation, configuration management, and CI/CD workflows.
 
 ## 🎯 Project Scope
@@ -131,15 +136,15 @@
 
 ## 📁 Component Reference
 
 ### Stages
 - `stages/terraform.yaml` - Complete Terraform workflow (plan/apply/destroy)
 - `stages/check-hosts-online.yaml` - Multi-host connectivity verification
 
 ### Jobs
 - `jobs/hosts-online-precheck.yaml` - Pre-deployment host availability check
 
 ### Steps
 - `steps/terraform.yaml` - Terraform operations with Azure backend
 - `steps/ansible.yaml` - Ansible playbook execution with secret management
 - `steps/gh-auth.yaml` - GitHub App authentication
 - `steps/packer.yaml` - Packer image building
@@ -147,21 +152,32 @@
 - `steps/check-host-online.yaml` - Single host connectivity check
 - `steps/check-hosts-online.yaml` - Multiple host connectivity check
 
 ### Resources
 - `resources/tfcmt.yaml` - Terraform comment automation configuration
 
 ## 🤝 Contributing
 
 We welcome contributions to improve and extend this library! Here's how you can help:
 
+### Continuous Integration
+
+This repository uses GitHub Actions for automated testing and validation:
+
+- **YAML Linting**: Validates YAML syntax and style across all templates
+- **Template Validation**: Checks YAML structure and parsing
+- **Documentation Checks**: Lints markdown files and validates links
+- **CI Summary**: Provides comprehensive status on all checks
+
+All workflows run automatically on pull requests and pushes to the main branch. You can see the status of these checks in the Actions tab or on your pull request.
+
 ### Getting Started
 
 1. **Fork the repository** on GitHub
 2. **Clone your fork** locally:
    ```bash
    git clone https://github.com/your-username/azuredevops-lib.git
    cd azuredevops-lib
    ```
 3. **Create a feature branch**:
    ```bash
    git checkout -b feature/your-feature-name
@@ -200,13 +216,28 @@
 
 1. **Validate YAML syntax**:
    ```bash
-   # Use your preferred YAML validator
-   python -c "import yaml; yaml.safe_load(open('path/to/your/template.yaml'))"
+   # Install yamllint
+   pip install yamllint
+
+   # Run yamllint on all files
+   yamllint -f parsable -c .yamllint.yml .
+   ```
+
+2. **Validate YAML structure**:
+   ```bash
+   # Install PyYAML
+   pip install pyyaml
+
+   # Check all YAML files
+   find . -type f \( -name "*.yaml" -o -name "*.yml" \) ! -path "./.git/*" | while read file; do
+     echo "Checking: $file"
+     python -c "import yaml; yaml.safe_load(open('$file'))"
+   done
    ```
 
-2. **Test in a pipeline**: Create a test pipeline in your Azure DevOps organization to validate functionality
+3. **Test in a pipeline**: Create a test pipeline in your Azure DevOps organization to validate functionality
 
-3. **Document your changes**: Update this README if you're adding new components or changing existing behavior
+4. **Document your changes**: Update this README if you're adding new components or changing existing behavior
 
 ### Submitting Changes
 

resources/tfcmt.yaml

@@ -1 +1 @@
-plan_patch: true
+plan_patch: true

steps/terraform.yaml

@@ -59,8 +59,8 @@ steps:
             cd ${{ parameters.workingDirectory }}
             tfswitch -b $(Pipeline.Workspace)/.tools/bin/terraform
         - ${{ if eq(parameters.publishPlan, true) }}:
-          - name: tfcmt
-            downloadUrl: https://github.com/suzuki-shunsuke/tfcmt/releases/download/v4.14.12/tfcmt_linux_amd64.tar.gz
+            - name: tfcmt
+              downloadUrl: https://github.com/suzuki-shunsuke/tfcmt/releases/download/v4.14.12/tfcmt_linux_amd64.tar.gz
   - task: TerraformCLI@2
     displayName: Terraform initialize
     inputs: