Define image release contract module (#2)#7
Merged
Conversation
Establish a single owner for the Prebuilt Image release facts and fix the documentation-vs-automation drift found in the architecture review. - Add ADR 0001 as the single source of truth: tag-driven releases (v* + manual dispatch, no main), :latest = newest Release Tag, default-latest with opt-in pinning. - Workflow: move image owner/name to repo variables (forkable), add a required tag input for Manual Rebuild, and only move :latest on a tag push (closes the dispatch-from-main hole). - Parameterize the compose image ref via .env and document the vars. - Add release domain terms to CONTEXT.md (Release Tag, Latest Pointer, Release Trigger, Manual Rebuild). - Make devimage-build/README the single prose owner of release facts and fix the drift; shrink root and .devcontainer READMEs to links. - Add scripts/check-release-contract.sh + CI workflow to guard against doc/automation drift. Follow-up: #6 (pull_policy :latest auto-pull bug).
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.
Closes #2.
Establishes a single owner for the Prebuilt Image release facts and fixes the documentation-vs-automation drift found in the architecture review.
Contract (single source of truth:
docs/adr/0001-image-release-contract.md)v*Release Tag push or a Manual Rebuild (workflow_dispatchnaming an existing tag); no main-branch release.:latest— alias for the most recent Release Tag; only a Release Tag push moves it. Manual Rebuild never moves it (closes the old dispatch-from-main→:mainhole).:latest; pinning:vX.Y.Zdocumented as opt-in.devimage-build/READMEis the single prose owner; root +.devcontainerREADMEs only link.vars.DOCKERHUB_USERNAME/vars.IMAGE_NAME, with defaults); compose reads them via.env; onlyDOCKER_HUB_TOKENstays a secret.Changes
scripts/check-release-contract.sh,release-contract-check.ymlCI.taginput for Manual Rebuild,:latestmoved only on tag push.devimage-build/READMErelease section rewritten (drift fixed: false main trigger,DOCKER_HUB_USERNAMEsecret,build-push-action); root +.devcontainerREADMEs shrunk to links; removed the manualdocker push :latestinstructions.CI
scripts/check-release-contract.shasserts: compose default image == workflow default;on:is exactly{tag v*, workflow_dispatch}with no branch trigger; grep-guard keeps retired false claims out of the docs. Passes locally.Follow-up
pull_policy:latestauto-pull bug (ready-for-agent), out of scope here.