ci: deploy docs to github pages #65
Merged
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
|
You will need to update your settings at "settings>pages" |
|
Ideally, we should not have the "gh-pages" branch. But it is a good start. we can update it in the future (incremental change) |
This patch adds a new job to the GitHub workflow to generate docs and deploy them to GH pages. The job is only triggered when the PR is merged into the "main" branch. It needs access to the "GITHUB_TOKEN" of the repo owner. It will push the "target/doc" directory to a branch called "gh-pages" in the roo directory. The repo owner will need to update the repo settings to make GitHub deploy to this directory.
|
@neuodev Looks good! I'll add this for now, but we might want to deploy to different systems. I have a |
|
I can see that the job is skipped for some reason. |
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 patch adds a new job to the GitHub workflow to generate docs and deploy them to GH pages.
The job is only triggered when the PR is merged into the "main" branch. It needs access to the "GITHUB_TOKEN" of the repo owner. It will push the "target/doc" directory to a branch called "gh-pages" in the root directory.
The repo owner will need to update the repo settings to make GitHub deploy to this directory.