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

CI: Separate jobs to build and deploy documentation #3767

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

seisman
Copy link
Member

@seisman seisman commented Jan 12, 2025

Similar to #3742, it makes more sense to build and deploy documentation in separate jobs.

This PR splits the ci_docs.yaml workflow into two jobs:

  • build-docs: Build the documentation and upload the HTML files as artifacts
  • deploy-docs: Download the HTML artifacts and deploy to the gh-pages branch

The HTML artifacts can also be uploaded as release assets when making a release. It will be done in separate PRs (addressing #3731).

@seisman seisman added maintenance Boring but important stuff for the core devs needs review This PR has higher priority and needs review. labels Jan 12, 2025
@seisman seisman added this to the 0.15.0 milestone Jan 12, 2025
@seisman
Copy link
Member Author

seisman commented Jan 12, 2025

One disadvantage is that, the deployment job starts only after all the three matrix jobs in the build-docs job finish (there are no workarounds xref: https://github.com/orgs/community/discussions/42335).

Considering that the Windows job takes much longer (~ 7 minutes) than the Linux/macOS jobs (~ 3 minutes), maybe having separate jobs is not a good idea?

@seisman
Copy link
Member Author

seisman commented Jan 12, 2025

Let's keep it in a single job now. Will revisit this PR later.

@seisman seisman removed the needs review This PR has higher priority and needs review. label Jan 12, 2025
@seisman seisman marked this pull request as draft January 12, 2025 12:49
@seisman seisman removed this from the 0.15.0 milestone Jan 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant