From 9e80117a3b5e758a8afa0a28e1010ba70feb1c26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=BAnar=20Berg?= Date: Wed, 12 Mar 2025 21:51:24 -0700 Subject: [PATCH] Deploy docs from github actions As well as serve the library used by the docs from gh-pages. Also updated other github actions --- .github/workflows/ci.yml | 20 ++++++------ .github/workflows/docs.yml | 62 ++++++++++++++++++++++++++++++++++++++ .npmignore | 1 + docs/index.html | 5 +-- 4 files changed, 74 insertions(+), 14 deletions(-) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 67aa709..aec00cb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,10 +11,10 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Use Node.js - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: lts/* cache: npm @@ -29,10 +29,10 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Use Node.js - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: lts/* cache: npm @@ -47,10 +47,10 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Use Node.js - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: lts/* cache: npm @@ -65,10 +65,10 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Use Node.js - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: lts/* cache: npm @@ -83,10 +83,10 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Use Node.js - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: lts/* cache: npm diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..a4ba07e --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,62 @@ +name: Docs + +on: + push: + branches: ["main"] + pull_request: + branches: [main] + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: lts/* + check-latest: true + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Build library + run: npm run build + + - name: Move library to docs + run: mv dist docs/ + + - name: Upload static files as artifact + id: deployment + uses: actions/upload-pages-artifact@v3 + with: + path: docs/ + + deploy: + needs: build + + runs-on: ubuntu-latest + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + steps: + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.npmignore b/.npmignore index 8556f13..05739a3 100644 --- a/.npmignore +++ b/.npmignore @@ -1,3 +1,4 @@ +.github/ .nyc_output/ coverage/ demo/ diff --git a/docs/index.html b/docs/index.html index de00407..6a14865 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10,10 +10,7 @@ - +