docs(unraid): say why the CA templates use :latest on purpose - #286
Merged
Conversation
DECIDED 2026-08-07 by Sergio: keep :latest. CashPilot-3c2n asked the question with three options; this is option 1, and the work is making the choice legible rather than changing it. The reasoning, recorded beside the tag itself: Community Applications is how unraid users receive updates at all. A template pinned to 1.19 leaves every CA user on 1.19 until the template is re-published -- trading "unknowable version" for "silently frozen version", which is worse for an app whose whole job is to keep earning. Everywhere else in the project still pins major.minor, and #280's sweep still fails any DOC that ships :latest. The tag alone reads as an oversight. Without the comment beside it, the next person tidying the repository removes it in good faith and quietly changes how every unraid user upgrades -- so a test now asserts both that the templates use :latest AND that they explain why and point at the decision record. Controlled: pinning one template to 1.19 fails the test with a message explaining what that would do. Also asserts the templates parse as XML, since a malformed one is rejected by CA with no useful message, and that there ARE templates to check -- otherwise every assertion would hold vacuously.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe change adds tests for Unraid template discovery, XML validity, deliberate ChangesUnraid template tag policy
Estimated code review effort: 2 (Simple) | ~10 minutes ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes CashPilot-3c2n. You chose to keep
:latest, so the work is making that choice legible rather than changing it.The reasoning, recorded beside the tag
Community Applications is how unraid users receive updates at all. A template pinned to
1.19leaves every CA user on 1.19 until the template itself is re-published — trading "unknowable version" for "silently frozen version", which is worse for an app whose whole job is to keep earning.Everywhere else still pins
major.minor, and #280's sweep still fails any doc shipping:latest. This is the one deliberate exception.Why a test, not just a comment
The tag alone reads as an oversight. Without the explanation beside it, the next person tidying
:latestout of the repository removes it in good faith — and quietly changes how every unraid user upgrades.So the test asserts both that the templates use
:latestand that they explain why and point at the decision record.Controlled: pinning one template to
1.19fails with a message explaining what that would do. Also asserts the templates parse as XML (a malformed one is rejected by CA with no useful message) and that there are templates to check — otherwise every assertion holds vacuously.Summary by CodeRabbit
Documentation
:latestimage tag, including update behavior and security considerations.Tests
:latest, and include the required decision rationale.