ci: publish the API reference from the release workflow - #139
Merged
Merged
Conversation
|
🎉 This PR is included in version 1.18.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
1 participant
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.
Publish the API reference from the release workflow so the HTML reference and downloadable specifications stay aligned with the source.
The job uses GitHub OIDC for AWS credentials and waits for the release job. It remains disabled until
AWS_DOCS_DEPLOY_ROLE_ARNis configured.DOCS_CLOUDFRONT_DISTRIBUTION_IDenables cache invalidation.The vendored renderer installs runtime dependencies only; its compiled CSS is already included.
Verify: built the reference on Node 22 from a clean source export; parsed the bundled and three per-API specifications; confirmed the HTML contains no unresolved head-tag placeholder. Workflow YAML parses and
git diff --checkpasses.Risk: S3 synchronisation uses
--delete, restricted to thedocs/api/prefix.