open-source

restore-setup-lv-source

Purpose

Restore the LabVIEW source setup by unzipping the LabVIEW Icon API and removing the INI token.

Parameters

Common parameters are described in Common parameters.

Required

MinimumSupportedLVVersion (string): LabVIEW version used to run g-cli.
SupportedBitness (string): “32” or “64” bitness of LabVIEW.
RelativePath (string): Path relative to the action’s working directory. Use “.” when the working directory is desired.
LabVIEW_Project (string): Name of the LabVIEW project (without extension)
Build_Spec (string): Build specification name within the project.

Optional

None.

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.
`relative_path`	`RelativePath`	Path relative to the working directory. Use ‘.’ to refer to the working directory.
`labview_project`	`LabVIEW_Project`	Path to the LabVIEW project file.
`build_spec`	`Build_Spec`	Name of the build specification.
`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 restore-setup-lv-source -ArgsJson '{
  "MinimumSupportedLVVersion": "2021",
  "SupportedBitness": "64",
  "WorkingDirectory": ".",
  "RelativePath": ".",
  "LabVIEW_Project": "lv_icon_editor",
  "Build_Spec": "Editor Packed Library"
}'

GitHub Action

- name: Restore LabVIEW setup
  uses: LabVIEW-Community-CI-CD/open-source/restore-setup-lv-source@v1
  with:
    minimum_supported_lv_version: '2021'
    supported_bitness: '64'
    working_directory: '.'
    relative_path: '.'
    labview_project: 'lv_icon_editor'
    build_spec: 'Editor Packed Library'

Return Codes

0 – setup restored
non‑zero – g-cli error restoring setup

For troubleshooting tips, see the troubleshooting guide.