Skip to content

Conversation

@alxndrsn
Copy link
Contributor

@alxndrsn alxndrsn commented Aug 18, 2023

Add github action allowing manual building of the docs website from master, or any branch which includes .github/workflows/github-pages.yml with on: 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 on pouchdb.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:

Screenshot_2023-08-21_09-37-34

Run Workflow dialog:

Screenshot_2023-08-21_09-37-47

@alxndrsn alxndrsn marked this pull request as ready for review August 29, 2023 05:43
@alxndrsn alxndrsn mentioned this pull request Sep 6, 2023
@alxndrsn alxndrsn marked this pull request as draft September 11, 2023 09:26
@alxndrsn
Copy link
Contributor Author

This PR needs to be updated to modify existing .github/workflows/docs.yml instead of adding a new GHA workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant