docs: build & deploy pouchdb.com on GitHub Pages #8734
Draft
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
Merged
|
This PR needs to be updated to modify existing |
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.
Add github action allowing manual building of the docs website from
master, or any branch which includes.github/workflows/github-pages.ymlwithon: workflow_dispatch.The aim of this PR is to replace the current hosting of pouchdb.com on a private server with Github Pages, and allow build & deploy of docs via Github Actions.
DNS changes will be required to make pouchdb.com point to the Github Pages version.
Currently, www.pouchdb.com forwards to pouchdb.com. This may need additional work to be supported. See: https://stackoverflow.com/questions/54817253/github-pages-https-www-redirect.
Depending on how pages deployments will be restricted, environment branch protection rules must be configured. E.g. to allow deploys to pages from random branches/tags: Settings > Environments > github-pages > Deployment Branches > All Branches
This branch currently deploys to https://alxndrsn.github.io/pouchdb/, and updates can be triggered from https://github.com/alxndrsn/pouchdb/actions/workflows/github-pages.yml. Currently missing stylesheets and with links broken, as it assumes the hosting root is
/, as it would be onpouchdb.com.Manual deploy will be available from the repo's Github Actions tab once the relevant action is in
master. It should look like this:Action View:
Run Workflow dialog: