ci: publish review docs

.github/workflows/coverage-badges.yml

@@ -1,4 +1,5 @@
-name: "coverage-badges"
+name: Create Jest coverage badges
+
 on:
   push:
     branches:
@@ -32,4 +33,4 @@ jobs:
           coverage-summary-path: ./packages/components/coverage/coverage-summary.json
 
       - name: Push badges branch
-        run: git push origin badges
+        run: git push origin badges

.github/workflows/coverage.yml

@@ -1,4 +1,5 @@
-name: "coverage"
+name: "Build Jest coverage report"
+
 on:
   pull_request:
     branches:

.github/workflows/publish-docs.yml

@@ -1,4 +1,5 @@
-name: Publish docs
+name: Publish docs to GitHub Pages
+
 on:
   push:
     branches:
@@ -9,36 +10,43 @@ permissions:
   pages: write
   id-token: write
 
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
 jobs:
   build:
     runs-on: ubuntu-latest
-
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout ⬇️
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-node@v4
+      - name: Setup Node 🎛️
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: "yarn"
           registry-url: "https://registry.npmjs.org"
 
-      - run: yarn install --immutable
-      - uses: nrwl/nx-set-shas@v4
-      - if: github.ref != 'refs/heads/main'
+      - name: Yarn Install 📦️
+        run: yarn install --immutable
+
+      - name: Setup NX 1/2 🎛️
+        uses: nrwl/nx-set-shas@v4
+
+      - name: Setup NX 2/2 🎛
+        if: github.ref != 'refs/heads/main'
         run: git branch --track main origin/main
-      - run: yarn nx affected -t build --parallel=3
 
-      - uses: actions/configure-pages@v4
+      - name: Build 🔨
+        env:
+          NEXT_BASE_PATH: "/flow"
+        run: yarn nx affected -t build --parallel=3
+
+      - name: Configure GitHub pages ⚙️
+        uses: actions/configure-pages@v4
         with:
           static_site_generator: next
 
-      - name: Upload artifact
+      - name: Upload GitHub Pages artifact ⬆️
         uses: actions/upload-pages-artifact@v3
         with:
           path: packages/docs/out

.github/workflows/publish-review-docs.yml

@@ -0,0 +1,73 @@
+name: Publish review docs
+
+on:
+  push:
+    branches-ignore:
+      - main
+
+permissions:
+  contents: read
+
+env:
+  TARGET_PATH: "/docs/${{ github.ref_name }}"
+  NEXT_BASE_PATH: "/flow-previews/docs/${{ github.ref_name }}"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    environment:
+      name: github-pages-preview
+      url: https://mittwald.github.io${{ env.NEXT_BASE_PATH }}
+
+    env:
+      NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      PUBLISH_PAT: ${{ secrets.PUBLISH_PAT }}
+      GH_TOKEN: ${{ secrets.PUBLISH_PAT }}
+
+    steps:
+      - name: Checkout ⬇️
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.PUBLISH_PAT }}
+
+      - name: Setup Node 🎛️
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "yarn"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Git Identity 🪪
+        run: |
+          git config user.name "${{ github.actor }}"
+          git config user.email "${{ github.actor }}@users.noreply.github.com"
+
+      - name: Yarn Install 📦️
+        run: yarn install --immutable
+
+      - name: Setup NX 1/2 🎛️
+        uses: nrwl/nx-set-shas@v4
+
+      - name: Setup NX 2/2 🎛
+        if: github.ref != 'refs/heads/main'
+        run: git branch --track main origin/main
+
+      - name: Build 🔨
+        run: yarn nx affected -t build --parallel=3
+
+      - name: Upload files to GitHub Pages 🚀
+        uses: cpina/github-action-push-to-another-repository@main
+        env:
+          API_TOKEN_GITHUB: ${{ secrets.PUBLISH_PAT }}
+        with:
+          source-directory: packages/docs/out
+          destination-github-username: mittwald
+          destination-repository-name: flow-previews
+          target-branch: main
+          target-directory: "${{ env.TARGET_PATH }}"
+
+      - name: Output the URL
+        run: echo "${{ job.environment.url }}"

.github/workflows/publish.yml

@@ -1,38 +1,55 @@
-name: Publish
+name: Publish packages to NPM
+
 on:
   pull_request:
-    types: [closed]
+    types:
+      - closed
     branches:
       - main
 
 jobs:
-  main:
+  publish:
     runs-on: ubuntu-latest
+
     env:
       NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       PUBLISH_PAT: ${{ secrets.PUBLISH_PAT }}
       GH_TOKEN: ${{ secrets.PUBLISH_PAT }}
+
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout ⬇️
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           token: ${{ secrets.PUBLISH_PAT }}
-      - uses: actions/setup-node@v4
+
+      - name: Setup Node 🎛️
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: "yarn"
           registry-url: "https://registry.npmjs.org"
-      - name: Git Identity
+
+      - name: Git Identity 🪪
         run: |
           git config user.name "${{ github.actor }}"
           git config user.email "${{ github.actor }}@users.noreply.github.com"
-      - run: yarn install --immutable
-      - uses: nrwl/nx-set-shas@v4
-      - if: github.ref != 'refs/heads/main'
+
+      - name: Yarn Install 📦️
+        run: yarn install --immutable
+
+      - name: Setup NX 1/2 🎛️
+        uses: nrwl/nx-set-shas@v4
+
+      - name: Setup NX 2/2 🎛
+        if: github.ref != 'refs/heads/main'
         run: git branch --track main origin/main
-      - run: yarn nx affected -t build --parallel=3
-      - name: "Version and publish"
+
+      - name: Build 🔨
+        run: yarn nx affected -t build --parallel=3
+
+      - name: Version and publish 🚀
         run: |
           yarn lerna publish \
             --conventional-commits --conventional-prerelease=* \

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test
+name: Run tests
 on:
   push:
     branches:

nx.json

@@ -1,7 +1,7 @@
 {
   "$schema": "./node_modules/nx/schemas/nx-schema.json",
   "affected": {
-    "defaultBase": "master"
+    "defaultBase": "main"
   },
   "namedInputs": {
     "src": ["{projectRoot}/{src,dev}/**/!(*.test).*"],

packages/docs/next.config.js

@@ -5,7 +5,7 @@ import remarkMdxFrontmatter from "remark-mdx-frontmatter";
 /** @type {import("next").NextConfig} */
 const nextConfig = {
   output: "export",
-  basePath: "/flow",
+  basePath: process.env.NEXT_BASE_PATH ?? "",
   pageExtensions: ["js", "jsx", "mdx", "ts", "tsx", "example"],
   webpack: (config, _) => {
     config.module.rules.push({