Skip to content

Conversation

@tkoyama010
Copy link
Member

@tkoyama010 tkoyama010 commented May 21, 2025

Overview

This pull request optimizes the GitHub Actions documentation workflow by implementing parallel builds for HTML and internationalization (i18n) documentation. Previously, the workflow built documentation sequentially, which was slower and less efficient.

Changes Made

  • Parallel Build Strategy: Added a matrix strategy to build html and mini18n-html documentation targets simultaneously instead of sequentially
  • Artifact Management: Updated artifact naming to include the builder type (doc-build-html, doc-build-mini18n-html, etc.) to avoid conflicts between parallel builds
  • Deployment Optimization: Modified the deploy job to download and extract both build artifacts separately, then merge the i18n documentation into the main HTML build

Benefits

  • Faster Build Times: Parallel execution reduces overall CI/CD pipeline duration
  • Better Resource Utilization: Takes advantage of GitHub Actions' ability to run jobs concurrently
  • Improved Reliability: Separates concerns between different build types, making it easier to debug issues
  • Maintained Functionality: All existing documentation features (HTML docs, i18n support, notebook generation) continue to work as before

Technical Details

The workflow now:

  1. Runs HTML and mini18n-html builds in parallel using a matrix strategy
  2. Creates separate artifacts for each build type
  3. Downloads both artifacts in the deploy stage
  4. Merges i18n documentation into the main HTML build before deployment

This approach maintains backward compatibility while significantly improving build performance.

@github-actions
Copy link
Contributor

github-actions bot commented May 21, 2025

@tkoyama010 tkoyama010 marked this pull request as ready for review July 6, 2025 01:36
@tkoyama010 tkoyama010 enabled auto-merge (squash) July 6, 2025 01:38
@tkoyama010 tkoyama010 requested a review from banesullivan July 6, 2025 01:39
@tkoyama010 tkoyama010 requested review from Copilot and removed request for banesullivan July 10, 2025 15:49
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a GitHub Actions matrix to run both the standard and i18n documentation builds in parallel, updating build, artifact naming, and deploy steps accordingly.

  • Add matrix.builder strategy for html and mini18n-html targets
  • Consolidate separate build steps into one parameterized step and adjust artifact names
  • Update deploy jobs to download and extract both artifacts, then merge i18n output into the main site
Comments suppressed due to low confidence (1)

.github/workflows/doc.yml:119

  • [nitpick] There are two steps both named UnTar build, which can be confusing in logs. Rename them to e.g. UnTar HTML build and UnTar i18n build for clarity.
      - name: UnTar build

@tkoyama010
Copy link
Member Author

@pyvista-bot LGTM

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

✅ Approving this PR because tkoyama010 said so in here :shipit:

@tkoyama010 tkoyama010 merged commit 1c4d6f7 into main Jul 12, 2025
7 checks passed
@tkoyama010 tkoyama010 deleted the maint/matrix branch July 12, 2025 02:30
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

Successfully merging this pull request may close these issues.

2 participants