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

Set up GitHub actions for build #1

Open
rwegener2 opened this issue Jun 10, 2024 · 0 comments
Open

Set up GitHub actions for build #1

rwegener2 opened this issue Jun 10, 2024 · 0 comments

Comments

@rwegener2
Copy link
Contributor

rwegener2 commented Jun 10, 2024

What is the current state?

This issue addresses bumps in the workflow for deploying the jupyter book. Right now the book is deployed usingghp-import which adds changes to a a branch called gh-pages when a user runs the ghp-import command on their computer.

What is the problem?

Use of ghp-import means that a user must manually build and deploy the website after a PR to main has been approved. This is a step that could be automated and could also cause issues with the build if someone tries to build and deploy the new change that wasn't the contributor and their environment is not in sync.

What is the ideal end state? Is there a solution yet? (optional)

It would make for a smoother contribution process if docs were build and deployed automatically when new code is merged to main. Github actions can be used for this.

Open questions:

  • right now the contents of _build is not present in the main branch, only the gh-pages branch. Do we want the raw HTML in the main branch, or should we keep that in a separate branch?
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

No branches or pull requests

1 participant