docs: sync README container tags with releases via release-please (CRY-59) - #148
Merged
Conversation
…Y-59) Readme.adoc hardcoded container image tags at :v0 even though the project has been at v1.x since well before the current v1.13.2. ci/publish.sh already generates cascading tags (v1.13.2 → v1.13 → v1), so :v0 has pointed at outdated images. - Add AsciiDoc document attributes (:image-major-tag, :image-pin-example) wrapped in x-release-please-start-major and x-release-please-start-version markers so release-please keeps them current automatically on every release. - Add subs="attributes+" to the container source block so the attributes render in GitHub's Asciidoctor view; callout numbers are unaffected. - Register Readme.adoc in .release-please-config.json extra-files (same generic mechanism already used for app/mix.exs). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ticks
AsciiDoc inline code spans (backtick-delimited) suppress attribute
substitution, so `:{image-major-tag}` and `:{image-pin-example}` would
render literally rather than expanding to `:v1` and `:v1.13.2`. Use
literal values in the callout text instead. The source block examples
(inside the [source,sh,subs="attributes+"] block) correctly expand
{image-major-tag} because attribute substitution is explicitly enabled
there. The document attribute definitions and release-please markers at
the top of the file are unaffected.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Member
Author
Follow-up fix: callout text attribute refs inside backticksThe prior commit used Fixed by using literal |
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
Readme.adochardcoded:v0container image tags, but the project is at v1.13.2;:v0points at long-outdated imagesci/publish.shalready generates cascading tags (v1.13.2 → v1.13 → v1), so:v1is the correct floating tagx-release-please-start-major/x-release-please-start-versionmarkers so release-please updates them automatically on every release going forwardReadme.adocin.release-please-config.jsonextra-files(same mechanism asapp/mix.exs)Changes
Readme.adoc: add:image-major-tag:and:image-pin-example:attributes under release-please markers; addsubs="attributes+"to the container source block; replace hardcoded:v0/:v0.1.2with attribute references.release-please-config.json: addReadme.adocas a generic extra-file entryTest plan
:{image-major-tag}renders as:v1in GitHub's AsciiDoc preview<1>/<2>still render correctly withsubs="attributes+"Readme.adocattributes andapp/mix.exsversion are bumped togetherCloses: https://linear.app/the-rubyists/issue/CRY-59
🤖 Generated with Claude Code