[docs]: fix mismatch in release tags by documenting stable and dev tags seperately. - #1972
Open
Venkumahanti Subhankar (V-Subhankar-infy) wants to merge 5 commits into
Open
Conversation
Venkumahanti Subhankar (V-Subhankar-infy)
requested a lite review from Copilot
August 26, 2026 06:34
Copilot started reviewing on behalf of
Venkumahanti Subhankar (V-Subhankar-infy)
August 26, 2026 06:34
View session
Member
Author
|
The failing java smoke test is due to a external issue irrelevant to this PR's scope and will be fixed in other PR. |
Venkumahanti Subhankar (V-Subhankar-infy)
marked this pull request as ready for review
August 26, 2026 06:38
Venkumahanti Subhankar (V-Subhankar-infy)
requested a review
from a team
as a code owner
August 26, 2026 06:38
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies the distinction between stable release tags and dev-* preview tags across the image READMEs, and tightens build/prepare-release.sh so it only rewrites semantic-version examples in the ### Pinned release tags section during release preparation.
Changes:
- Split README tag documentation into stable release tags, development preview tags (
dev-*), and pinned release tags. - Updated
build/prepare-release.shto rewrite semantic versions only within### Pinned release tags(and fail when the expected pattern is missing). - Expanded
build/test-prepare-release.shto validate the new “rewrite only pinned tags” behavior and heading-boundary behavior.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/universal/README.md | Adds explicit “Release tags” and “Development tags” sections to separate stable vs preview guidance. |
| src/typescript-node/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/rust/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/ruby/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/python/README.md | Adds dev-* section and pinned tag section (but heading structure needs a small fix—see comments). |
| src/php/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/miniconda/README.md | Adds dev-* section and pinned tag section (but heading structure needs a small fix—see comments). |
| src/jekyll/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/javascript-node/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/java/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/java-8/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/go/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/dotnet/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/cpp/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/base-ubuntu/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/base-debian/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/base-alpine/README.md | Introduces dev-* documentation and separates pinned tags from general release tags. |
| src/anaconda/README.md | Adds dev-* section and pinned tag section (but heading structure needs a small fix—see comments). |
| README.md | Adds guidance to check dev-* tags before filing stable-tag issues. |
| build/test-prepare-release.sh | Updates tests to assert only pinned-tag examples are rewritten and boundaries are respected. |
| build/prepare-release.sh | Restricts README rewriting to the ### Pinned release tags section and errors when missing. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This was
linked to
issues
Aug 26, 2026
Rezam7117
approved these changes
Aug 26, 2026
|
68rezaa68 |
Rezam7117
approved these changes
Aug 26, 2026
Rezam7117
approved these changes
Aug 26, 2026
…into fix-base # Conflicts: # src/anaconda/README.md # src/miniconda/README.md # src/python/README.md
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
Separates
dev-*preview tags from stable release tags across image READMEs and limits the release-preparation README rewrite to pinned stable tag examples.Current Issue
The repository has separate development and stable publication flows:
mainand published asdev-*tags.READMEs previously presented these tags together, making it unclear which image variants are available only as development previews. In addition,
prepare-release.shrewrote every matching semantic version reference in a README, including content outside the release-tag examples.Changes
dev-*);dev-*preview tag for each released image.build/prepare-release.shso it:### Pinned release tags;##and###headings;build/test-prepare-release.shto verify that:Release Behavior
This keeps the existing release policy: the release-preparation workflow calculates the final manifest patch version and updates the corresponding pinned tag examples. Stable publication remains a maintainer-owned release responsibility; if an image push fails, the existing re-push workflow should complete the same release rather than leaving it incomplete.
Validation
bash build/test-prepare-release.shdev-*section and a compatible pinned semantic tag.git diff --check