Merge pull request #826 from nod-ai/staging/v0.4.0

Release v0.4.0

Author: bjacobgordon

.github/ISSUE_TEMPLATE/track-release.md

@@ -0,0 +1,29 @@
+---
+name: Track Release
+about: Track progress leading to the next release
+title: 'chore(version): release v#.#.#'
+labels: chore
+type: Task
+assignees: bjacobgordon
+
+---
+
+### Checkpoints
+
+- [ ] create `staging/v#.#.#` branch off of `integration`
+- [ ] open PR for branch: ?
+- [ ] perform QA, listing issues below
+- [ ] [draft release entry](https://github.com/nod-ai/shark-ui/releases/new): ?
+- [ ] bundle package
+- [ ] add package to release notes
+- [ ] merge into [releases](https://github.com/nod-ai/shark-ui/tree/release)
+- [ ] tag: ?
+- [ ] merge tag into [integration](https://github.com/nod-ai/shark-ui/tree/integration)
+- [ ] submit release draft
+- [ ] update [template](https://github.com/nod-ai/shark-ui/blob/integration/.github/ISSUE_TEMPLATE/track-release.md), if needed
+
+### Problems
+
+Edit this description to add new ones.
+
+- [ ] ?

.github/workflows/dependabot.yml

@@ -7,10 +7,14 @@ permissions:
 
 jobs:
   auto-merge:
+    name: Merge sanctioned dependency-bump PRs automatically
     runs-on: ubuntu-latest
     if: |
       (github.event.pull_request.user.login == 'dependabot[bot]') &&
       (!github.event.pull_request.head.repo.fork)
+    env:
+      PR_URL: ${{ github.event.pull_request.html_url }}
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: Fetch metadata
         id: metadata
@@ -22,6 +26,37 @@ jobs:
           (steps.metadata.outputs.update-type == 'version-update:semver-patch') ||
           (steps.metadata.outputs.update-type == 'version-update:semver-minor')
         run: gh pr merge --squash --auto "$PR_URL"
-        env:
-          PR_URL: ${{ github.event.pull_request.html_url }}
-          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: 'Approve select dependencies for bump: patch'
+        if: |
+          contains(
+            fromJSON('[
+              "vue-tsc"
+            ]'),
+            steps.metadata.outputs.dependency-names
+          )
+          && (steps.metadata.outputs.update-type == 'version-update:semver-patch')
+        run: gh pr review --approve "$PR_URL"
+      - name: 'Approve select dependencies for bump: patch, minor'
+        if: |
+          contains(
+            fromJSON('[
+              "@eslint/markdown",
+              "@stylistic/eslint-plugin",
+              "@typescript-eslint/parser",
+              "@types/node",
+              "cypress",
+              "eslint",
+              "eslint-plugin-cypress",
+              "eslint-plugin-vue",
+              "typescript-eslint",
+              "typescript",
+              "vite",
+              "vite-plugin-vue-devtools"
+            ]'),
+            steps.metadata.outputs.dependency-names
+          )
+          && (
+            (steps.metadata.outputs.update-type == 'version-update:semver-patch') ||
+            (steps.metadata.outputs.update-type == 'version-update:semver-minor')
+          )
+        run: gh pr review --approve "$PR_URL"

.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - integration
+      - release
+  pull_request:
+    branches:
+      - integration
+      - release
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check for changes to doc files
+        uses: tj-actions/changed-files@v46
+        id: changed-files
+        with:
+          files: '**/*.md'
+          separator: ','
+      - name: Lint the updated Markdown files
+        id: lint-markdown-files
+        uses: DavidAnson/markdownlint-cli2-action@v20
+        if: steps.changed-files.outputs.any_changed == 'true'
+        with:
+          config: .markdownlint-cli2.yaml
+          globs: ${{ steps.changed-files.outputs.all_changed_files }}
+          separator: ','
+        continue-on-error: true
+      - name: If linter failed, highlight debug tools
+        if: steps.lint-markdown-files.outcome == 'failure'
+        run: |
+          echo "::notice::Run \`npm run lint:docs\` in your dev environment to see which issues aren't automatically fixable."
+          exit 1

.github/workflows/node.yml

@@ -4,66 +4,81 @@ on:
   push:
     branches:
       - integration
-    paths:
-      - '.github/workflows/node.yml' # Trigger workflow when it's modified
-      - 'package.json'               # For dependency changes
-      - '**/*.js'                    # For scripts
-      - '**/*.ts'                    # For scripts
-      - '**/*.cjs'                   # For scripts
-      - '**/*.cts'                   # For scripts
-      - '**/*.mjs'                   # For scripts
-      - '**/*.mts'                   # For scripts
-      - '**/*.jsx'                   # For scripts
-      - '**/*.tsx'                   # For scripts
-      - '**/*.vue'                   # For single-file components that contain a script block
-      - '!**/*.md'                   # Ignore markdown files (and their constituent fenced code blocks)
-      - '!docs/**'                   # Ignore docs folder
+      - release
   pull_request:
     branches:
       - integration
-    paths:
-      - '.github/workflows/node.yml' # Trigger workflow when it's modified
-      - 'package.json'               # For dependency changes
-      - '**/*.js'                    # For scripts
-      - '**/*.ts'                    # For scripts
-      - '**/*.cjs'                   # For scripts
-      - '**/*.cts'                   # For scripts
-      - '**/*.mjs'                   # For scripts
-      - '**/*.mts'                   # For scripts
-      - '**/*.jsx'                   # For scripts
-      - '**/*.tsx'                   # For scripts
-      - '**/*.vue'                   # For single-file components that contain a script block
-      - '!**/*.md'                   # Ignore markdown files (and their constituent fenced code blocks)
-      - '!docs/**'                   # Ignore docs folder
+      - release
 
 jobs:
   analyze:
     runs-on: ubuntu-latest
-    name: Lint and compile via package.json
+    name: Lint, Compile, Build, and Test
     steps:
       - uses: actions/checkout@v4
+      - name: Check for changes to this workflow, dependencies, scripts, and single-file components
+        uses: tj-actions/changed-files@v46
+        id: changed-files
+        with:
+          files: |
+            .github/workflows/node.yml
+            package.json
+            package-lock.json
+            **/*.js
+            **/*.ts
+            **/*.cjs
+            **/*.cts
+            **/*.mjs
+            **/*.mts
+            **/*.jsx
+            **/*.tsx
+            **/*.vue
       - name: Set up Node.js
+        if: steps.changed-files.outputs.any_changed == 'true'
         uses: actions/setup-node@v4
         with:
           cache: 'npm'
-      - name: Install all dependencies (which includes linters)
+      - name: Install all dependencies
+        if: steps.changed-files.outputs.any_changed == 'true'
         run: npm clean-install
-      - name: Run the linter
+      - name: Try to pass linter
+        if: steps.changed-files.outputs.any_changed == 'true'
         id: lint
         run: npx eslint . --max-warnings 0 --cache
         continue-on-error: true
-      - name: If linter fails, highlight debug tools
+      - name: If linting fails, highlight debug tools
         if: steps.lint.outcome == 'failure'
         run: |
           echo "::notice::Enable lint-on-save in your editor for automatic fixes"
           echo "::notice::Run \`npm run lint\` in your dev environment for details about issues that aren't automatically fixable"
           exit 1
-      - name: Run the compiler
+      - name: Try to pass compiler
+        if: steps.changed-files.outputs.any_changed == 'true'
         id: compile
-        run: npx vue-tsc --build
+        run: npm run type-check
         continue-on-error: true
       - name: If compilation fails, highlight debug tools
         if: steps.compile.outcome == 'failure'
         run: |
-          echo "::notice::Run \`npx vue-tsc --build\` in your dev environment for details about compiler issues"
+          echo "::notice::Run \`npm run type-check\` in your dev environment for details about compiler issues"
+          exit 1
+      - name: Try to build for production # "Build" in this context means "transpile, minify, tree-shake, and bundle"
+        if: steps.changed-files.outputs.any_changed == 'true'
+        id: build
+        run: npm run build-only
+        continue-on-error: true
+      - name: If building fails, highlight debug tools
+        if: steps.build.outcome == 'failure'
+        run: |
+          echo "::notice::Run \`npm run build-only\` in your dev environment for a detailed report about build failures"
           exit 1
+      - name: Try to pass all unit tests
+        if: steps.changed-files.outputs.any_changed == 'true'
+        id: test_units
+        run: npm run test:unit
+        continue-on-error: true
+      - name: If unit tests fail, highlight debug tools
+        if: steps.test_units.outcome == 'failure'
+        run: |
+          echo "::notice::Run \`npm run test:unit\` in your dev environment for a detailed report about failed unit tests"
+          exit 1

.markdownlint-cli2.yaml

@@ -0,0 +1,3 @@
+config:
+  line-length: false
+gitignore: true

.vscode/settings.json

@@ -1,14 +1,30 @@
 {
     "cSpell.words": [
-        "cofactor",
-        "concatenatable",
-        "Flaggable",
         "SDXL",
-        "Shortfin",
         "stabilityai",
         "vite",
         "vuetify"
     ],
+    "cSpell.customDictionaries": {
+        "library/Attempt": {
+            "name": "library/Attempt",
+            "path": "./src/library/Attempt/dictionary.txt",
+            "description": "Words introduced by the @/library/Attempt module",
+            "addWords": false
+        },
+        "library/math": {
+            "name": "library/math",
+            "path": "./src/library/math/dictionary.txt",
+            "description": "Words introduced by the @/library/math module",
+            "addWords": false
+        },
+        "library/Shortfin": {
+            "name": "library/Shortfin",
+            "path": "./src/library/Shortfin/dictionary.txt",
+            "description": "Words introduced by the @/library/Shortfin module",
+            "addWords": false
+        },
+    },
     "editor.codeActionsOnSave": {
         "source.fixAll": "explicit",
     },
@@ -28,6 +44,7 @@
     ],
     "explorer.fileNesting.enabled": true,
     "explorer.fileNesting.patterns": {
+        "*.ts": "${capture}.test.ts",
         "tsconfig.json": "tsconfig.*.json",
         "vite.config.*": "jsconfig*, vitest.config.*, cypress.config.*, playwright.config.*, env.d.ts",
         "package.json": "package-lock.json, pnpm*, .yarnrc*, yarn*",