Add a GitHub Actions workflow to build and publish the docs #144
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
AhmetCanSolak
approved these changes
Feb 16, 2023
There was a problem hiding this comment.
Thank you, @keithchev, looks great. I think we can give this beta feature a try.
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.
This PR adds a GitHub Actions workflow to build and publish the docs to the repo's GitHub Pages site (which is
czbiohub.github.io/copylot). The action is triggered on pushes tomainand can also be triggered manually from the 'Actions' tab of the repo's main github page.Note that in order for this workflow to be triggered, it must first be merged into
main, and then a repo admin must set the 'source' for the repo's pages site to 'github actions' (instead of 'deploy from a branch'). This setting is in the 'pages' section of the repo settings.Note that using github actions to deploy static assets to github pages is still in beta. I tested this workflow on my fork and it appears to work as expected.