Repository navigation
Add a manual workflow to deploy the docs to gh-pages - #42922
Merged
Merged
Conversation
Publishing the docs meant building the site and pushing it to gh-pages by hand. This adds a workflow_dispatch job that builds the site, then copies it over a gh-pages checkout with rsync. The copy omits --delete, so every older docs/<version> directory survives while the root files and the current version get replaced. The job uses no third-party actions. GitHub's own Pages actions replace the whole site on each deploy, so they cannot keep the version archive. Also drop release-drafter. The release UI now generates the notes, and .github/release.yml keeps the same label categories.
mdo
added
meta
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
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
2 participants
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.
Deploying the docs meant building the site and pushing it to
gh-pagesby hand. This adds a manual workflow and retires release-drafter..github/workflows/docs-deploy.yml, aworkflow_dispatchjob that runsnpm run distandnpm run docs-build, then copies_site/over agh-pagescheckout withrsync.--deletefrom thersync, so every olderdocs/<version>directory survives while the root files and the current version get replaced. Each build holds one version only.actions/upload-pages-artifactandactions/deploy-pages) replace the whole site on each deploy, so they cannot keep the version archive, and they need the Pages source moved off the branch.gh-pages..github/workflows/release-notes.ymland.github/release-drafter.yml. The release UI generates the notes now..github/release.ymlso the generated notes keep the same label categories the drafter used.nojekyllto.cspell.jsonfor the new workflow.Dispatch the workflow from the branch you want to publish, for example
gh workflow run docs-deploy.yml --ref v6-dev.