BuildVersion

BuildVersion is a software package for Automation Studio projects to transfer version information to runtime variables during each build.

The package includes a Windows-native PowerShell script to automatically capture version information during the pre-build event.
The script is intended for use with the version control system git.

NOTE: This is not an official package and is supported by the community. BuildVersion is provided as-in under the MIT License agreement. Source code, documentation, and issues are managed through GitHub.

Features

• Capture git repository information
• ⬇️ Capture Automation Studio project and build information
• 🔰 Use with and without git
• 📁 Initialize local variable
• 🌎 Initialize global variable
• ⚠️ PowerShell script will not throw error in project build by default
• 📺 mappView widget integration

Installation

1. Add Package to Project

• Download and extract
• Logical View -> select project folder -> Toolbox -> Existing Package -> import BuildVersion

2. Create Pre-Build Event

• Configuration View -> active configuration -> right-click CPU object -> Properties
• Build Events -> Configuration Pre-Build Step -> Insert the following

PowerShell -ExecutionPolicy ByPass -File $(WIN32_AS_PROJECT_PATH)\Logical\BuildVersion\BuildVersion.ps1 -ProjectPath $(WIN32_AS_PROJECT_PATH) -StudioVersion "$(AS_VERSION)" -UserName "$(AS_USER_NAME)" -ProjectName "$(AS_PROJECT_NAME)" -Configuration "$(AS_CONFIGURATION)" -BuildMode "$(AS_BUILD_MODE)"

If the BuildVersion package is placed in subdirectories of Logical, the pre-build event must be updated to reflect the subdirectories.
For example, if the BuildVersion package is placed in a Tools subdirectory then the -File argument must be updated to the following.

-File $(WIN32_AS_PROJECT_PATH)\Logical\Tools\BuildVersion\BuildVersion.ps1

The Pre-Build Step will have to be set for all desired configurations.

Upon successful installation, users will see BuildVersion messages in the output results when building.

Errors

The argument "C:\projects\MyProject\Logical\BuildVersion\BuildVersion.ps1" to the -File parameter does not exist.

• Possible cause: The pre-build event was created but the BuildVersion package was not added to the project.
  • Remedy: Follow the installation instructions to add existing package to the project.
• Possible cause: The pre-build event created but does not point to the BuildVersion package.
  • Remedy: Update the pre-build field's script path $(WIN32_AS_PROJECT_PATH)\Logical\BuildVersion\BuildVersion.ps1 to match the path in the project

Object "C:\projects\MyProject\Logical\BuildVersion\BuildVer\Variable.var" doesn't exist.

• Possible cause: The BuildVersion package was added to the project, but the pre-build event was not created.
  • Remedy: Follow the installation instructions to create the pre-build event.
• Possible cause: The local task was renamed and the PowerShell script cannot find it.
  • Remedy: Update the PowerShell script's $ProgramName parameter (default "BuildVer") to match the task name in the project.

BuildVersion: Git in not installed or unavailable in PATH environment
BuildVersion: Please install git (git-scm.com) with recommended options for PATH

• Possible cause: Using the git client Sourcetree with the embedded git preference.
  • Remedy: Installing Sourcetree before installing git causes Sourcetree to default to its embedded git option. Sourcetree's embedded git is not available in the PATH environment. Install git separately with default installer options to add git to the PATH environment.

Developers

The PowerShell script offers several optional switch parameters.

-ErrorOnRepository

Create a build error if git is not installed of the project path does not exist within a git repository.

-ErrorOnChange

Create a build error if the git repository shows uncommited changes.

-ErrorOnInitialization

Create a build error if neither the local variable or global variable was updated with build information.

-PrintDebug

Print all debug messages to the output results.

To run multiple commands in the pre-build event, use the follow syntax.

<command_1> & <command_2>

Build

Building a project with this package may result in warnings for additional files.

In Automation Studio 4.11+, it is possible to add specific filters to warnings 9232 and 9233. Navigate to Configuration View, right-click the PLC object and select properties, chose the Build tab, and add the follow text to the "Objects ignored for build warnings 9232 and 9233" field. The filters are case sensitive.

*README*;*LICENSE*;.git;.gitignore;.github

Prior to Automation Studio 4.11, it is possible to suppress all build warnings regarding additional files by using -W 9232 9233 in the "Additional build options" field.