open-source

build-vi-package

Purpose

Update VIPB display information and build a VI package using g-cli.

Parameters

Common parameters are described in Common parameters.

Required

MinimumSupportedLVVersion (string): Minimum LabVIEW version supported by the package.
SupportedBitness (string): “32” or “64” bitness of LabVIEW.
LabVIEWMinorRevision (string): LabVIEW minor revision (e.g., “3”)
RelativePath (string): Path relative to the action’s working directory. Use “.” when the working directory is desired.
VIPBPath (string): Relative path to the VIPB file to build.
Major (int): Major version component.
Minor (int): Minor version component.
Patch (int): Patch version component.
Build (int): Build number component.
Commit (string): Commit identifier for metadata.
DisplayInformationJSON (string): JSON string to merge into the VIPB display information.

Optional

ReleaseNotesFile (string): Path to a release notes file included in the package.

GitHub Action inputs

GitHub Action inputs are provided in snake_case, while CLI parameters use PascalCase. The table below maps each input to its corresponding CLI parameter. For details on shared CLI flags, see Common parameters.

Input	CLI parameter	Description
`minimum_supported_lv_version`	`MinimumSupportedLVVersion`	Minimum LabVIEW version supported.
`supported_bitness`	`SupportedBitness`	“32” or “64” bitness of LabVIEW.
`labview_minor_revision`	`LabVIEWMinorRevision`	LabVIEW minor revision.
`relative_path`	`RelativePath`	Path relative to the working directory. Use ‘.’ to refer to the working directory.
`vipb_path`	`VIPBPath`	Path to the VIPB file.
`major`	`Major`	Major version component.
`minor`	`Minor`	Minor version component.
`patch`	`Patch`	Patch version component.
`build`	`Build`	Build number.
`commit`	`Commit`	Commit identifier.
`display_information_json`	`DisplayInformationJSON`	JSON string of display information.
`release_notes_file`	`ReleaseNotesFile`	Optional path to release notes file.
`gcli_path`	`gcliPath`	Optional path to the g-cli executable.
`working_directory`	`WorkingDirectory`	Base directory for the action; relative paths are resolved from here.
`log_level`	`LogLevel`	Verbosity level (ERROR\|WARN\|INFO\|DEBUG).
`dry_run`	`DryRun`	If true, simulate the action without side effects.

Examples

CLI

pwsh -File actions/Invoke-OSAction.ps1 -ActionName build-vi-package -ArgsJson '{
  "MinimumSupportedLVVersion": "2023",
  "SupportedBitness": "64",
  "LabVIEWMinorRevision": "3",
  "WorkingDirectory": ".",
  "RelativePath": ".",
  "VIPBPath": "Tooling/deployment/NI Icon editor.vipb",
  "Major": 1,
  "Minor": 0,
  "Patch": 0,
  "Build": 2,
  "Commit": "abcdef",
  "DisplayInformationJSON": "{\"Package Version\":{\"major\":1,\"minor\":0,\"patch\":0,\"build\":2}}"
}'

GitHub Action

- name: Build VI Package
  uses: LabVIEW-Community-CI-CD/open-source/build-vi-package@v1
  with:
    minimum_supported_lv_version: '2023'
    supported_bitness: '64'
    labview_minor_revision: '3'
    working_directory: '.'
    relative_path: '.'
    vipb_path: 'Tooling/deployment/NI Icon editor.vipb'
    major: 1
    minor: 0
    patch: 0
    build: 2
    commit: abcdef
    display_information_json: '{"Package Version":{"major":1,"minor":0,"patch":0,"build":2}}'

Return Codes

0 – package built successfully
non‑zero – g-cli or build error

For troubleshooting tips, see the troubleshooting guide.