User Tools

Site Tools


code:commercial:sccvm:overview

SCC Version Manager

The Source Code Version Manager can be used to start another application, which executable is stored in a git repository. To specify which version of the executable should be used, git tags are used. The step of starting an executable can be skipped, so that the module can be used to ensure, that a repo is in a desired state.

In the GUI, the user can select the desired tag from a dropdown control. The Launch Tool then checks, if the repository is at the correct tag and that no changes to the repository has been made. If needed, the repository will be prepared accordingly. Finally, the Launch Tool calls the executable, if configured.

More information can be found in the Documentation PDF, which was automatically created using our Release Automation Tools - Documentr

Development

The scc-version-manager is a DQMH Module which is implemented as a HSE State-Machine Singleton.

Dependencies

Dependencies are stored in the scc-version-manager.vipc file. Open and apply the configuration to install all needed VI packages using VI Package Manager. This will install the following VI Packages:

  • DQMH v6.1.0
  • GIT API v2.0.1
  • HSE Layout Manager v1.2.1
  • HSE Logger v2.0.5

The HSE Framework comes with a dependency to the HSE Libraries which are part of the repository and not installed as a VI Package.

HSE Framework

The application uses the HSE Windows Application Framework. It is recommended to read about the used project structure and repository structure.

Configuration

The config.ini (scc-version-manager_Config/config.ini.default) specifies the used Unit, allowing easier changes between multiple given configurations.

To specify which executable the SCC Version Manager should start, set path-exe in the scc-version-manager_Config/Unit_HSE/scc-version-manager.ini configuration of the used unit

Alternatively, you can call the executable with a parameter to configure the path to the exe like this: scc-version-manager.exe – “path-exe C:\Labview\hampelsoft-test\builds\application\HAMPELSOFT-TEST.exe”

Example scc-version-manager.ini:

[global]
; The descriptor is used for the VI's Front Panel Window titlebar 
; and for the entries in the UI Manager's Run-Time Menu.
descriptor = "SCC Version Manager"

[app]
; the path to the repository to be checked
path-repo = "C:\LabVIEW\gitlab-api-for-labview"

; the tag which should be checked out in the repository 
target-tag = "v1.1.0"

; the path to the executable that should be started if enabled
path-exe = "C:\Program Files\Notepad++\notepad++.exe"

; should the sccvm start the .exe automatically after checking the repo?
start-exe-enabled = "true"

; if set to false, the sccvm will only display the current state of the repository
; if set to true, the sccvm will also check-out the tag and start the exe, if configured
auto-mode = "true"

this will checkout the tag v1.1.0 of the gitlab-api-for-labview repository and start notepad++.exe without user interaction needed

Executing the Source Code Version Manager

Start the Source Code Version Manager and select a tag from the Drop-Down Menu.

code/commercial/sccvm/overview.txt · Last modified: 2022/09/01 10:26 by joerg.hampel