Merged
Conversation
| sed -i.bak "s/^prerelease:.*/prerelease: $PRERELEASE/" docs/antora.yml | ||
| rm -f docs/antora.yml.bak | ||
| else | ||
| printf 'prerelease: %s\n' "$PRERELEASE" >> docs/antora.yml |
There was a problem hiding this comment.
Missing leading newline in prerelease printf append
Low Severity
The printf for appending prerelease omits the leading \n that the display_version printf includes. If docs/antora.yml doesn't end with a trailing newline and only prerelease is being appended (no display_version), the prerelease: key gets concatenated onto the last line of the file, producing invalid YAML. The format string here likely needs '\nprerelease: %s\n' to match the display_version pattern.
Additional Locations (1)
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
Compatibility
Defaults preserve the current behavior for existing consumers.
Note
Low Risk
Low risk workflow/action changes that are opt-in and default to existing behavior; main risk is misconfiguration of new inputs affecting docs versioning during release/deploy.
Overview
Adds optional Antora versioning controls to the release automation. The
update-antora-versioncomposite action can now also setdisplay_versionandprereleaseindocs/antora.yml(updating existing keys or appending them when missing), andrelease.ymlexposes inputs to override the version used plus pass through these new fields.Extends the reusable
docs.ymlworkflow to accept checkoutfetch-depthandfetch-tagsinputs so callers can fetch full history/tags when Antora needs tag/branch discovery.Written by Cursor Bugbot for commit be8df16. This will update automatically on new commits. Configure here.