From 4db4c24fb191f4bd227d9a03e2d8379bbdf4e65d Mon Sep 17 00:00:00 2001 From: Neil Vaytet Date: Tue, 24 Mar 2026 13:40:10 +0100 Subject: [PATCH 1/4] fix syntax for running pixi docs task in release workflow --- .github/workflows/docs-deploy.yml | 57 ------------------------------- .github/workflows/release.yml | 2 +- 2 files changed, 1 insertion(+), 58 deletions(-) delete mode 100644 .github/workflows/docs-deploy.yml diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml deleted file mode 100644 index bf87d2070..000000000 --- a/.github/workflows/docs-deploy.yml +++ /dev/null @@ -1,57 +0,0 @@ -name: Deploy docs - -on: - workflow_dispatch: - -jobs: - docs: - name: Build and deploy docs - runs-on: ubuntu-24.04 - permissions: - contents: write - strategy: - matrix: - package: [essreduce, essimaging, essnmx] - steps: - - uses: actions/checkout@v6 - with: - fetch-depth: 0 - - uses: prefix-dev/setup-pixi@v0.9.4 - with: - frozen: true - environments: docs-${{ matrix.package }} - - name: Build docs - run: pixi run -e docs-${{ matrix.package }} docs ${{ matrix.package }} - - uses: actions/upload-artifact@v4 - with: - name: docs-${{ matrix.package }} - path: packages/${{ matrix.package }}/html - - deploy: - name: Deploy site - needs: docs - runs-on: ubuntu-24.04 - permissions: - contents: write - steps: - - uses: actions/checkout@v6 - - uses: actions/download-artifact@v4 - with: - path: site - pattern: docs-* - merge-multiple: false - - name: Prepare site - run: | - mkdir -p gh-pages-site - for dir in site/docs-*; do - package="${dir#site/docs-}" - cp -r "$dir" "gh-pages-site/$package" - done - cp docs/index.html gh-pages-site/index.html - touch gh-pages-site/.nojekyll - - name: Build search index - run: npx pagefind@latest --site gh-pages-site --bundle-dir pagefind - - uses: JamesIves/github-pages-deploy-action@v4 - with: - branch: gh-pages - folder: gh-pages-site diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ba0610793..27c4f770a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -72,7 +72,7 @@ jobs: frozen: true environments: docs-${{ needs.determine-package.outputs.package }} - name: Build docs - run: pixi run -e docs-${{ needs.determine-package.outputs.package }} docs ${{ needs.determine-package.outputs.package }} + run: pixi run docs-${{ needs.determine-package.outputs.package }} - name: Prepare site run: | PACKAGE=${{ needs.determine-package.outputs.package }} From f18979aaf5321aea920153b7b7a32af2083514ce Mon Sep 17 00:00:00 2001 From: Neil Vaytet Date: Tue, 24 Mar 2026 13:56:26 +0100 Subject: [PATCH 2/4] add docs-deploy script back in --- .github/workflows/docs-deploy.yml | 56 +++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 .github/workflows/docs-deploy.yml diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml new file mode 100644 index 000000000..40f2d503a --- /dev/null +++ b/.github/workflows/docs-deploy.yml @@ -0,0 +1,56 @@ +name: Deploy docs + +on: + workflow_dispatch: + inputs: + package: + required: true + description: 'Select which package to build docs for' + publish: + default: false + type: boolean + branch: + description: 'Branch/tag with documentation source. If not set, the main branch will be used.' + default: 'main' + required: false + type: string + +jobs: + docs: + name: Build and deploy docs + runs-on: ubuntu-24.04 + permissions: + contents: write + steps: + - uses: actions/checkout@v6 + with: + ref: ${{ inputs.branch }} + fetch-depth: 0 + - uses: prefix-dev/setup-pixi@v0.9.4 + with: + frozen: true + environments: docs-${{ inputs.package }} + - name: Build docs + run: pixi run -e docs-${{ inputs.package }} docs ${{ inputs.package }} + - name: Prepare site + if: ${{ inputs.publish }} + run: | + PACKAGE=${{ inputs.package }} + git fetch origin gh-pages:gh-pages || true + git worktree add gh-pages-site gh-pages || mkdir -p gh-pages-site + rm -rf gh-pages-site/$PACKAGE + cp -r packages/$PACKAGE/html gh-pages-site/$PACKAGE + cp docs/index.html gh-pages-site/index.html + touch gh-pages-site/.nojekyll + - name: Build search index + if: ${{ inputs.publish }} + run: npx pagefind@latest --site gh-pages-site --bundle-dir pagefind + - uses: JamesIves/github-pages-deploy-action@v4 + if: ${{ inputs.publish }} + with: + branch: gh-pages + folder: gh-pages-site + - uses: actions/upload-artifact@v4 + with: + name: docs-${{ inputs.package }} + path: packages/${{ inputs.package }}/html From a60f4456dc84a2ed2c88caac5820c40fe48eb0c8 Mon Sep 17 00:00:00 2001 From: Neil Vaytet <39047984+nvaytet@users.noreply.github.com> Date: Tue, 24 Mar 2026 15:03:41 +0100 Subject: [PATCH 3/4] Update .github/workflows/docs-deploy.yml Co-authored-by: Jan-Lukas Wynen --- .github/workflows/docs-deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml index 40f2d503a..35aa51658 100644 --- a/.github/workflows/docs-deploy.yml +++ b/.github/workflows/docs-deploy.yml @@ -31,7 +31,7 @@ jobs: frozen: true environments: docs-${{ inputs.package }} - name: Build docs - run: pixi run -e docs-${{ inputs.package }} docs ${{ inputs.package }} + run: pixi run docs-${{ inputs.package }}}} - name: Prepare site if: ${{ inputs.publish }} run: | From d03edfdac6ca47ab33b119937b84eb9dccc4a39f Mon Sep 17 00:00:00 2001 From: Neil Vaytet Date: Tue, 24 Mar 2026 15:17:10 +0100 Subject: [PATCH 4/4] use choice input type --- .github/workflows/docs-deploy.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml index 35aa51658..5e3298391 100644 --- a/.github/workflows/docs-deploy.yml +++ b/.github/workflows/docs-deploy.yml @@ -6,6 +6,11 @@ on: package: required: true description: 'Select which package to build docs for' + type: choice + options: + - essreduce + - essimaging + - essnmx publish: default: false type: boolean