forked from microsoft/AL-Go
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve IncrementVersionNumber action (microsoft#910)
Fixes microsoft#889 : `appFolders` with wild characters are not resolved when reading the app.json files. Also fixes issue that the `version` property in `dependencies` array in the app.json is not changed. - [x] Release notes - [x] More tests
- Loading branch information
Showing
6 changed files
with
486 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
200 changes: 200 additions & 0 deletions
200
Actions/IncrementVersionNumber/IncrementVersionNumber.psm1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| <# | ||
| .Synopsis | ||
| Changes a version setting value in a settings file. | ||
| .Description | ||
| Changes a version setting value in a settings file. | ||
| If the setting does not exist in the settings file, the function does nothing, unless the Force parameter is specified. | ||
| .Parameter settingsFilePath | ||
| Path to a JSON file containing the settings. | ||
| .Parameter settingName | ||
| Name of the setting to change. The setting must be a version number. | ||
| .Parameter newValue | ||
| New value of the setting. Allowed values are: +1 (increment major version number), +0.1 (increment minor version number), or a version number in the format Major.Minor (e.g. 1.0 or 1.2 | ||
| .Parameter Force | ||
| If specified, the function will create the setting if it does not exist in the settings file. | ||
| #> | ||
| function Set-VersionInSettingsFile { | ||
| param( | ||
| [Parameter(Mandatory = $true)] | ||
| [string] $settingsFilePath, | ||
| [Parameter(Mandatory = $true)] | ||
| [string] $settingName, | ||
| [Parameter(Mandatory = $true)] | ||
| [string] $newValue, | ||
| [switch] $Force | ||
| ) | ||
|
|
||
| #region Validate parameters | ||
| if (-not (Test-Path $settingsFilePath)) { | ||
| throw "Settings file ($settingsFilePath) not found." | ||
| } | ||
|
|
||
| Write-Host "Reading settings from $settingsFilePath" | ||
| try { | ||
| $settingsJson = Get-Content $settingsFilePath -Encoding UTF8 -Raw | ConvertFrom-Json | ||
| } | ||
| catch { | ||
| throw "Settings file ($settingsFilePath) is malformed: $_" | ||
| } | ||
|
|
||
| $settingExists = [bool] ($settingsJson.PSObject.Properties.Name -eq $settingName) | ||
| if ((-not $settingExists) -and (-not $Force)) { | ||
| Write-Host "Setting $settingName not found in $settingsFilePath" | ||
| return | ||
| } | ||
|
|
||
| # Add the setting if it does not exist | ||
| if (-not $settingExists) { | ||
| $settingsJson | Add-Member -MemberType NoteProperty -Name $settingName -Value $null | ||
| } | ||
|
|
||
| $oldValue = [System.Version] $settingsJson.$settingName | ||
| # Validate new version value | ||
| if ($newValue.StartsWith('+')) { | ||
| # Handle incremental version number | ||
|
|
||
| $allowedIncrementalVersionNumbers = @('+1', '+0.1') | ||
| if (-not $allowedIncrementalVersionNumbers.Contains($newValue)) { | ||
| throw "Incremental version number $newValue is not allowed. Allowed incremental version numbers are: $($allowedIncrementalVersionNumbers -join ', ')" | ||
| } | ||
|
|
||
| # Defensive check. Should never happen. | ||
| if($null -eq $oldValue) { | ||
| throw "The setting $settingName does not exist in the settings file. It must exist to be able to increment the version number." | ||
| } | ||
| } | ||
| else { | ||
| # Handle absolute version number | ||
|
|
||
| $versionNumberFormat = '^\d+\.\d+$' # Major.Minor | ||
| if (-not ($newValue -match $versionNumberFormat)) { | ||
| throw "Version number $newValue is not in the correct format. The version number must be in the format Major.Minor (e.g. 1.0 or 1.2)" | ||
| } | ||
| } | ||
| #endregion | ||
|
|
||
| $versionNumbers = @() # an array to hold the version numbers: major, minor, build, revision | ||
|
|
||
| switch($newValue) { | ||
| '+1' { | ||
| # Increment major version number | ||
| $versionNumbers += $oldValue.Major + 1 | ||
| $versionNumbers += 0 | ||
| } | ||
| '+0.1' { | ||
| # Increment minor version number | ||
| $versionNumbers += $oldValue.Major | ||
| $versionNumbers += $oldValue.Minor + 1 | ||
|
|
||
| } | ||
| default { | ||
| # Absolute version number | ||
| $versionNumbers += $newValue.Split('.') | ||
| } | ||
| } | ||
|
|
||
| # Include build and revision numbers if they exist in the old version number | ||
| if ($oldValue -and ($oldValue.Build -ne -1)) { | ||
| $versionNumbers += $oldValue.Build | ||
| if ($oldValue.Revision -ne -1) { | ||
| $versionNumbers += $oldValue.Revision | ||
| } | ||
| } | ||
|
|
||
| # Construct the new version number. Cast to System.Version to validate if the version number is valid. | ||
| $newValue = [System.Version] "$($versionNumbers -join '.')" | ||
|
|
||
| if($newValue -eq $oldValue) { | ||
| Write-Host "The setting $settingName is already set to $newValue in $settingsFilePath" | ||
| return | ||
| } | ||
|
|
||
| if($null -eq $oldValue) { | ||
| Write-Host "Setting setting $settingName to $newValue in $settingsFilePath" | ||
| } | ||
| else { | ||
| Write-Host "Changing $settingName from $oldValue to $newValue in $settingsFilePath" | ||
| } | ||
|
|
||
| $settingsJson.$settingName = $newValue.ToString() | ||
| $settingsJson | Set-JsonContentLF -Path $settingsFilePath | ||
| } | ||
|
|
||
| <# | ||
| .Synopsis | ||
| Changes the version number of a project. | ||
| .Description | ||
| Changes the version number of a project. | ||
| The version number is changed in the project settings file (value for 'repoVersion') and in the app.json files of all apps in the project, as well as all references to the apps in the dependencies of the app.json files. | ||
| .Parameter baseFolder | ||
| Base folder of the repository. | ||
| .Parameter project | ||
| Name of the project (relative to the base folder). | ||
| .Parameter newValue | ||
| New version number. If the version number starts with a +, the new version number will be added to the old version number. Else the new version number will replace the old version number. | ||
| #> | ||
| function Set-VersionInAppManifests($projectPath, $projectSettings, $newValue) { | ||
|
|
||
| # Check if the project uses repoVersion versioning strategy | ||
| $useRepoVersion = (($projectSettings.PSObject.Properties.Name -eq "versioningStrategy") -and (($projectSettings.versioningStrategy -band 16) -eq 16)) | ||
| if ($useRepoVersion) { | ||
| $newValue = $projectSettings.repoVersion | ||
| } | ||
|
|
||
| $allAppFolders = @($projectSettings.appFolders) + @($projectSettings.testFolders) + @($projectSettings.bcptTestFolders) | ||
| # Set version in app.json files | ||
| $allAppFolders | ForEach-Object { | ||
| $appFolder = Join-Path $projectPath $_ | ||
| $appJson = Join-Path $appFolder "app.json" | ||
|
|
||
| Set-VersionInSettingsFile -settingsFilePath $appJson -settingName 'version' -newValue $newValue | ||
| } | ||
| } | ||
|
|
||
| <# | ||
| .Synopsis | ||
| Changes the version number of dependencies in app.json files. | ||
| .Description | ||
| Changes the version number of dependencies in app.json files. | ||
| The version number of the dependencies is changed to the version number of the app that the dependency refers to. If the app is not found, the version number of the dependency is not changed. | ||
| .Parameter appFolders | ||
| Array of paths to the app folders. Each app folder must contain an app.json file. The apps are used to get the version number of the dependencies. | ||
| #> | ||
| function Set-DependenciesVersionInAppManifests { | ||
| param( | ||
| [Parameter(Mandatory = $true)] | ||
| [string[]] $appFolders | ||
| ) | ||
|
|
||
| # Get all apps info: app ID and app version | ||
| $appsInfos = @($appFolders | ForEach-Object { | ||
| $appJson = Join-Path $_ "app.json" | ||
| $app = Get-Content -Path $appJson -Encoding UTF8 -Raw | ConvertFrom-Json | ||
| return [PSCustomObject]@{ | ||
| Id = $app.id | ||
| Version = $app.version | ||
| } | ||
| }) | ||
|
|
||
| # Update dependencies in app.json files | ||
| $appFolders | ForEach-Object { | ||
| $appJsonPath = Join-Path $_ "app.json" | ||
|
|
||
| $appJson = Get-Content -Path $appJsonPath -Encoding UTF8 -Raw | ConvertFrom-Json | ||
|
|
||
| $dependencies = $appJson.dependencies | ||
|
|
||
| $dependencies | ForEach-Object { | ||
| $dependency = $_ | ||
| $appInfo = $appsInfos | Where-Object { $_.Id -eq $dependency.id } | ||
| if ($appInfo) { | ||
| Write-Host "Updating dependency app $($dependency.id) in $appJsonPath from $($dependency.version) to $($appInfo.Version)" | ||
| $dependency.version = $appInfo.Version | ||
| } | ||
| } | ||
|
|
||
| $appJson | Set-JsonContentLF -Path $appJsonPath | ||
| } | ||
| } | ||
|
|
||
| Export-ModuleMember -Function Set-VersionInSettingsFile, Set-VersionInAppManifests, Set-DependenciesVersionInAppManifests |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.