Skip to content

Add: sync the Unraid template from the README and CHANGELOG - #179

Merged
SandObserver merged 1 commit into
mainfrom
feat/unraid-template-sync
Oct 17, 2026
Merged

SandObserver merged 1 commit into
mainfrom
feat/unraid-template-sync

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • Add tools/unraid_template.py: writes each Unraid variable's description and default from its README Settings row, and <Changes> from the newest dated CHANGELOG section. --check exits 1 when the template is out of date.
  • Rewrite templates/posteryard.xml with it: 0.9.0 release notes in <Changes>, and settings help that matches the README.
  • README Settings: add rows for TMDB_API_KEY, PLEX_URL, PLEX_TOKEN and WEBHOOK_SECRET, and split the Jellyfin and Emby rows.
  • CONTRIBUTING: run the tool after a settings change and in every release PR.

Testing

All green. Added 6 tests: the template is in sync, README text becomes plain, Changes skips Unreleased, XML escaping, and refusal of a missing README row or a changelog without a release.

Checklist

  • Format, lint, type checks and tests pass.
  • DESIGN_VERSION bumped and tests/golden written again if rendered images change.
  • CHANGELOG.md updated under Unreleased for user-visible changes.

The Unraid template takes each setting's description and default from the
README Settings table, and its Changes from the newest dated CHANGELOG
section. tools/unraid_template.py writes it; tests/test_unraid.py fails when
it is out of date. The README table gains rows for the TMDB key, Plex URL,
Plex token and webhook secret, and splits the Jellyfin and Emby rows.
@SandObserver SandObserver added the enhancement New feature or request label Oct 17, 2026
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying posteryard with  Cloudflare Pages  Cloudflare Pages

Latest commit: 67e30a5
Status: ✅  Deploy successful!
Preview URL: https://07b9825b.posteryard.pages.dev
Branch Preview URL: https://feat-unraid-template-sync.posteryard.pages.dev

View logs

@SandObserver
SandObserver merged commit d267a7a into main Oct 17, 2026
6 checks passed
@SandObserver
SandObserver deleted the feat/unraid-template-sync branch October 17, 2026 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant