feat(devx): add config validation workflow

Author: gildesmarais

.github/workflows/ruby.yml

@@ -11,14 +11,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: "20"
 
       - name: Install dependencies
-        run: |
-          sudo apt-get install -yqq yamllint
+        run: sudo apt-get install -yqq yamllint
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -29,6 +28,9 @@ jobs:
       - name: Run linters
         run: make lint
 
+      - name: Validate configs
+        run: make validate
+
   test:
     strategy:
       fail-fast: false
@@ -38,7 +40,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -53,7 +55,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /node_modules/
+/schema/
 
 # rspec failure tracking
 .rspec_status

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "redhat.vscode-yaml"
+  ]
+}

Makefile

@@ -1,9 +1,16 @@
-default: lint test
+default: lint validate test
 
 lint:
 	yamllint lib/html2rss/configs/ .github/
 	bundle exec rubocop -P -f quiet
-	npx prettier --check lib/**/*.yml .github/**/*.yml  README.md
+	npx prettier --check lib/**/*.yml .github/**/*.yml README.md
+
+validate:
+	bundle exec ruby bin/validate_configs
+
+schema:
+	mkdir -p schema
+	bundle exec html2rss schema --write schema/html2rss-config.schema.json
 
 test:
 	bundle exec rspec

README.md

@@ -40,6 +40,18 @@ channel:
 
 The `type` field specifies the parameter type (currently only `string` is supported), and `default` provides the default value when no parameter is explicitly provided.
 
+## Validation
+
+Validate configs against the html2rss schema before committing:
+
+```bash
+# Validate all configs
+make validate
+
+# Validate a single config directly
+bundle exec html2rss validate lib/html2rss/configs/github.com/releases.yml
+```
+
 ## Testing
 
 Uses **dynamic test generation** - no individual spec files needed!
@@ -55,7 +67,7 @@ make test-config CONFIG=github.com/releases.yml
 make test-domain DOMAIN=github.com
 ```
 
-**Adding new configs**: Just create the YAML file and run tests. No spec file needed.
+**Adding new configs**: Just create the YAML file and run `make validate` then tests. No spec file needed.
 
 **Config folder convention**: Place configs under the registrable domain folder (e.g., `example.com/` or `bbc.co.uk/`). Legacy subdomain folders (e.g., `news.example.com/`) are allowed but not preferred.
 

bin/setup

@@ -1,8 +1,33 @@
 #!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
-set -vx
 
+echo "==> Installing Ruby dependencies..."
 bundle install
 
-# Do any other automated setup that you need to do here
+echo
+echo "==> Installing Node dependencies (required for make lint)..."
+npm install --no-fund --no-audit --no-save prettier
+
+echo
+echo "==> Checking system tools..."
+if command -v yamllint &>/dev/null; then
+  echo "    yamllint: ok ($(yamllint --version))"
+else
+  echo "    yamllint: not found"
+  echo "    Install with one of:"
+  echo "      brew install yamllint"
+  echo "      pip install yamllint"
+fi
+
+echo
+echo "==> Setup complete. Common commands:"
+echo
+echo "    make              # lint + validate + test"
+echo "    make lint         # yamllint, rubocop, prettier"
+echo "    make validate     # validate all configs against the html2rss schema"
+echo "    make test         # run rspec"
+echo
+echo "    make test-config CONFIG=github.com/releases.yml   # test a single config"
+echo "    make test-domain DOMAIN=github.com                # test all configs for a domain"
+echo "    make schema                                        # write schema locally (optional)"

bin/validate_configs

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'html2rss'
+require 'yaml'
+
+unless Html2rss::Config.respond_to?(:validate)
+  warn 'Error: installed html2rss gem does not support Config.validate.'
+  warn 'Run: bundle update html2rss'
+  exit 1
+end
+
+files = Dir['lib/html2rss/configs/**/*.yml']
+failed = []
+
+files.each do |file|
+  config = YAML.safe_load_file(file, symbolize_names: true)
+  result = Html2rss::Config.validate(config)
+
+  if result.success?
+    puts "ok   #{file}"
+  else
+    puts "FAIL #{file}"
+    result.errors.to_h.each do |key, messages|
+      Array(messages).each { |msg| warn "       #{key}: #{msg}" }
+    end
+    failed << file
+  end
+end
+
+puts
+if failed.empty?
+  puts "#{files.size} configs validated successfully."
+else
+  warn "#{failed.size}/#{files.size} configs failed validation."
+  exit 1
+end