Conversation
/en/java/latest/ 403s on the live site — nothing has published under a port version prefix. This lets docs-site publish without merging. libtmux/docs builds the tree: build-site.sh renders the shared prose with this port's code fences, reading this checkout for the examples those pages quote, which is why LIBTMUX_DOCS_CHECKOUT_JAVA points at it. javadoc.io remains the canonical Java API reference; this is the prose tree only. Drop docs-site from the trigger in the change that merges to master.
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.
/en/java/latest/returned 403 on libtmux.org — nothing had ever published under a port version prefix, so every versioned port link on the site landed on an S3 error page. This branch publishes it. It is now live and serving 200.What this is
A temporary
DO NOT MERGEcommit:docs-siteis in the workflow's push trigger so the tree can be published without merging anything. Dropdocs-sitefrom that trigger in whatever change eventually merges to master — otherwise an unreviewed commit on a docs branch can overwrite the published tree.How it works
The tree is built by
libtmux/docs, not here. Itsscripts/build-site.shrenders the shared concepts, guides and examples with this port's code fences, reading this checkout for the example sources those pages quote — hence the two checkouts andLIBTMUX_DOCS_CHECKOUT_JAVA.Both references to
libtmux/docspin one full-length SHA with the release in a trailing comment, rather than a tag. This repo runs that repo's build script under a role that writes the live bucket, and a tag can be repointed. They must be bumped together — the checkout governs what runs, theuses:governs the publish contract.Published with
is-default: false, so the tree is reachable and linkable but stays out of the search index and the bare port root still falls through to the landing page.Notes
docsenvironment was auto-created without protection rules. Its deployment branch policy is what restricts which refs may publish and should be added.