Skip to content
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

Merged
merged 10 commits into from
Nov 28, 2022
Merged

Update gh-pages with a circleci job #392

merged 10 commits into from
Nov 28, 2022

Conversation

jdahm
Copy link
Contributor

@jdahm jdahm commented Nov 23, 2022

Purpose

Updates the documentation on the gh-pages for every merge to main.

TODO:

  • Check that this works
  • Add credentials
  • Ensure it only executes on commits on main

Infrastructure changes:

  • Adds a new CircleCI job.

@jdahm jdahm requested a review from mcgibbon November 23, 2022 02:01
- run:
name: Move into place
command: |
git clone --branch gh-pages [email protected]:ai2cm/pace.git gh-pages
Copy link
Collaborator

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.

Copy link
Contributor Author

@jdahm jdahm Nov 28, 2022

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.

Copy link
Contributor Author

@jdahm jdahm Nov 28, 2022

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.

Copy link
Collaborator

@elynnwu elynnwu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jdahm jdahm merged commit 3917938 into main Nov 28, 2022
@jdahm jdahm deleted the feature/update-gh-pages branch November 28, 2022 18:49
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.

3 participants