Public/Build/Initialize-BrownserveBuildRepo.ps1
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
function Initialize-BrownserveBuildRepo { [CmdletBinding()] param ( # The path to the repo that should be initialized [Parameter( Mandatory = $true, Position = 0 )] [string] $RepoPath, # Any custom init steps that you may want to include for this repo [Parameter( Mandatory = $false )] [string] $CustomInitSteps, # If set will exclude our custom module loader [Parameter()] [switch] $ExcludeModuleLoader, # If set will skip copying our default VSCode snippets [Parameter()] [switch] $ExcludeSnippets, # If set will skip copying over the default VS code workspace settings [Parameter()] [switch] $ExcludeVSCodeSettings, # If set will include our default devcontainer [Parameter()] [switch] $IncludeDevcontainer, # Will forcefully overwrite files [Parameter()] [switch] $Force ) Write-Host "Preparing repo $RepoPath for use with Brownserve.PSTools" Write-Verbose "Checking repo path is valid" try { if (!(Get-Item $RepoPath).PSIsContainer) { throw "$RepoPath does not appear to be a directory" } } catch { throw "$RepoPath does not appear to be a valid directory" } # We need dotnet to create our tool manifest and nuget.config try { Write-Verbose "Checking dotnet is present" $dotnetCheck = Get-Command 'dotnet' } catch {} if (!$dotnetCheck) { throw "'dotnet' is not available on your path, have you installed it?" } <# Let's see if we've already got an _init file and if so extract any custom steps the user might have We do this check early as it's one of the one's that's more likely to fail and therefore we want to catch it before we've done any other set-up #> if (!$CustomInitSteps) { $CustomInitSteps = "" } $InitPath = Join-Path $RepoPath '.build' -AdditionalChildPath '_init.ps1' # TODO: probably shouldn't hardcode '.build' here... if ((Test-Path $InitPath)) { try { $CustomInitStepsCheck = (Read-BrownserveInitFile $InitPath).CustomCode | Out-String } catch { # Only throw if we're not forcing replacement if (-not $Force) { throw "$($_.Exception.Message), re-run cmdlet with '-Force' to overwrite the _init.ps1 file with a new one." } } if ($CustomInitStepsCheck) { [string]$FinalCustomInitSteps = $CustomInitStepsCheck + "$CustomInitSteps" } } $PermanentPaths = @( [InitPath]@{ VariableName = 'RepoBuildDirectory' Path = '.build' Description = 'Holds all build related configuration along with this _init script' LocalPath = (Join-Path $RepoPath '.build') }, [InitPath]@{ VariableName = 'RepoCodeDirectory' Path = '.build' ChildPaths = 'code' Description = 'Used to store any custom code/scripts/modules' LocalPath = (Join-Path $RepoPath '.build' 'code') } ) Write-Debug ($PermanentPaths | Out-String) $EphemeralPaths = @( [InitPath]@{ VariableName = 'RepoLogDirectory' Path = '.log' Description = 'Used to store build logs and output from Invoke-NativeCommand' }, [InitPath]@{ VariableName = 'RepoBuildOutputDirectory' Path = '.build' ChildPaths = 'output' Description = 'Used to store any output from builds (e.g. Terraform plans, MSBuild artifacts etc)' }, [InitPath]@{ VariableName = 'RepoBinDirectory' Path = '.bin' Description = 'Used to store any downloaded binaries required for builds, cmdlets like Get-Vault make use of this variable' } ) Write-Debug ($EphemeralPaths | Out-String) # Create the permanent paths $PermanentPaths | ForEach-Object { if (!(Test-Path $_.LocalPath)) { try { New-Item $_.LocalPath -ItemType Directory | Out-Null } catch { throw "Failed to created directory $($_.LocalPath).`n$($_.Exception.Message)" } } } # gitignore the ephemeral paths $GitIgnorePath = Join-Path $RepoPath '.gitignore' $GitIgnoreItems = @( 'paket.lock', 'packages/', 'paket-files/' ) $EphemeralPaths | ForEach-Object { if ($_.ChildPaths) { $GitIgnoreItems += "$($_.Path)/$($_.ChildPaths -join '/')/" } else { $GitIgnoreItems += "$($_.Path)/" } } Write-Debug ".gitignore items:`n$($GitIgnoreItems -join "`n")" # Create out .gitignore file if it doesn't exist if (!(Test-Path $GitIgnorePath)) { Write-Verbose "Creating new .gitignore" try { New-Item $GitIgnorePath -ItemType File -Value ($GitIgnoreItems | Out-String) | Out-Null } catch { throw "Failed to create .gitignore.`n$($_.Exception.Message)" } } else { # Read in the gitignore and make sure that we have everything we need to ignore Write-Verbose "Checking contents of .gitignore" $GitIgnoreContent = Get-Content $GitIgnorePath $GitIgnoreItems | ForEach-Object { if ($GitIgnoreContent -notcontains $_) { Write-Verbose "Adding $_ to gitignore list" Add-Content $GitIgnorePath -Value "`n$_" } } } # Create a local nuget.config $NugetConfigPath = Join-Path $RepoPath 'nuget.config' if (!(Test-Path $NugetConfigPath)) { Write-Verbose "Creating new nuget.config" try { Invoke-NativeCommand ` -FilePath 'dotnet' ` -ArgumentList 'new','nugetconfig' ` -WorkingDirectory $RepoPath ` -SuppressOutput } catch { throw "Failed to create nuget.config.`n$($_.Exception.Message)" } } # Check if we already have a tools manifest and create if not $dotnetToolsPath = Join-Path $RepoPath '.config' 'dotnet-tools.json' if (!(Test-Path $dotnetToolsPath)) { Write-Verbose "Creating new dotnet tool manifest" try { Invoke-NativeCommand ` -FilePath 'dotnet' ` -ArgumentList 'new', 'tool-manifest' ` -WorkingDirectory $RepoPath ` -SuppressOutput } catch { throw "Failed to create dotnet tool manifest.`n$($_.Exception.Message)" } } # Install/update paket $dotnetCommand = 'install' try { $PaketCheck = (Get-Content $dotnetToolsPath -Raw) -match '"paket"' if ($PaketCheck) { Write-Verbose "Paket already defined in manifest, will update if necessary" $dotnetCommand = 'update' } } catch { throw $_.Exception.Message } Write-Verbose "Will attempt to $dotnetCommand paket" try { Invoke-NativeCommand ` -FilePath 'dotnet' ` -ArgumentList "tool", "$dotnetCommand", "Paket" ` -WorkingDirectory $RepoPath ` -SuppressOutput } catch { throw "Failed to $dotnetCommand paket.`n$($_.Exception.Message)" } # Create/update paket.dependencies $PaketDependenciesPath = Join-Path $RepoPath 'paket.dependencies' $PaketSources = @('source https://api.nuget.org/v3/index.json') $PaketDependencies = 'nuget Brownserve.PSTools' if (!(Test-Path $PaketDependenciesPath)) { Write-Verbose "Creating 'paket.dependencies'" $PaketDependenciesContent = "$($PaketSources -join "`n")`n$PaketDependencies" try { New-Item $PaketDependenciesPath -ItemType File -Value $PaketDependenciesContent | Out-Null } catch { throw "Failed to create paket.dependencies.`n$($_.Exception.Message)" } } else { Write-Verbose "Updating 'paket.dependencies'" try { $PaketDependenciesContent = Get-Content $PaketDependenciesPath if ($PaketDependenciesContent -notcontains $PaketDependencies) { Add-Content $PaketDependenciesPath -Value $PaketDependencies } $PaketSources | ForEach-Object { if ($PaketDependenciesContent -notcontains $_) { Add-Content $PaketDependenciesPath -Value $_ } } } catch { throw $_.Exception.Message } } # Copy snippets if (!$ExcludeSnippets) { Write-Verbose 'Copying VSCode snippets' try { Copy-VSCodeFile -RepoPath $RepoPath -VSCodeFile 'brownserve-pstools.code-snippets' } catch { throw $_.Exception.Message } } # Copy our default workspace settings if (!$ExcludeVSCodeSettings) { Write-Verbose "Copying default VSCode workspace settings" try { Copy-VSCodeFile -RepoPath $RepoPath -VSCodeFile 'settings.json' } catch { throw $_.Exception.Message } } # Copy devcontainer if ($IncludeDevcontainer) { Write-Verbose "Copying default devcontainer" try { Copy-VSCodeDevcontainer ` -RepoPath $RepoPath } catch { throw "Failed to set-up devcontainer.`n$($_.Exception.Message)" } } # Create the _init script Write-Verbose "Creating _init.ps1" $InitScriptParams = @{ PermanentPaths = $PermanentPaths EphemeralPaths = $EphemeralPaths CustomInitSteps = $FinalCustomInitSteps } if ($ExcludeModuleLoader -eq $false) { $InitScriptParams.Add('IncludeModuleLoader', $true) } try { $InitScriptContent = New-BrownserveInitScript @InitScriptParams New-Item $InitPath -Value $InitScriptContent -Force -Confirm:$false | Out-Null } catch { throw "Failed to create _init script.`n$($_.Exception.Message)" } Write-Host "$RepoPath has been successfully set-up to work with Brownserve.PSTools! 🎉" -ForegroundColor Green } |