From c6dcb716f68168eae91a9557f3ff18878fdf5e2f Mon Sep 17 00:00:00 2001 From: zorkow Date: Thu, 17 Jul 2025 14:09:16 +0200 Subject: [PATCH 1/3] Workflow for typedocs of master sources --- .github/workflows/docs.yml | 56 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000000..3382be9cff --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,56 @@ +name: Docs + +on: + push: + branches: + - feature/tsdoc + +# Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + docs: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + name: Generate Code Docs + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + repository: mathjax/mathjax-src + + - uses: pnpm/action-setup@v4 + name: Install pnpm + with: + version: 10 + run_install: false + + - name: Install packages + run: pnpm i + + - name: Build docs + run: pnpm typedoc + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload docs folder + path: './docs' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 From 1a08b98b1d9b0093e6bbd7db90e7b5443c27055b Mon Sep 17 00:00:00 2001 From: zorkow Date: Fri, 18 Jul 2025 16:58:09 +0200 Subject: [PATCH 2/3] temporarily checkout develop branch of src --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3382be9cff..c59f86ddc4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -32,6 +32,7 @@ jobs: uses: actions/checkout@v4 with: repository: mathjax/mathjax-src + ref: develop - uses: pnpm/action-setup@v4 name: Install pnpm From 49694ec5af9d514ab5e0697400f3985948408212 Mon Sep 17 00:00:00 2001 From: zorkow Date: Fri, 18 Jul 2025 17:25:00 +0200 Subject: [PATCH 3/3] execute action on push to master branch --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c59f86ddc4..3c746531e3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,7 +3,7 @@ name: Docs on: push: branches: - - feature/tsdoc + - master # Allows you to run this workflow manually from the Actions tab workflow_dispatch: