Skip to content

CI, DOC: Separate docs build from CI test jobs, deployment#53

Merged
tylerjereddy merged 24 commits intomainfrom
nray/deploy_docs
Feb 26, 2026
Merged

CI, DOC: Separate docs build from CI test jobs, deployment#53
tylerjereddy merged 24 commits intomainfrom
nray/deploy_docs

Conversation

@nray
Copy link
Collaborator

@nray nray commented Feb 5, 2026

This PR does the following:

  1. Separate docs run from the base CI.
  2. Separate docs deployment from the other CI runs.

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:

  • Re-test the deployment.
  • Remove the test branch from the deployment config, and merge this PR, delete test-branch.
  • The merge should invoke a deployment job from the main repo, and the docs should now correspond to the main branch. Ensure, links are working correctly there. Also, once the PR is merged, we should be able to see a "Run Workflow" button for the deploy job from the UI. That should help with launching the deployment manually.

Further things to do (not necessarily as part of this PR) :

  • Deploy docs corresponding to released tags (this seems doable with github actions), however, we need to make sure that the links to the code source's from the method api's should point to the correct tagged version of the code.
  • Explore using circleci. Circleci, to my understanding, is another CI/CD framework, many existing codes use it, including scikit-learn. And a brief search says that it can support deployments from PR's. So, definitely worth further exploration.

@tylerjereddy tylerjereddy added this to the 0.2.0 milestone Feb 5, 2026
@tylerjereddy tylerjereddy added continuous integration documentation Improvements or additions to documentation labels Feb 5, 2026
@tylerjereddy
Copy link
Collaborator

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.

@nray
Copy link
Collaborator Author

nray commented Feb 25, 2026

@tylerjereddy : Ready for final review. The circle ci / tag-specific deployments would be in a separate PR.

@tylerjereddy tylerjereddy changed the title WIP, CI, DOC: Separate docs build from CI test jobs, deployment CI, DOC: Separate docs build from CI test jobs, deployment Feb 26, 2026
Copy link
Collaborator

@tylerjereddy tylerjereddy left a comment

Choose a reason for hiding this comment

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

Thanks -- I just made one suggestion, rest seems "ok" modulo test-docs-deployment branch cleanup stuff.

run: |
ruff check
- name: lint and build docs
- name: lint docs
Copy link
Collaborator

Choose a reason for hiding this comment

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

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?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Fixed.

@nray
Copy link
Collaborator Author

nray commented Feb 26, 2026

Thanks -- I just made one suggestion, rest seems "ok" modulo test-docs-deployment branch cleanup stuff.

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.

@tylerjereddy tylerjereddy merged commit 7c6c7b1 into main Feb 26, 2026
19 checks passed
@tylerjereddy tylerjereddy deleted the nray/deploy_docs branch February 26, 2026 04:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

continuous integration documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC, CI, MAINT: deploying docs DOC, CI: only need to build/lint docs once in the CI

2 participants