Skip to content

CAR-203 add non-deploying Compose catalog validation - #3

Draft
carteakey wants to merge 1 commit into
mainfrom
kartychauhan/car-203-validate-the-compose-catalog-and-maintenance-scripts-in-ci
Draft

carteakey wants to merge 1 commit into
mainfrom
kartychauhan/car-203-validate-the-compose-catalog-and-maintenance-scripts-in-ci

Conversation

@carteakey

Copy link
Copy Markdown
Owner

Summary

  • Add the explicit catalog-validation.yaml inventory for all 64 maintained Compose examples, with documented archive/generated/template treatment.
  • Add _scripts/validate_catalog.py as the local and CI validation entrypoint.
  • Add a read-only pull-request workflow, shell/catalog checks, focused valid/invalid Compose fixtures, and local documentation.
  • Preserve the creator-owned Linear planning pointer in README.md.

Acceptance evidence

  • docker compose config --quiet runs for every active entry using temporary copies, sanitized interpolation defaults, and sanitized explicit env_file paths; no working-tree environment files are read.
  • 62 entries pass strict Compose parsing; Actual Budget and Calibre-Web are explicit, path-matched expected template exceptions with reasons in the manifest.
  • bash -n passes for all four maintained shell scripts.
  • services.yaml (19 updater entries) and README Compose links (63 advertised rows, with standalone Lidarr explicitly documented as unlisted) are structurally validated.
  • The workflow has contents: read only and invokes config parsing/fixtures; it does not pull/build images, start containers, deploy, rewrite catalog output, or contact private infrastructure.

Verification

  • python3 _scripts/validate_catalog.py — passed: 64 Compose files, shell syntax, and catalog structure.
  • python3 -m unittest discover -s tests -p 'test_*.py' -v — 2 tests passed.
  • git diff --check — passed.

Linear issue: https://linear.app/carteakey/issue/CAR-203/validate-the-compose-catalog-and-maintenance-scripts-in-ci

External blocker

The separate scheduled updater currently reaches its PR step but GitHub rejects it with GitHub Actions is not permitted to create or approve pull requests. This PR does not change repository settings; the validation workflow remains read-only.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant