Add gh actions workflow to build api docs to gh-pages #24
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
.github/workflows/ci.yml
Outdated
| push: | ||
| branches: [ master ] | ||
| pull_request: | ||
| branches: [ master ] |
There was a problem hiding this comment.
Very cool! Two little questions:
- I don't know much about GitHub CI, but if the action (and with it the deployment of gh-pages) is run on pull requests, doesn't that mean that the API documentation is updated even for unmerged PRs?
- Could it make more sense to only run this action when a new tag/release is created? I'm undecided on this.
There was a problem hiding this comment.
You are right.
I've now split into 2 workflows.
The first on builds the docs on every push, pr (for testing).
The second runs if a new tag is created and pushes to gh-pages.
tong
force-pushed
the
action-build-doc-pages
branch
from
aa44884
to
de6fdb7
Compare
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.
Like:
https://github.com/tong/armsdk/actions
→
https://tong.github.io/armsdk/
… to never have have outdated docs again.