Repository navigation
docs: say that compose/ is a published interface, and what on-push diffs from - #184
Merged
Merged
Conversation
…ffs from Nothing in the README said that the compose files are consumed by another project. The OVOS installer clones this repository at a release tag and runs them, which makes the compose file names, the container names it execs into, the environment variables the compose reads and the images it pulls an interface somebody else depends on - and contract.yml declares all four so the dependency cannot drift unnoticed. A contributor editing compose/ had no way to learn that from here, or that scripts/contract.py has to be rerun afterwards. The automation table said on-push.yml builds what changed on a commit to dev. It builds what changed since the last commit the workflow actually published, which is not the same base whenever a run was cancelled - and cancelled runs are exactly when the difference matters, because the work would otherwise be skipped for good rather than retried. Both platform READMEs linked to README.md#how-to-use-these-images, a heading README.md does not have and has not had for years. The section a reader wants is Run images. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (3)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe changes document the compose files as a published installer interface, clarify the push workflow description, and update macOS and Windows links to the renamed README section. ChangesDocumentation contract
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change is ready to merge with no identified correctness or availability risk. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 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
1 participant
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.
Three corrections to the READMEs on
dev, found while checking whether the documentation kept up with the cross-repository contract work.compose/is consumed by another project and nothing said so. The OVOS installer clones this repository at a release tag and runs these compose files, which makes the compose file names, the container names it execs into, the environment variables the compose reads and the images it pulls a published interface.contract.ymldeclares all four so the dependency cannot drift unnoticed — but a contributor editingcompose/had no way to learn any of that from the README, or thatscripts/contract.py --writehas to be rerun afterwards.The automation table described the wrong diff base. It said
on-push.ymlbuilds what changed on a commit todev. It builds what changed since the last commit the workflow actually published — not the same base whenever a run was cancelled, which is exactly when the difference matters, because that work would otherwise be skipped for good rather than retried (#181, #182).Both platform READMEs pointed at a heading that does not exist.
README.md#how-to-use-these-imageshas had no such heading for years; the section a reader wants is#run-images. Every remaining relative anchor into README.md was checked and resolves.scripts/contract.pypasses on this branch:contract.yml matches compose/ (10 files, 49 services, 29 variables).🤖 Generated with Claude Code
Summary by CodeRabbit