ci: automatic deployments

Author: AriPerkkio

.github/workflows/deploy.yml

@@ -0,0 +1,34 @@
+name: Deploy example
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+      - uses: pnpm/action-setup@v4
+
+      - name: Install & Build
+        run: |
+          pnpm install
+          pnpm build
+
+      - name: Generate example
+        run: pnpm run example
+
+      - name: Deploy with gh-pages
+        run: |
+          git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          pnpm run deploy -u "github-actions-bot <[email protected]>"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -5,3 +5,4 @@ coverage
 .custom-report-directory
 .test-plugin
 .DS_store
+example

package.json

@@ -18,14 +18,17 @@
   "scripts": {
     "build": "rm -rf ./dist && tsc --project tsconfig.build.json && cp src/*.css dist",
     "test": "vitest --coverage",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "example": "node scripts/generate-example.mjs",
+    "deploy": "touch example/.nojekyll && gh-pages --dist example --dotfiles true"
   },
   "peerDependencies": {
     "vite": ">=4"
   },
   "devDependencies": {
     "@types/node": "^22.4.1",
     "@vitest/coverage-v8": "^2.0.5",
+    "gh-pages": "^6.1.1",
     "magic-string": "^0.30.11",
     "typescript": "^5.5.4",
     "vite": "^5.4.0",