86 lines
1.7 KiB
Markdown
86 lines
1.7 KiB
Markdown
# ARM Build Script Documentation
|
|
|
|
## Overview
|
|
|
|
The `arm_build.ps1` script automates the build process for the GestoreTrimestrale solution, including environment setup, TFS workspace management, and test execution.
|
|
|
|
## Prerequisites
|
|
|
|
- Visual Studio 2022 (Enterprise, Professional, or Community edition)
|
|
- Team Foundation Server PowerShell Snapin
|
|
- MSBuild
|
|
- VSTest Console
|
|
|
|
## Usage
|
|
|
|
### Basic Usage
|
|
|
|
```powershell
|
|
.\arm_build.ps1
|
|
```
|
|
|
|
### Parameters
|
|
|
|
1. **LocalWorkspace** (string)
|
|
|
|
- Default: "C:\TFS Fideuram\TP_SEI_Project\root"
|
|
- Purpose: Specifies the root workspace directory
|
|
|
|
```powershell
|
|
.\arm_build.ps1 -LocalWorkspace "C:\CustomPath"
|
|
```
|
|
|
|
2. **SkipTests** (switch)
|
|
- Purpose: Skips test execution when specified
|
|
|
|
```powershell
|
|
.\arm_build.ps1 -SkipTests
|
|
```
|
|
|
|
3. **RunApp** (switch)
|
|
- Purpose: Launches the application after successful build
|
|
|
|
```powershell
|
|
.\arm_build.ps1 -RunApp
|
|
```
|
|
|
|
### Combined Usage
|
|
|
|
```powershell
|
|
.\arm_build.ps1 -LocalWorkspace "C:\CustomPath" -SkipTests -RunApp
|
|
```
|
|
|
|
## Build Process Steps
|
|
|
|
1. Environment validation
|
|
2. Visual Studio x64 environment setup
|
|
3. TFS workspace update
|
|
4. Configuration file updates
|
|
5. Solution build
|
|
6. Test execution (if not skipped):
|
|
- FlushFilesWaitingForZIP
|
|
- SetUpZipCases_DoNotUse
|
|
- ProcessCanComplete
|
|
- ZipIntegrity
|
|
- NumberOfPackedPDFIsOK
|
|
7. Application launch (if specified)
|
|
|
|
## Error Handling
|
|
|
|
The script includes comprehensive error handling with:
|
|
|
|
- Path validation
|
|
- Environment setup verification
|
|
- Build status checking
|
|
- Test execution monitoring
|
|
- Detailed error messages
|
|
|
|
## Output
|
|
|
|
The script provides colored console output for better visibility:
|
|
|
|
- Yellow: Process steps
|
|
- Cyan: Test execution
|
|
- Red: Errors
|
|
- Green: Success messages
|