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

Duplicate Environments - Find a New Way to Preview PRs? #155

Closed
jukent opened this issue Sep 16, 2021 · 2 comments · Fixed by #175
Closed

Duplicate Environments - Find a New Way to Preview PRs? #155

jukent opened this issue Sep 16, 2021 · 2 comments · Fixed by #175
Labels
infrastructure Infrastructure related issue

Comments

@jukent
Copy link
Contributor

jukent commented Sep 16, 2021

The ReadtheDocs builds have all been failing on excessive memory consumption. A fix in #154 has been implemented to allow us to move forward on other PRs.

However this is an infrastructure band-aid that requires us to both have an environment.yaml file for the Conda builds and a requirements.txt file (names vary slightly) that PiP can read for the ReadtheDocs build.

Ideally we won't have duplication of the dependencies in 2 separate files. Let's investigate other approaches.

@brian-rose proposes that instead of Readthedocs, we build the PR on GitHub Actions (using the same build environment as our main build) and then display the rendered site on Netlify.

@jukent jukent added the infrastructure Infrastructure related issue label Sep 16, 2021
@brian-rose
Copy link
Member

Thanks @jukent. I don't know if my proposed solution is feasible, but it would mirror how we preview PRs for the Foundations site. That site does not use Readthedocs because of the lack of support for JupyterBook. @andersy005 is working on documenting the Netlify-based preview workflow for Foundations over at ProjectPythia/pythia-foundations#85.

One question is whether we would lose any useful features from readthedocs. Since we're only using it for previews, as opposed to keeping track of different versions of documentation, my guess is that the answer is no. We just need something that will display the rendered html for our site in a way that's consistent with what we'll see after the PR is merged.

@brian-rose
Copy link
Member

Closing the loop on this:

The bandaid solution in #154 is not needed anymore since #167 where we moved to GitHub Actions + Netlify for previews.

The final actions to close this are (I think):

  1. Remove readthedocs and the pip environment file (no longer needed)
  2. Update the screenshot and instructions on https://github.com/ProjectPythia/projectpythia.github.io/blob/main/CONTRIBUTING.md to show contributors what the preview link looks like now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Infrastructure related issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants