CI, DOC: Separate docs build from CI test jobs, deployment#53
CI, DOC: Separate docs build from CI test jobs, deployment#53tylerjereddy merged 24 commits intomainfrom
Conversation
|
I've edited the description based on which issues this WIP PR aims to address. Feel free to adjust if I got them wrong. Keeping them linked like that makes it easier to see which issues are already being worked on. |
b2f4f55 to
2b21363
Compare
|
@tylerjereddy : Ready for final review. The circle ci / tag-specific deployments would be in a separate PR. |
tylerjereddy
left a comment
There was a problem hiding this comment.
Thanks -- I just made one suggestion, rest seems "ok" modulo test-docs-deployment branch cleanup stuff.
.github/workflows/ci.yml
Outdated
| run: | | ||
| ruff check | ||
| - name: lint and build docs | ||
| - name: lint docs |
There was a problem hiding this comment.
gh-32 suggests that we only need to lint the docs in one CI job, so we can delete this part of the CI run now, right?
Sounds good, addressed your comment and removed the test-branch from deployment. Go ahead and merge this PR when the CI passes. I will delete the branch once I ensure that deployment from main happened as expected. |
This PR does the following:
For deployment, github action is used and the deployed page is at https://lanl.github.io/GFDL/.
Github pages restrict deployment from PR's, as a work-around, created a "test-docs-deployment" branch and added that to the list of branches from which pages can be deployed (Settings->Environment->github-pages->Deployment Branches and Tags) .
The deployment CI job currently would be invoked for push events to the main and the test branch.
To invoke a deployment, the test-branch has to be kept in sync with the PR branch.
What is left to do:
Further things to do (not necessarily as part of this PR) :