Docs(ci[deploy]): Publish each release's docs from source - #39
Merged
Merged
Conversation
why: libtmux.org served one tree for this port, latest, rendered from the API model libtmux/docs had last committed rather than from this repository's source, and no release could be read on its own. what: - Publish latest from master, and each v* tag as its own version plus an alias: next for a prerelease, stable (the default) for a release - Accept workflow_dispatch inputs (source-ref, version, version-kind, is-default, resolves-to, publish), so any ref can be published on demand - Build through libtmux/docs's port-docs.yml, which regenerates the reference from the selected commit, and publish through its reusable-deploy.yml, both pinned to one commit - Build pull requests at their merge commit without publishing, and queue only the publish job, so a pull request never delays a deploy
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.
Part of libtmux/docs#27. libtmux.org serves one tree for this port,
latest, rendered from the API model libtmux/docs last committed rather than from this repository's source. No release can be read on its own. This follows libtmux/libtmux-rs#37.What it publishes
master→/en/java/latest/. It is the default until the first stable release, and after thatstableis.v*tag →/en/java/<version>/, plus an alias:nextfor a prerelease,stable(the default) for a release.latestat their merge commit and publish nothing.How
port-docs.yml(Build any port's versioned docs from its source docs#36). It decides the versions from the event, verifies the selected commit, and regenerates the API reference from it. Publishing is itsreusable-deploy.yml. Both are pinned to one libtmux/docs commit, and this repository holds no second pin.workflow_dispatchinputs (source-ref,version,version-kind,is-default,resolves-to,publish) publish any ref on demand.The
docsenvironment admitsmasterandv*tags only (infrastructure Terraform, applied), and the port role trusts onlyreusable-deploy.ymlby itsjob_workflow_refclaim.Merge after libtmux/docs#36. The pin is that PR's head commit, which its merge commit keeps in libtmux/docs
main's history.