Skip to content

[Repo] ci: Validate compose files; document updates and backups - #72

Merged
finallyjay merged 3 commits into
mainfrom
chore/repo-ci-docs
Nov 6, 2026
Merged

finallyjay merged 3 commits into
mainfrom
chore/repo-ci-docs

Conversation

@finallyjay

Copy link
Copy Markdown
Owner

Summary

Three repo-wide improvements:

  1. CI: validate compose files (.github/workflows/validate-compose.yml)
    • Runs docker compose -f <service>/docker-compose.yml config -q for
      every service, with that service's .env.example as --env-file.
    • Variables left empty in .env.example on purpose (so the deploy
      fails until they are set, e.g. Garage secrets, ARCHISTEAMFARM_CRYPTKEY)
      get a dummy value in CI only, so ${VAR:?msg} resolves.
    • cloudflared joins dokploy-network, which Dokploy provides on
      deploy but the compose file does not declare. CI adds a small
      override declaring it as external, for validation only; the compose
      files are unchanged.
    • A second job checks the 3-file convention: each service folder holds
      exactly docker-compose.yml, .env.example and README.md.
    • actions/checkout pinned by commit SHA, permissions: contents: read.
  2. ## Updates section at the end of every service README: which
    containers Watchtower updates and the tag they follow, what is pinned
    and bumped by hand (qBittorrent, VueTorrent) or by Dependabot (Garage),
    and the Dokploy watch path (<service>/**). MongoDB in MySpotify
    follows 8, so a new major is a manual change with a dump/restore.
    Garage and Watchtower already had the section; it was extended.
  3. Backup column in the main README services table, plus a note that
    backups are Dokploy backups to S3-compatible storage configured outside
    this repository.

Test plan

  • Ran the workflow scripts locally: config -q passes for all 14
    services and the 3-file check passes.
  • npx markdownlint-cli2 "**/*.md" passes.
  • The new Validate Compose workflow passes on this PR.

🤖 Generated with Claude Code

finallyjay and others added 3 commits November 6, 2026 02:49
Runs docker compose config for every service with its .env.example,
and checks that each service folder holds exactly docker-compose.yml,
.env.example and README.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 6, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 59 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1c450d25-dab9-4bb8-a5ee-0ad3da7df322
Commits

Reviewing files that changed from the base of the PR and between adfd276 and 7c6be6d.

Files selected for processing: 16

  • .github/workflows/validate-compose.yml
  • README.md
  • apprise/README.md
  • archisteamfarm/README.md
  • cloudflared/README.md
  • garage/README.md
  • homepage/README.md
  • myspotify/README.md
  • n8n/README.md
  • pihole/README.md
  • plex/README.md
  • qbittorrent/README.md
  • speedtest/README.md
  • traccar/README.md
  • watchtower/README.md
  • wgdashboard/README.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@finallyjay
finallyjay merged commit 7854be6 into main Nov 6, 2026
6 checks passed
@finallyjay
finallyjay deleted the chore/repo-ci-docs branch November 6, 2026 01:58
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