chore: setup docs with docusaurus (#67)

Author: mdjastrzebski

.github/actions/setup-website/action.yml

@@ -0,0 +1,24 @@
+name: Setup Website deps
+description: Setup Node.js and install website dependencies
+
+runs:
+  using: composite
+  steps:
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version-file: .nvmrc
+
+    - name: Cache website deps
+      id: yarn-cache-website
+      uses: actions/cache@v4
+      with:
+        path: |
+          ./website/node_modules
+          ./website/yarn/install-state.gz
+        key: website-${{ runner.os }}-yarn-${{ hashFiles('./website/yarn.lock') }}
+
+    - name: Install website deps
+      if: steps.yarn-cache-website.outputs.cache-hit != 'true'
+      run: cd ./website && yarn install --immutable
+      shell: bash

.github/actions/setup/action.yml

@@ -5,13 +5,13 @@ runs:
   using: composite
   steps:
     - name: Setup Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version-file: .nvmrc
 
     - name: Cache dependencies
       id: yarn-cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: |
           **/node_modules

.github/workflows/ci.yml

@@ -10,9 +10,10 @@ on:
 jobs:
   lint:
     runs-on: ubuntu-latest
+    name: Lint and Typecheck
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -25,9 +26,10 @@ jobs:
 
   test:
     runs-on: ubuntu-latest
+    name: Test
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
@@ -42,13 +44,26 @@ jobs:
 
   build-library:
     runs-on: ubuntu-latest
+    name: Build Library
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup
         uses: ./.github/actions/setup
 
       - name: Build package
         run: yarn prepare
 
+  test-website:
+    runs-on: ubuntu-latest
+    name: Test Website
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js and website deps
+        uses: ./.github/actions/setup-website
+
+      - name: Build website
+        run: cd ./website && yarn build

.github/workflows/docs-deploy.yml

@@ -0,0 +1,37 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup
+        uses: ./.github/actions/setup-website
+
+      - name: Build website
+        run: cd ./website && yarn build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com