From 931698b6a6d239447614ebb0e4c9d407f29898a9 Mon Sep 17 00:00:00 2001 From: Joel Sahleen Date: Sun, 19 Jul 2026 17:45:11 -0600 Subject: [PATCH 1/3] chore: Add GitHub Actions workflow for GitHub Pages deployment This workflow automates the deployment of static content to GitHub Pages upon pushes to the main branch or manually via the Actions tab. --- .github/workflows/static.yml | 43 ++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 .github/workflows/static.yml diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml new file mode 100644 index 0000000..460f782 --- /dev/null +++ b/.github/workflows/static.yml @@ -0,0 +1,43 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # 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: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: '.' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v5 From c6cdfe0ff1c58cb1f09b0c2e9909d3055565851a Mon Sep 17 00:00:00 2001 From: Joel Sahleen Date: Sun, 19 Jul 2026 17:53:01 -0600 Subject: [PATCH 2/3] chore: Add GitHub Actions workflow for deploying static content to GitHub Pages This new workflow automates the deployment of static documentation to GitHub Pages on pushes to the main branch or via manual triggers from the Actions tab. --- .github/workflows/docs.yml | 51 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 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 0000000..1b5f793 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,51 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # 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: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version-file: .nvmrc + cache: npm + - name: Install dependencies + run: npm clean-install + - name: Generate docs + run: npm run docs + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: '/docs' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v5 From f5203c2bd007b113ad88d3abe3b86bdd3617b095 Mon Sep 17 00:00:00 2001 From: Joel Sahleen Date: Sun, 19 Jul 2026 17:57:20 -0600 Subject: [PATCH 3/3] chore: update GitHub Actions workflows for documentation deployment Modified the path for the documentation artifact upload in the docs.yml workflow and removed the obsolete static.yml workflow to streamline the deployment process to GitHub Pages. --- .github/workflows/docs.yml | 2 +- .github/workflows/static.yml | 43 ------------------------------------ 2 files changed, 1 insertion(+), 44 deletions(-) delete mode 100644 .github/workflows/static.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1b5f793..0894762 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -45,7 +45,7 @@ jobs: - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: - path: '/docs' + path: 'docs' - name: Deploy to GitHub Pages id: deployment uses: actions/deploy-pages@v5 diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml deleted file mode 100644 index 460f782..0000000 --- a/.github/workflows/static.yml +++ /dev/null @@ -1,43 +0,0 @@ -# Simple workflow for deploying static content to GitHub Pages -name: Deploy static content to Pages - -on: - # Runs on pushes targeting the default branch - push: - branches: ["main"] - - # 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: - # Single deploy job since we're just deploying - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Setup Pages - uses: actions/configure-pages@v5 - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - # Upload entire repository - path: '.' - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v5