open-source

Open Source LabVIEW Actions

Open Source LabVIEW Actions is a collection of GitHub Actions and PowerShell scripts that streamline LabVIEW CI/CD workflows. Each task is implemented by a PowerShell adapter script with a GitHub Action wrapper, all coordinated by a unified dispatcher. Refer to the documentation for setup guidance, detailed examples, and the complete action reference.

Prerequisites

Node.js 24+ (run npm install after cloning to fetch tsx and other dependencies)
PowerShell 7+ (pwsh)
NI LabVIEW with command-line interface support (g-cli) for LabVIEW-based actions
Supported platforms: Windows for LabVIEW tasks; PowerShell-only scripts also run on macOS and Linux

See Environment Setup for installation steps and commands to verify each dependency.

GitHub Action usage

- name: Run tests
  uses: LabVIEW-Community-CI-CD/open-source/run-unit-tests@v1
  with:
    minimum_supported_lv_version: '2021'
    supported_bitness: '64'

Each adapter script ships with a corresponding wrapper action. Replace run-unit-tests with any action name listed in the action reference. The wrapper translates the typed inputs above into the dispatcher.

Common optional inputs available on all wrappers:

Name	Description
`gcli_path`	Path to the g-cli executable when it is not on `PATH`.
`working_directory`	Directory where the action runs.
`log_level`	Verbosity level (`ERROR`, `WARN`, `INFO`, `DEBUG`).
`dry_run`	Simulate the action without side effects.

Examples

Run tests from a subfolder:

- uses: LabVIEW-Community-CI-CD/open-source/run-unit-tests@v1
  with:
    minimum_supported_lv_version: '2021'
    supported_bitness: '64'
    working_directory: src

Enable debug logging and perform a dry run:

- uses: LabVIEW-Community-CI-CD/open-source/run-unit-tests@v1
  with:
    minimum_supported_lv_version: '2021'
    supported_bitness: '64'
    log_level: DEBUG
    dry_run: true

For a full workflow example that chains multiple actions to build the LabVIEW Icon Editor, see docs/quickstart.md#build-icon-editor.

CLI/dispatcher usage

If you prefer or need to run tasks directly, serialize arguments as JSON and call the dispatcher script actions/Invoke-OSAction.ps1 yourself:

$json = @'
{
  "MinimumSupportedLVVersion": "2021",
  "SupportedBitness": "64"
}
'@
pwsh ./actions/Invoke-OSAction.ps1 -ActionName run-unit-tests -ArgsJson $json

Alternatively, load arguments from a JSON file:

pwsh ./actions/Invoke-OSAction.ps1 -ActionName run-unit-tests -ArgsFile ./config/run-tests.json

By default the dispatcher ignores unknown parameters and emits a warning. Add -FailOnUnknown to treat unexpected parameters as errors:

pwsh ./actions/Invoke-OSAction.ps1 -ActionName run-unit-tests -ArgsJson $json -FailOnUnknown

Discovering actions

List all available actions:

pwsh actions/Invoke-OSAction.ps1 -ListActions

Get details about a specific action:

pwsh actions/Invoke-OSAction.ps1 -Describe run-unit-tests

Runner Types

Workflows distinguish between standard GitHub-hosted images and integration runners with preinstalled tooling. See docs/runner-types.md for a detailed comparison. Administrators can update runner metadata without a pull request by following the Update Runner Runtime guide.

Testing

Run the JavaScript tests and generate traceability artifacts with:

npm install
npm run test:ci
npm run derive:registry
RUNNER_OS=Linux TEST_RESULTS_GLOBS='test-results/*junit*.xml' npm run generate:summary
npm run check:traceability

When running locally, set RUNNER_OS (for example, RUNNER_OS=Linux) before invoking npm run generate:summary.

npm run test:ci writes JUnit files to test-results/. scripts/generate-ci-summary.ts parses these results to build requirement traceability files in OS‑specific subdirectories (e.g., artifacts/windows, artifacts/linux) based on the RUNNER_OS environment variable. Commit test-results/* and artifacts/linux/* along with your source changes. 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 for guidelines on using the canonical argument helper and adding new tests. The GitHub runner installs Pester automatically; install it locally only if you plan to run the tests yourself:

Install-Module Pester -Force -Scope CurrentUser

$cfg = New-PesterConfiguration
$cfg.Run.Path = './tests/pester'
$cfg.TestResult.Enabled = $false
Invoke-Pester -Configuration $cfg

XML test result output is intentionally disabled.

Test and Release Mode

Committing build artifacts together with a release.json file enables the release pipeline. See Test and Release Mode for details.

Requirement Traceability

Each commit must reference requirement IDs linked to automated tests. See Test and Release Mode for full guidance.

Contributing

Contributions are welcome! See CONTRIBUTING.md for general guidelines and docs/contributing-docs.md for documentation rules.

To preview docs locally:

pip install mkdocs mkdocs-material
mkdocs serve

Troubleshooting

If npm prints npm warn Unknown env config "http-proxy", remove the npm_config_http_proxy environment variable or replace it with npm_config_proxy/npm_config_https_proxy.

Node.js 24+ removes legacy constants like fs.R_OK. Scripts and patches in this repository rely on fs.constants.R_OK to remain compatible with newer Node releases.

This site is open source. Improve this page.