STREAM-1123: distributor client

.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: "Publish Docs"
+
+on:
+  push:
+    branches: [master]
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 8
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
+          registry-url: https://registry.npmjs.org/
+      - name: Install dependencies
+        run: pnpm install
+      # Generate your TypeDoc documentation
+      - run: npx typedoc
+      # https://github.com/actions/upload-pages-artifact
+      - uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./docs # This should be your TypeDoc "out" path.
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        # https://github.com/actions/deploy-pages
+        uses: actions/deploy-pages@v2

.github/workflows/gh-pr.yml

@@ -8,10 +8,21 @@ on:
 jobs:
   tests:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18, 20]
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
         with:
-          node-version: 18
-      - run: npm ci
+          version: 8
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "pnpm"
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build dependencies
+        run: npm run build
       - run: npm test

.github/workflows/gh-publish.yml

@@ -16,22 +16,25 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Node ${{ matrix.node_version }}
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
         with:
-          node-version: 18
+          version: 8
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
           registry-url: https://registry.npmjs.org/
+      - name: Install dependencies
+        run: pnpm install
       - name: Git Identity
         run: |
           git config --global user.name 'github-actions[bot]'
           git config --global user.email 'github-actions[bot]@users.noreply.github.com'
           git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/$GITHUB_REPOSITORY
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Install dependencies
-        run: npm ci
       - name: Set Current Version
         run: |
           CURRENT_VERSION=$(node -p 'require("./lerna.json").version')
@@ -64,15 +67,15 @@ jobs:
         uses: softprops/action-gh-release@v1
         with:
           tag_name: v${{ env.CURRENT_VERSION }}
-          name: ${{ github.event.pull_request.title }}
+          name: v${{ env.CURRENT_VERSION }}
           body: |
             ${{ github.event.pull_request.body }}
           draft: false
           prerelease: false
       - name: Publish
         if: steps.tag_check.outputs.exists_tag == 'false'
         run: |
-          npm run publish -- from-package --yes
+          npm run publish
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

.gitignore

@@ -19,3 +19,4 @@ dist/
 .DS_Store
 packages/.DS_Store
 *.tgz
+docs/

.vscode/settings.json

@@ -1,6 +1,12 @@
 {
+    "prettier.requireConfig": true,
+    "eslint.enable": true,
+    "eslint.debug": false,
     "eslint.workingDirectories": [
-        "./packages/stream/"
+        // Monorepo directories
+        {
+            "pattern": "./packages/*/"
+        }
     ],
     "cSpell.words": [
         "Streamflow"