[docs] - Clarify stable & development image tags availability and contribution rules. - #2030
Open
Venkumahanti Subhankar (V-Subhankar-infy) wants to merge 3 commits into
Open
Venkumahanti Subhankar (V-Subhankar-infy) wants to merge 3 commits into
Venkumahanti Subhankar (V-Subhankar-infy) wants to merge 3 commits into
Conversation
…ontribution rules.
Venkumahanti Subhankar (V-Subhankar-infy)
requested a balanced review from Copilot
September 30, 2026 13:51
Copilot started reviewing on behalf of
Venkumahanti Subhankar (V-Subhankar-infy)
September 30, 2026 13:52
View session
Venkumahanti Subhankar (V-Subhankar-infy)
requested a balanced review from Copilot
September 30, 2026 14:11
Copilot started reviewing on behalf of
Venkumahanti Subhankar (V-Subhankar-infy)
September 30, 2026 14:12
View session
Venkumahanti Subhankar (V-Subhankar-infy)
requested a balanced review from Copilot
September 30, 2026 17:26
Copilot started reviewing on behalf of
Venkumahanti Subhankar (V-Subhankar-infy)
September 30, 2026 17:27
View session
Venkumahanti Subhankar (V-Subhankar-infy)
marked this pull request as ready for review
September 30, 2026 17:29
Venkumahanti Subhankar (V-Subhankar-infy)
requested a review
from a team
as a code owner
September 30, 2026 17:29
This branch has not been deployed
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.

Summary
Clarifies the availability of stable and experimental
dev-*images across all image READMEs and directs users to live MCR data for currently pullable tags.Closes #1965 and . Is a Rework of PR #1972
Also helps with Issues like #1963 (That is already resolved but similar issues might occur, this PR prevents that)
Current Issues
As of today, one of the crucial images, Universal, displays different versions as 'Latest' across its documentation and registries:
6.1.8appears in the Universal README, which users commonly consult as a reference.6.1.6appears on the MCR artifact page.6.1.7appears on the MCR tags page.Root Cause
Dev images are built from
mainand published under mutabledev-*tags, while stable images follow a versioned release flow. During release preparation,prepare-release.shapplies a manifest patch bump and updates matching README version references. Because changes can reachmainbefore stable publication, static README examples may temporarily reference tags that are not yet pullable.This is primarily caused by the following:
main.maincan reference unreleased tags and create invalid or confusing links.Changes
Updated all 18 image READMEs to include copyable stable references, separate MCR detail and tag links, a valid experimental
dev-*example, guidance that dev tags may change in place, reproducibility recommendations, and clarification that semantic-version examples are usage references.Added contributor and Copilot guidance requiring semantic manifest bumps for every image-changing PR, README updates for major and minor changes, and no manual README patch updates for security or bug-fix changes.
Approaches Considered
1. Lifecycle-Aware README Sections and Release Script
Pros: Preserves automatic stable-version updates, prevents unrelated README content from being modified, and gives stable, development, and pinned tags explicit documentation boundaries.
Cons: Introduces a rigid Markdown-heading contract that requires additional tests and maintenance, while pins could still be updated before MCR publication succeeds.
2A. Separate Stable and Dev Documentation
Pros: Clearly separates stable and experimental artifacts, keeps dev variants documented before stable release, and allows each tag type to follow its own lifecycle.
Cons: Requires recurring documentation work before scheduled or manual dev pushes and duplicates MCR data as another synchronization point. MCR already provides the authoritative tag inventory, so delaying dev documentation reduces its early-discovery and validation value.
2B. Update READMEs Only During Stable Releases
Pros: Prevents development changes from appearing immediately as stable examples, reduces README edits during development, and lets release automation use the final version.
Cons: Dev variants may be published without repository documentation, while post-publication updates require additional commits, documentation PRs, rollback handling, and workflow state.
2C. Use MCR for Current Availability
Pros: Uses registry-backed data for current tags, digests, and publication state; keeps stable and experimental images discoverable; and requires no additional release-state or rollback automation.
Cons: Static semantic-version examples may briefly lead stable publication, so users must consult MCR when selecting a currently available version.
Why We Selected 2C
This approach preserves early discovery and validation of changes from
main, separates copyable image references from browser links, and avoids additional release-workflow complexity. Major and minor changes remain visible in dev builds before stable publication, while security and bug-fix PRs avoid manual README patch churn. Release preparation still synchronizes those patch references.This approach was selected during the team meeting after considering the viable alternatives.
Validation
Confirmed the documented stable and
dev-*references, reviewed the wording across all 18 image READMEs, passedgit diff --check, and passed all fourprepare-release.shregression tests.Caveat
Static semantic-version examples may briefly lead stable publication, so users should consult MCR for current availability. Existing release automation remains unchanged; lifecycle-aware post-publication updates could remove this window if the additional workflow complexity becomes justified.