CI Bundle #3

.github/workflows/ci.json

@@ -43,6 +43,9 @@
         {
           "run": "npm run derive:registry"
         },
+        {
+          "run": "rm -rf artifacts"
+        },
         {
           "run": "npm run generate:summary",
           "env": {
@@ -174,10 +177,13 @@
         {
           "run": "npm install"
         },
+        {
+          "run": "rm -rf artifacts"
+        },
         {
           "uses": "actions/download-artifact@v4",
           "with": {
-            "path": "./downloaded"
+            "path": "./artifacts"
           }
         },
         {
@@ -186,10 +192,10 @@
         {
           "run": "npm run generate:summary",
           "env": {
-            "TEST_RESULTS_GLOBS": "downloaded/test-results/**/*junit*.xml\ndownloaded/pester-junit-*/pester-junit.xml\n",
+            "TEST_RESULTS_GLOBS": "artifacts/test-results/**/*junit*.xml\nartifacts/pester-junit-*/pester-junit.xml\n",
             "REQ_MAPPING_FILE": "requirements.json",
             "DISPATCHER_REGISTRY": "dispatchers.json",
-            "EVIDENCE_DIR": "downloaded/evidence"
+            "EVIDENCE_DIR": "artifacts/evidence"
           }
         },
         {

.github/workflows/ci.yml

@@ -23,6 +23,7 @@ jobs:
       - run: npm run link:check
       - run: npm run test:ci
       - run: npm run derive:registry
+      - run: rm -rf artifacts
       - run: npm run generate:summary
         env:
           TEST_RESULTS_GLOBS: test-results/*junit*.xml
@@ -142,16 +143,17 @@ jobs:
           node-version: 24
       - run: npm run check:node
       - run: npm install
+      - run: rm -rf artifacts
       - uses: actions/download-artifact@v4
         with:
-          path: ./downloaded
+          path: ./artifacts
       - run: npm run derive:registry
       - run: npm run generate:summary
         env:
           TEST_RESULTS_GLOBS: |
-            downloaded/test-results/**/*junit*.xml
-            downloaded/pester-junit-*/pester-junit.xml
+            artifacts/test-results/**/*junit*.xml
+            artifacts/pester-junit-*/pester-junit.xml
           REQ_MAPPING_FILE: requirements.json
           DISPATCHER_REGISTRY: dispatchers.json
-          EVIDENCE_DIR: downloaded/evidence
+          EVIDENCE_DIR: artifacts/evidence
       - run: npx tsx scripts/print-pester-traceability.ts >> "$GITHUB_STEP_SUMMARY"

AGENTS.md

@@ -31,6 +31,6 @@
 - Run `npm install` to ensure Node dependencies are available.
 - Run `npm test`.
 - Run `npm run lint:md` to lint Markdown files.
-- Run `npx --yes markdown-link-check -q -c .markdown-link-check.json README.md $(find docs scripts -name '*.md')` to verify links.
+- Run `npx --yes markdown-link-check -c .markdown-link-check.json README.md $(find docs scripts -name '*.md')` to verify links and ensure failures are visible.
 - Run `actionlint` to validate GitHub Actions workflows.
 - Run `pwsh -NoLogo -Command "$cfg = New-PesterConfiguration; $cfg.Run.Path = './tests/pester'; $cfg.TestResult.Enabled = $false; Invoke-Pester -Configuration $cfg"` and ensure all tests pass (XML output is intentionally disabled).

README.md

@@ -146,7 +146,7 @@ npm install
 npm test
 ```
 
-For CI, `npm run test:ci` emits a JUnit XML report that [scripts/generate-ci-summary.ts](scripts/generate-ci-summary.ts) parses to build requirement traceability files in OS‑specific subdirectories (e.g., `artifacts/windows`, `artifacts/linux`) based on the `RUNNER_OS` environment variable.
+For CI, `npm run test:ci` emits a JUnit XML report that [scripts/generate-ci-summary.ts](scripts/generate-ci-summary.ts) parses to build requirement traceability files in OS‑specific subdirectories (e.g., `artifacts/windows`, `artifacts/linux`) based on the `RUNNER_OS` environment variable. The summary script searches `artifacts/` by default; set `TEST_RESULTS_GLOBS` if your reports are elsewhere.
 
 Pester tests cover the dispatcher and helper modules. See [docs/testing-pester.md](docs/testing-pester.md) for guidelines on using the canonical argument helper and adding new tests. Run them with:
 

docs/architecture.md

@@ -6,6 +6,8 @@ The Open Source LabVIEW Actions project exposes multiple LabVIEW CI/CD steps thr
 
 `Invoke-OSAction.ps1` routes incoming requests to the appropriate adapter script. The dispatcher discovers available actions, forwards command-line arguments, and preserves exit codes.
 
+![Dispatcher to adapter to action flow](images/architecture.svg)
+
 ## Adapter scripts
 
 Each action lives in a `scripts/<action-name>` folder. These PowerShell scripts implement the build or test work and are invoked by the dispatcher with the JSON arguments supplied by the GitHub Action.

docs/contributing-docs.md

@@ -55,7 +55,11 @@ MkDocs serves the site at <http://127.0.0.1:8000/> by default. The server automa
 
 ## JUnit integration
 
-The CI pipeline collects JUnit XML output from both Node and PowerShell tests. `scripts/generate-ci-summary.ts` parses these files to build the requirement traceability report. Use `npm run test:ci` to produce the Node JUnit report when verifying documentation updates.
+The CI pipeline collects JUnit XML output from both Node and PowerShell tests. `scripts/generate-ci-summary.ts` parses these files to build the requirement traceability report. Use `npm run test:ci` to produce the Node JUnit report when verifying documentation updates. By default, the summary script only searches `artifacts/` for JUnit XML files; if your results are elsewhere, pass a glob via `TEST_RESULTS_GLOBS`, for example:
+
+```bash
+TEST_RESULTS_GLOBS='test-results/*junit*.xml' npm run generate:summary
+```
 
 ### Pester properties
 

docs/index.md

@@ -39,4 +39,20 @@ Open Source LabVIEW Actions unifies LabVIEW CI/CD scripts behind a single PowerS
 
 | Workflow | Purpose |
 | --- | --- |
-| [run-pester-tests](workflows/run-pester-tests.md) | Run Pester tests in a target repository. |
+| [add-token-to-labview](workflows/add-token-to-labview.md) | Add a custom library path token to the LabVIEW INI file so LabVIEW can locate project libraries. |
+| [apply-vipc](workflows/apply-vipc.md) | Apply a VI Package Configuration (.vipc) file to a specific LabVIEW installation using g-cli. |
+| [build-lvlibp](workflows/build-lvlibp.md) | Build a LabVIEW project’s build specification into a Packed Project Library (.lvlibp). |
+| [build-vi-package](workflows/build-vi-package.md) | Update VIPB display information and build a VI package using g-cli. |
+| [build](workflows/build.md) | Automate building the LabVIEW Icon Editor project, including cleaning, building libraries, and packaging. |
+| [close-labview](workflows/close-labview.md) | Gracefully close a running LabVIEW instance via g-cli. |
+| [generate-release-notes](workflows/generate-release-notes.md) | Generate release notes from the git history and write them to a markdown file. |
+| [missing-in-project](workflows/missing-in-project.md) | Check that all files in a LabVIEW project are present by scanning for items missing from the `.lvproj`. |
+| [modify-vipb-display-info](workflows/modify-vipb-display-info.md) | Update display information in a VIPB file and rebuild the VI package. |
+| [prepare-labview-source](workflows/prepare-labview-source.md) | Run PrepareIESource.vi via g-cli to unzip components and configure LabVIEW for building. |
+| [rename-file](workflows/rename-file.md) | Rename a file if it exists. |
+| [restore-setup-lv-source](workflows/restore-setup-lv-source.md) | Restore the LabVIEW source setup by unzipping the LabVIEW Icon API and removing the INI token. |
+| [revert-development-mode](workflows/revert-development-mode.md) | Restore the repository from development mode by restoring packaged sources and closing LabVIEW. |
+| [run-pester-tests](workflows/run-pester-tests.md) | Run PowerShell Pester tests in a repository. |
+| [run-unit-tests](workflows/run-unit-tests.md) | Run LabVIEW unit tests via the LabVIEW Unit Test Framework CLI and report pass/fail/error using standard exit codes. |
+| [set-development-mode](workflows/set-development-mode.md) | Configure the repository for development mode by removing packed libraries, adding tokens, preparing sources, and closing LabVIEW. |
+| [setup-mkdocs](workflows/setup-mkdocs.md) | Install a pinned MkDocs with caching. |

docs/workflows/add-token-to-labview.md

@@ -0,0 +1,49 @@
+# add-token-to-labview workflow
+
+## Purpose
+
+Dispatch the [add-token-to-labview](../actions/add-token-to-labview.md) action to a target repository through `Invoke-OSAction.ps1`.
+
+## Inputs
+
+| Input | Description |
+| --- | --- |
+| `repository` | Repository in `owner/repo` format to operate on. |
+| `ref` | Branch or tag to check out. Defaults to `main`. |
+
+## Required secrets
+
+| Secret | Description |
+| --- | --- |
+| `REPO_TOKEN` | Personal access token with permission to read the target repository. |
+
+## Example
+
+```yaml
+name: add-token-to-labview
+on:
+  workflow_dispatch:
+    inputs:
+      repository:
+        description: 'owner/repo of the repository to target'
+        required: true
+      ref:
+        description: 'Branch or tag to check out'
+        required: false
+        default: 'main'
+jobs:
+  add-token-to-labview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Checkout target repository
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ inputs.repository }}
+          ref: ${{ inputs.ref }}
+          path: target
+          token: ${{ secrets.REPO_TOKEN }}
+      - name: Run add-token-to-labview
+        shell: pwsh
+        run: ./actions/Invoke-OSAction.ps1 -ActionName add-token-to-labview -WorkingDirectory "${{ github.workspace }}/target"
+```

docs/workflows/apply-vipc.md

@@ -0,0 +1,49 @@
+# apply-vipc workflow
+
+## Purpose
+
+Dispatch the [apply-vipc](../actions/apply-vipc.md) action to a target repository through `Invoke-OSAction.ps1`.
+
+## Inputs
+
+| Input | Description |
+| --- | --- |
+| `repository` | Repository in `owner/repo` format to operate on. |
+| `ref` | Branch or tag to check out. Defaults to `main`. |
+
+## Required secrets
+
+| Secret | Description |
+| --- | --- |
+| `REPO_TOKEN` | Personal access token with permission to read the target repository. |
+
+## Example
+
+```yaml
+name: apply-vipc
+on:
+  workflow_dispatch:
+    inputs:
+      repository:
+        description: 'owner/repo of the repository to target'
+        required: true
+      ref:
+        description: 'Branch or tag to check out'
+        required: false
+        default: 'main'
+jobs:
+  apply-vipc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Checkout target repository
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ inputs.repository }}
+          ref: ${{ inputs.ref }}
+          path: target
+          token: ${{ secrets.REPO_TOKEN }}
+      - name: Run apply-vipc
+        shell: pwsh
+        run: ./actions/Invoke-OSAction.ps1 -ActionName apply-vipc -WorkingDirectory "${{ github.workspace }}/target"
+```

docs/workflows/build-lvlibp.md

@@ -0,0 +1,49 @@
+# build-lvlibp workflow
+
+## Purpose
+
+Dispatch the [build-lvlibp](../actions/build-lvlibp.md) action to a target repository through `Invoke-OSAction.ps1`.
+
+## Inputs
+
+| Input | Description |
+| --- | --- |
+| `repository` | Repository in `owner/repo` format to operate on. |
+| `ref` | Branch or tag to check out. Defaults to `main`. |
+
+## Required secrets
+
+| Secret | Description |
+| --- | --- |
+| `REPO_TOKEN` | Personal access token with permission to read the target repository. |
+
+## Example
+
+```yaml
+name: build-lvlibp
+on:
+  workflow_dispatch:
+    inputs:
+      repository:
+        description: 'owner/repo of the repository to target'
+        required: true
+      ref:
+        description: 'Branch or tag to check out'
+        required: false
+        default: 'main'
+jobs:
+  build-lvlibp:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Checkout target repository
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ inputs.repository }}
+          ref: ${{ inputs.ref }}
+          path: target
+          token: ${{ secrets.REPO_TOKEN }}
+      - name: Run build-lvlibp
+        shell: pwsh
+        run: ./actions/Invoke-OSAction.ps1 -ActionName build-lvlibp -WorkingDirectory "${{ github.workspace }}/target"
+```

docs/workflows/build-vi-package.md

@@ -0,0 +1,49 @@
+# build-vi-package workflow
+
+## Purpose
+
+Dispatch the [build-vi-package](../actions/build-vi-package.md) action to a target repository through `Invoke-OSAction.ps1`.
+
+## Inputs
+
+| Input | Description |
+| --- | --- |
+| `repository` | Repository in `owner/repo` format to operate on. |
+| `ref` | Branch or tag to check out. Defaults to `main`. |
+
+## Required secrets
+
+| Secret | Description |
+| --- | --- |
+| `REPO_TOKEN` | Personal access token with permission to read the target repository. |
+
+## Example
+
+```yaml
+name: build-vi-package
+on:
+  workflow_dispatch:
+    inputs:
+      repository:
+        description: 'owner/repo of the repository to target'
+        required: true
+      ref:
+        description: 'Branch or tag to check out'
+        required: false
+        default: 'main'
+jobs:
+  build-vi-package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Checkout target repository
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ inputs.repository }}
+          ref: ${{ inputs.ref }}
+          path: target
+          token: ${{ secrets.REPO_TOKEN }}
+      - name: Run build-vi-package
+        shell: pwsh
+        run: ./actions/Invoke-OSAction.ps1 -ActionName build-vi-package -WorkingDirectory "${{ github.workspace }}/target"
+```