-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update gh-pages with a circleci job #392
Conversation
- run: | ||
name: Move into place | ||
command: | | ||
git clone --branch gh-pages [email protected]:ai2cm/pace.git gh-pages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you merge this plan with the doctest plan? These should only be pushed if doctests pass anyways.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I can tell these two plans are doing different things, and should be run at different times, so I'm not sure what commonality there is to merge them. The new plan push_docs
builds and pushes docs when a PR is merged to main
, while the doctest
plan tests that the sphinx docs build and the snippets run without error on any change to a PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, this will only run if the doctest
plan passes, since that is a branch protection requirement. However, we don't want this running every time the doctest
passes, since that would mean changes in PRs affect the "prod" instance of the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Purpose
Updates the documentation on the
gh-pages
for every merge tomain
.TODO:
main
Infrastructure changes: