From b8669685fc563d9ff143b614d513f018cbf954ad Mon Sep 17 00:00:00 2001 From: James Bruten <109733895+james-bruten-mo@users.noreply.github.com> Date: Fri, 13 Feb 2026 13:48:20 +0000 Subject: [PATCH 1/4] add um_utils docs --- .github/files/index.html | 24 +++++++++++++++++ .github/workflows/docs.yaml | 52 +++++++++++++++++++------------------ 2 files changed, 51 insertions(+), 25 deletions(-) create mode 100644 .github/files/index.html diff --git a/.github/files/index.html b/.github/files/index.html new file mode 100644 index 0000000..116e3c0 --- /dev/null +++ b/.github/files/index.html @@ -0,0 +1,24 @@ + + + + Mule and UM Utils Documentation + + + + +

Mule and UM Utils Documentation

+ +
+

User Guide

+ +
+ + + diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 809eb27..1281d9c 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -17,51 +17,53 @@ permissions: read-all jobs: - build-docs: + build-and-deploy-docs: runs-on: ubuntu-latest - timeout-minutes: 3 + timeout-minutes: 5 + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} steps: - name: Checkout repository uses: actions/checkout@v4 + - name: Setup uv uses: astral-sh/setup-uv@v6 + - name: Install dependencies run: uv sync && uv pip install ./mule ./um_utils + - name: Build mule docs run: uv run make clean html --directory ./mule/docs working-directory: ${{ github.workspace }} + - name: Build um_utils docs run: uv run make clean html --directory ./um_utils/docs working-directory: ${{ github.workspace }} - # - id: permissions - # name: Set permissions - # run: | - # chmod -c -R +rX "./doc/_build/html/" + + # Deploy Steps + - name: Copy Built Documentation + if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' + run: | + cp -r ./mule/docs/build/html .github/files/mule + cp -r ./um_utils/docs/build/html .github/files/um_utils + - name: Upload artifacts + if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' uses: actions/upload-pages-artifact@v4 with: name: github-pages - path: ./mule/docs/build/html - - name: Minimize uv cache - if: always() - run: uv cache prune --ci + path: .github/files - # Deploy job - deploy: - if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' - # Add a dependency to the build job - needs: build-docs - permissions: - pages: write # to deploy to Pages - id-token: write # to verify the deployment originates from an appropriate source - # Deploy to the github-pages environment - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - # Specify runner + deployment step - runs-on: ubuntu-latest - steps: - name: Deploy to GitHub Pages + if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' id: deployment uses: actions/deploy-pages@v4 + + - name: Minimize uv cache + if: always() + run: uv cache prune --ci From eca29c160aa1fc148d53842efec206a6d1fd7071 Mon Sep 17 00:00:00 2001 From: James Bruten <109733895+james-bruten-mo@users.noreply.github.com> Date: Fri, 13 Feb 2026 13:57:07 +0000 Subject: [PATCH 2/4] revert to 2 jobs --- .github/workflows/docs.yaml | 40 ++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 1281d9c..28a12f0 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -17,15 +17,9 @@ permissions: read-all jobs: - build-and-deploy-docs: + build-docs: runs-on: ubuntu-latest - timeout-minutes: 5 - permissions: - pages: write # to deploy to Pages - id-token: write # to verify the deployment originates from an appropriate source - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} + timeout-minutes: 3 steps: - name: Checkout repository @@ -57,13 +51,31 @@ jobs: uses: actions/upload-pages-artifact@v4 with: name: github-pages - path: .github/files - - - name: Deploy to GitHub Pages - if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' - id: deployment - uses: actions/deploy-pages@v4 + path: ./mule/docs/build/html - name: Minimize uv cache if: always() run: uv cache prune --ci + + # Deploy job + deploy: + if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' + + # Add a dependency to the build job + needs: build-docs + permissions: + pages: write # to deploy to Pages + id-token: write # to verify the deployment originates from an appropriate source + + # Deploy to the github-pages environment + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + # Specify runner + deployment step + runs-on: ubuntu-latest + + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 From bec6359b26e9c4ea6a515eb4b940340e43552e93 Mon Sep 17 00:00:00 2001 From: James Bruten <109733895+james-bruten-mo@users.noreply.github.com> Date: Fri, 13 Feb 2026 13:59:33 +0000 Subject: [PATCH 3/4] remove comment --- .github/files/index.html | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/files/index.html b/.github/files/index.html index 116e3c0..aa3883e 100644 --- a/.github/files/index.html +++ b/.github/files/index.html @@ -14,7 +14,6 @@

Mule and UM Utils Documentation

User Guide

From 890225f7a0111b0ed4c4b5e12049c87b38439651 Mon Sep 17 00:00:00 2001 From: James Bruten <109733895+james-bruten-mo@users.noreply.github.com> Date: Mon, 16 Feb 2026 08:09:27 +0000 Subject: [PATCH 4/4] remove template file --- .github/files/index.html | 23 ----------------------- .github/workflows/docs.yaml | 12 +++++++++--- 2 files changed, 9 insertions(+), 26 deletions(-) delete mode 100644 .github/files/index.html diff --git a/.github/files/index.html b/.github/files/index.html deleted file mode 100644 index aa3883e..0000000 --- a/.github/files/index.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - Mule and UM Utils Documentation - - - - -

Mule and UM Utils Documentation

- -
-

User Guide

- -
- - - diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 28a12f0..602fca8 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -43,15 +43,21 @@ jobs: - name: Copy Built Documentation if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' run: | - cp -r ./mule/docs/build/html .github/files/mule - cp -r ./um_utils/docs/build/html .github/files/um_utils + mkdir _docs + cp -r ./mule/docs/build/html _docs/mule + cp -r ./um_utils/docs/build/html _docs/um_utils + + echo '' > _docs/index.html - name: Upload artifacts if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request' uses: actions/upload-pages-artifact@v4 with: name: github-pages - path: ./mule/docs/build/html + path: ./_docs - name: Minimize uv cache if: always()