Skip to content

Add optional Antora versioning controls#8

Merged
jruaux merged 1 commit intomainfrom
codex/antora-compatible-versioning
Mar 25, 2026
Merged

Add optional Antora versioning controls#8
jruaux merged 1 commit intomainfrom
codex/antora-compatible-versioning

Conversation

@jruaux
Copy link
Copy Markdown
Contributor

@jruaux jruaux commented Mar 25, 2026

Summary

  • add optional checkout depth/tag inputs to the reusable docs workflow
  • add optional Antora version, display version, and prerelease inputs to the reusable release flow
  • extend the update-antora-version action to write optional display/prerelease metadata

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-version composite action can now also set display_version and prerelease in docs/antora.yml (updating existing keys or appending them when missing), and release.yml exposes inputs to override the version used plus pass through these new fields.

Extends the reusable docs.yml workflow to accept checkout fetch-depth and fetch-tags inputs 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.

@jruaux jruaux merged commit 6473321 into main Mar 25, 2026
2 checks passed
@jruaux jruaux deleted the codex/antora-compatible-versioning branch March 25, 2026 00:09
Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

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
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Fix in Cursor Fix in Web

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant