Skip to content

Commit 4fd478b

Browse files
committed
Modified Documentation
1 parent ac90da2 commit 4fd478b

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

Documentation/docs/BuildVersionTask/CommonErrors.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,20 @@
22

33
??? dropdown-ct "The argument "C:\projects\MyProject\Logical\BuildVersion\BuildVersion.ps1" to the -File parameter does not exist."
44
- Possible cause: The pre-build event was created but the BuildVersion package was not added to the project.
5-
- *Remedy*: Follow the [installation](#installation) instructions to add existing package to the project.
5+
- *Remedy*: Follow the [installation](./WithFrameworkImporterHelp.md) instructions to add existing package to the project.
66
- Possible cause: The pre-build event created but does not point to the BuildVersion package.
7-
- *Remedy*: Update the [pre-build field's](#2-create-pre-build-event) script path `$(WIN32_AS_PROJECT_PATH)\Logical\BuildVersion\BuildVersion.ps1` to match the path in the project
7+
- *Remedy*: Update the pre-build field's script path `$(WIN32_AS_PROJECT_PATH)\Logical\BuildVersion\BuildVersion.ps1` to match the path in the project
88

99
###
1010

1111
??? dropdown-ct "Object "C:\projects\MyProject\Logical\BuildVersion\BuildVer\Variable.var" doesn't exist."
1212
- Possible cause: The BuildVersion package was added to the project, but the pre-build event was not created.
13-
- *Remedy*: Follow the [installation](#2-create-pre-build-event) instructions to create the pre-build event.
13+
- *Remedy*: Follow the [installation](./WithFrameworkImporterHelp.md) instructions to create the pre-build event and ensure the prebuild event is present
14+
15+
```
16+
PowerShell -ExecutionPolicy ByPass -File $(WIN32_AS_PROJECT_PATH)\Logical\BuildVersion\BuildVersion.ps1 "$(WIN32_AS_PROJECT_PATH)" "$(AS_VERSION)" "$(AS_USER_NAME)" "$(AS_PROJECT_NAME)" "$(AS_CONFIGURATION)" "$(AS_BUILD_MODE)"
17+
```
18+
1419
- Possible cause: The local task was renamed and the PowerShell script cannot find it.
1520
- *Remedy*: Update the PowerShell script's `$ProgramName` parameter (default `"BuildVer"`) to match the task name in the project.
1621

Documentation/docs/BuildVersionTask/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Build Version package uses 2 main components:
66
- BuildVersion Task
77

88
## Pre Build Script
9-
The pre-build script is a Microsoft Powershell script that handles the interaction with git to parse out relevant version information for the project. The pre-build script also receives information from Automation Studio such as the Automation Studio version, PC name to include in your version information.
9+
The pre-build script is a Microsoft Powershell script that handles the interaction with git to parse out relevant version information for the project. The pre-build script also receives information from Automation Studio such as the Automation Studio version, PC name to include in your version information. This script is called by utilizing Automation Studio's pre-build event seen under the Project -> Change Runtime Version -> Build Events tab.
1010

1111
Additionally the script will create/update the BuildVersion.var file with the appropriate information for the current build.
1212

@@ -24,5 +24,7 @@ This task can be placed in any task class, however for simplicity it is recommen
2424

2525
Deploying the package can be accomplished in one of two ways, with or without the Framework Importer tool. It is recommended to use the Framework importer tool.
2626

27-
1. [With The Framework Importer](WithFrameworkImporterHelp.md)
28-
2. [Without The Framework Importer](WithoutFrameworkImporterHelp.md)
27+
[With The Framework Importer](WithFrameworkImporterHelp.md)
28+
29+
30+
The steps to implement without the Framework Importer tool can be found [here](https://github.com/br-na-pm/BuildVersion)

0 commit comments

Comments
 (0)