ci: split docs deployment from publisher and deploy directly to pages #1370
Conversation
This file contains 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
Add a new `get` subcommand for querying the file name of the release binary for a given target triplet. This will be used for obtaining generated docs.
Documentation will now be built using a separated workflow that will be run whenever publisher finishes. This allows us to use the latest page deployment code regardless of the commit that triggered publisher. Some auxilliary changes also come along: - New deploy-docs workflow can also be run manually. - "Generated docs" artifacts are now removed. Instead the generated documentation will be obtained from the release tarball for Linux. This is done since artifacts have a timeout to them, which meddle with our ability to run docs deployment at will. - Implemented basic version segmentation: `/devel` subdirectory will now contain the latest devel docs.
alaviss
force-pushed
the
push-pqqwpmqrppps
branch
from
7d7c223
to
bd8a449
Compare
saem
added
documentation
saem
approved these changes
Jul 5, 2024
Co-authored-by: Saem Ghani <saemghani+github@gmail.com>
|
/merge Here we go |
|
Merge requested by: @alaviss Contents after the first section break of the PR description has been removed and preserved below:
|
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
Documentation will now be built using a separated workflow that will be
run whenever publisher finishes. This allows us to use the latest page
deployment code regardless of the commit that triggered publisher.
Details
getsub-command torelease_manifest, which allows one toextract binary archive name from a release manifest.
documentation will be obtained from the release tarball for Linux amd64.
This allows docs publishing to run regardless of whether the artifact
for the latest release has expired or not.
gh-pagesbranch and deploydirectly using
actions/deploy-pages. This allows us to drop theheavyweight
gh-pagesbranch and remove the latency between push andpage being deployed.
prior failure.
devel./develsub-folder.This is preliminary setup for versioned docs in the future.