Public/Build/Update-BrownserveRepository.ps1
|
function Update-BrownserveRepository { [CmdletBinding()] param ( # The path to the repository [Parameter(Mandatory = $true, Position = 0)] [string] $RepoPath, # The type of build that should be installed in this repo [Parameter(Mandatory = $false)] [ValidateNotNullOrEmpty()] [BrownserveRepoProjectType] $ProjectType = 'generic', # The config file to use for setting our .gitignore content [Parameter(Mandatory = $false, DontShow)] [string] $GitIgnoreConfigFile = (Join-Path $Script:BrownservePSToolsConfigDirectory 'gitignore_config.json'), # The config file to use for setting our .gitignore content [Parameter(Mandatory = $false, DontShow)] [string] $PaketDependenciesConfigFile = (Join-Path $Script:BrownservePSToolsConfigDirectory 'paket_dependencies_config.json'), # The config file to use that stores our permanent/ephemeral path configuration [Parameter(Mandatory = $false, DontShow)] [string] $RepositoryPathsConfigFile = (Join-Path $Script:BrownservePSToolsConfigDirectory 'repository_paths_config.json'), # The config file that stores devcontainer configurations [Parameter(Mandatory = $false, DontShow)] [string] $DevcontainerConfigFile = (Join-Path $Script:BrownservePSToolsConfigDirectory 'devcontainer_config.json'), # The config file that stores VS Code extension configuration [Parameter(Mandatory = $false, DontShow)] [string] $VSCodeExtensionsConfigFile = (Join-Path $Script:BrownservePSToolsConfigDirectory 'repository_vscode_extensions.json') #TODO: Create a changelog and licence automagically? ) begin { # Ensure that dotnet is available for us to use, we need it to instal tooling and make our nuget.config try { $RequiredTools = @('git', 'dotnet') Write-Verbose 'Checking for required tooling' Assert-Command $RequiredTools } catch { throw "$($_.Exception.Message)`nThese tools are required to configure a Brownserve repository." } # Ensure the config files are valid try { $GitIgnoreConfig = Read-ConfigurationFromFile $GitIgnoreConfigFile $PaketDependenciesConfig = Read-ConfigurationFromFile $PaketDependenciesConfigFile $RepositoryPathsConfig = Read-ConfigurationFromFile $RepositoryPathsConfigFile $DevcontainerConfig = Read-ConfigurationFromFile $DevcontainerConfigFile $VSCodeExtensionsConfig = Read-ConfigurationFromFile $VSCodeExtensionsConfigFile -AsHashtable } catch { throw "Failed to import configuration data.`n$($_.Exception.Message)" } } process { Assert-Directory $RepoPath -ErrorAction 'Stop' # The below paths will always need to exist and we should check for them to avoid causing any mishaps even if we are going to do this on a branch $BuildDirectory = Join-Path $RepoPath '.build' $InitPath = Join-Path $BuildDirectory '_init.ps1' $PaketDependenciesPath = Join-Path $RepoPath 'paket.dependencies' $dotnetToolsConfigPath = Join-Path $RepoPath '.config' $dotnetToolsPath = Join-Path $dotnetToolsConfigPath 'dotnet-tools.json' $NugetConfigPath = Join-Path $RepoPath 'nuget.config' $GitIgnorePath = Join-Path $RepoPath '.gitignore' $VSCodePath = Join-Path $RepoPath '.vscode' $VSCodeExtensionsFilePath = Join-Path $VSCodePath 'extensions.json' $VSCodeWorkspaceSettingsFilePath = Join-Path $VSCodePath 'settings.json' $DevcontainerDirectoryPath = Join-Path $RepoPath '.devcontainer' $DevcontainerPath = Join-Path $DevcontainerDirectoryPath 'devcontainer.json' $DockerfilePath = Join-Path $DevcontainerDirectoryPath 'Dockerfile' $PathsToTest = @($InitPath, $PaketDependenciesPath, $dotnetToolsPath, $NugetConfigPath) $PathsToTest | ForEach-Object { if (!(Test-Path $_)) { throw "It looks like this project has not yet been initialized as the path '$_' doest not exist.`nPlease use 'Initialize-BrownserveRepository' to set-up this project." } } # Create our list of permanent paths that should be sync'd to git and not deleted between init's $DefaultPermanentPaths = $RepositoryPathsConfig.Defaults.PermanentPaths # And our list of ephemeral paths that are gitignored and recreated between init's $DefaultEphemeralPaths = $RepositoryPathsConfig.Defaults.EphemeralPaths <# We preform updates on a branch so we can avoid causing havoc, we do that now so we can ensure when we read from the various files in the repository we know what branch we are on! #> try { $CurrentBranch = Get-GitCurrentBranch -RepositoryPath $RepoPath } catch { throw $_.Exception.Message } # Make sure we're running on a branch $TempBranchName = 'brownserve_repo_update' if ($CurrentBranch -ne $TempBranchName) { Write-Debug "Current branch: $CurrentBranch" # Check to see if we've already got the branch available to use try { $LocalBranches = Get-GitBranches ` -RepositoryPath $RepoPath ` -ErrorAction 'Stop' } catch { # Let this silently fail and just try and create the branch anyways Write-Debug "Get-GitBranches has failed with $($_.Exception.Message).`nIgnoring" } if ($LocalBranches -contains $TempBranchName) { Write-Verbose "'$TempBranchName' already exists, attempting to checkout" try { Switch-GitBranch ` -RepositoryPath $RepoPath ` -BranchName $TempBranchName ` -ErrorAction 'Stop' } catch { throw "The branch '$TempBranchName' already exists but git was unable to checkout this branch.`n$($_.Exception.Message)" } } else { Write-Verbose "Creating new branch '$TempBranchName'" try { New-GitBranch ` -RepositoryPath $RepoPath ` -BranchName $TempBranchName ` -Checkout $true ` -ErrorAction 'Stop' } catch { throw "Failed to create working branch.`n$($_.Exception.Message)" } } } <# We have various VS Code extensions that we recommend the user install, these are stored per project in the .vscode directory. The user may have added some of their own so we import the list of extensions. #> try { $VSCodeWorkspaceExtensionIDs = Get-VSCodeWorkspaceExtensions -WorkspacePath $RepoPath -ErrorAction 'Stop' } catch [BrownserveFileNotFound] { # Repo probably doesn't have the extensions.json file yet, so we'll create an empty array for storing any extension ID's we need $VSCodeWorkspaceExtensionIDs = @() } catch { throw "Failed to get existing recommended extensions.`n$($_.Exception.Message)" } <# VS Code stores local extension settings per-project (when configured) in the .vscode/setting.json file. We set some ourselves but we should try to preserve any the user may have already set. #> try { $VSCodeWorkspaceSettings = Get-VSCodeWorkspaceSettings -WorkspacePath $RepoPath -ErrorAction 'Stop' } catch [BrownserveFileNotFound] { Write-Verbose 'No VS Code settings.json file found, creating an empty list' # Repo probably doesn't have the settings.json file yet, so we'll create an empty hashtable $VSCodeWorkspaceSettings = [ordered]@{} } catch { throw "Failed to get existing VSCode settings.`n$($_.Exception.Message)" } # Check to see if there are any manually defined gitignore entries try { $ManualGitIgnores = Search-FileContent ` -FilePath $GitIgnorePath ` -StartStringPattern '\#\# Manually defined ignores\: \#\#' ` -AsString ` -ErrorAction 'Stop' } catch { throw "Failed to search '$GitIgnorePath' for manual entries.`n$($_.Exception.Message)" } # Similarly for paket packages try { $ManualPaketEntries = Search-FileContent ` -FilePath $PaketDependenciesPath ` -StartStringPattern '\#\# Manually defined dependencies\: \#\#' ` -AsString ` -ErrorAction 'Stop' } catch { throw "Failed to search '$PaketDependenciesPath' for manual entries.`n$($_.Exception.Message)" } # And for any custom _init.ps1 steps try { $CustomInitSteps = Search-FileContent ` -FilePath $InitPath ` -StartStringPattern '\#\#\# Start user defined _init steps' ` -StopStringPattern '\#\#\# End user defined _init steps' ` -AsString ` -ErrorAction 'Stop' } catch { throw "Failed to search '$InitPath' for custom init steps.`n$($_.Exception.Message)" } # Build up our default list of gitignore's that we always want to use # TODO: Do we want to make ignoring paket.lock optional? $DefaultGitIgnores = $GitIgnoreConfig.Defaults # Set-up the paket dependency that are common to all our projects $DefaultPaketDependencies = $PaketDependenciesConfig.Defaults # Careful -AsHashtable makes key names case sensitive when converted from JSON! (defaults != Defaults) $DefaultVSCodeExtensions = $VSCodeExtensionsConfig.Defaults <# Our repos can house various different things, each with their own unique VS code extensions, paths, gitignore contents etc #> switch ($ProjectType) { <# For a repo that houses a PowerShell module we'll want to include: - The logic for loading the module as part of the _init script - PlatyPS for building module documentation - powershell-yaml for working with CI/CD files - Invoke-Build/Pester for building and testing the module #> 'PowerShellModule' { Write-Debug 'PowerShell Module selected' # Check our configuration files for any special logic when working with PowerShell module repos $DockerfileName = $DevcontainerConfig.PowerShellModule.Dockerfile $ExtraPermanentPaths = $RepositoryPathsConfig.PowerShellModule.PermanentPaths $ExtraEphemeralPaths = $RepositoryPathsConfig.PowerShellModule.EphemeralPaths $ExtraPaketDeps = $PaketDependenciesConfig.PowerShellModule $ExtraGitIgnores = $GitIgnoreConfig.PowerShellModule $ExtraVSCodeExtensions = $VSCodeExtensionsConfig.PowerShellModule $InitParams = @{ IncludeModuleLoader = $true IncludePowerShellYaml = $true IncludePlatyPS = $true IncludeBuildTestTools = $true } } <# For the repo that houses this very PowerShell module we want to do things a little differently. We avoid loading the Brownserve.PSTools module locally in _init.ps1 and use nuget as normal to get a stable version (this ensures that we can still get notified of failed builds) We can use our build to load the local version of the module. #> 'BrownservePSTools' { Write-Debug 'BrownservePSTools selected' # For now we use the same basic config as all our other PowerShell modules $DockerfileName = $DevcontainerConfig.PowerShellModule.Dockerfile $ExtraPermanentPaths = $RepositoryPathsConfig.PowerShellModule.PermanentPaths $ExtraEphemeralPaths = $RepositoryPathsConfig.PowerShellModule.EphemeralPaths $ExtraPaketDeps = $PaketDependenciesConfig.PowerShellModule $ExtraGitIgnores = $GitIgnoreConfig.PowerShellModule $ExtraVSCodeExtensions = $VSCodeExtensionsConfig.PowerShellModule $InitParams = @{ IncludeModuleLoader = $false # With the exception that we don't load the module locally (as it will conflict) IncludePowerShellYaml = $true IncludePlatyPS = $true IncludeBuildTestTools = $true } } Default {} } <# If we've got any overrides then set#> if ($DockerfileName) { $DevcontainerParams = @{ Dockerfile = $DockerfileName RequiredExtensions = @() } } if ($ExtraPermanentPaths) { $FinalPermanentPaths = $DefaultPermanentPaths + $ExtraPermanentPaths } else { $FinalPermanentPaths = $DefaultPermanentPaths } if ($ExtraEphemeralPaths) { $FinalEphemeralPaths = $DefaultEphemeralPaths + $ExtraEphemeralPaths } else { $FinalEphemeralPaths = $DefaultEphemeralPaths } $InitParams.Add('PermanentPaths', $FinalPermanentPaths) $InitParams.Add('EphemeralPaths', $FinalEphemeralPaths) if ($ExtraGitIgnores) { $FinalGitIgnores = $DefaultGitIgnores + $ExtraGitIgnores } else { $FinalGitIgnores = $DefaultGitIgnores } $GitIgnoreParams = @{ GitIgnores = $FinalGitIgnores } if ($ManualGitIgnores) { $GitIgnoreParams.Add('ManualGitIgnores', $ManualGitIgnores) } if ($ExtraPaketDeps) { $FinalPaketDependencies = $DefaultPaketDependencies + $ExtraPaketDeps } else { $FinalPaketDependencies = $DefaultPaketDependencies } $PaketParams = @{ PaketDependencies = $FinalPaketDependencies } if ($ManualPaketEntries) { $PaketParams.Add('ManualDependencies', $ManualPaketEntries) } if ($CustomInitSteps) { $InitParams.Add('CustomInitSteps', $CustomInitSteps) } if ($ExtraVSCodeExtensions) { $VSCodeExtensions = $DefaultVSCodeExtensions + $ExtraVSCodeExtensions } else { $VSCodeExtensions = $DefaultVSCodeExtensions } if ($VSCodeExtensions.Count -gt 0) { # Extract the list of extension ID's we want to install in this repo and clean up any duplicates $VSCodeWorkspaceExtensionIDs += $VSCodeExtensions.ExtensionID $VSCodeWorkspaceExtensionIDs = $VSCodeWorkspaceExtensionIDs | Select-Object -Unique <# Due to the way we store the VS Code settings in our config file, they end up clumping together in an array when we expand the object property. We need a single hash to be able to create the settings.json file correctly. By far the easiest method is to pass our array of Hashtable's to the Merge-Hashtable cmdlet with a blank hashtable We specify -Deep as we can specify the same extension settings multiple times (e.g. spellings) #> try { $VSCodeExtensionSettings = Merge-Hashtable ` -BaseObject @{} ` -InputObject $VSCodeExtensions.CustomSettings ` -Deep ` -ErrorAction 'Stop' } catch { throw "Failed to convert VS Code extension settings to hashtable.`n$($_.Exception.Message)" } <# If we've already got VS Code settings in the repository then merge in any of our custom settings. #> if ($VSCodeWorkspaceSettings.Count -gt 0) { $MergeParams = @{ BaseObject = $VSCodeWorkspaceSettings InputObject = $VSCodeExtensionSettings } try { $VSCodeWorkspaceSettings = Merge-Hashtable ` @MergeParams ` -Deep ` -ErrorAction 'Stop' } catch { throw "Failed to merge repository VS code settings.`n$($_.Exception.Message)" } } else { $VSCodeWorkspaceSettings = $VSCodeExtensionSettings } # Order the resulting settings hashtable, it makes it easier to find settings if they are grouped together. $VSCodeWorkspaceSettings = ConvertTo-SortedHashtable $VSCodeWorkspaceSettings } # Create the _init script as that will always be required try { $InitScriptContent = New-BrownserveInitScript @InitParams -ErrorAction 'Stop' } catch { throw "Failed to generate _init.ps1 content.`n$($_.Exception.Message)" } # The .gitignore file should always be required too try { $GitIgnoresContent = New-GitIgnoresFile @GitIgnoreParams -ErrorAction 'Stop' } catch { throw "Failed to generate .gitignore file.`n$($_.Exception.Message)" } # Paket may or may not be required if ($PaketParams) { try { $PaketDependenciesContent = New-PaketDependenciesFile @PaketParams -ErrorAction 'Stop' } catch { throw "Failed to generate paket.dependencies file.`n$($_.Exception.Message)" } } if ($DevcontainerParams) { $DevcontainerParams.RequiredExtensions = $VSCodeWorkspaceExtensionIDs try { $Devcontainer = New-VSCodeDevContainer @DevcontainerParams -ErrorAction 'Stop' } catch { throw "Failed to create devcontainer.`n$($_.Exception.Message)" } } ## Only start updating files on disk if we're sure we've got everything we need # Start by ensuring the permanent paths exist, these are often needed for the bits that come after try { $FinalPermanentPaths.GetEnumerator() | ForEach-Object { <# All paths should be relative to the repository root. The entry may contain child paths, hopefully the user has defined them in the correct order so the parent always gets created first! #> if ($_.ChildPaths) { $JoinPathParams = @{ Path = $RepoPath ChildPath = $_.Path AdditionalChildPath = $_.ChildPaths } } else { $JoinPathParams = @{ Path = $RepoPath ChildPath = $_.Path } } $CurrentPath = (Join-Path @JoinPathParams) if (!(Test-Path $CurrentPath)) { # I think these should _always_ be directories, but we may need to rethink this if not! New-Item ` -Path ` -ItemType 'Directory' | Out-Null } } } catch { throw "Failed to create permanent paths.`n$($_.Exception.Message)" } try { if (Test-Path $InitPath) { $Verb = 'update' Set-Content ` -Path $InitPath ` -Value $InitScriptContent ` -NoNewline ` -ErrorAction 'Stop' } else { $Verb = 'create' New-Item ` -Path $InitPath ` -Value $InitScriptContent ` -ItemType File ` -Force:$Force | Out-Null } } catch { throw "Failed to $Verb '$InitPath'.`n$($_.Exception.Message)" } try { if (Test-Path $GitIgnorePath) { $Verb = 'update' Set-Content ` -Path $GitIgnorePath ` -Value $GitIgnoresContent ` -NoNewline ` -ErrorAction 'Stop' } else { $Verb = 'create' New-Item ` -Path $GitIgnorePath ` -ItemType File ` -Value $GitIgnoresContent ` -Force:$Force | Out-Null } } catch { throw "Failed to $Verb '$GitIgnorePath'.`n$($_.Exception.Message)" } if (!(Test-Path $VSCodePath)) { try { New-Item ` -Path $VSCodePath ` -ItemType Directory ` -ErrorAction 'Stop' | Out-Null } catch { throw "Failed to create VSCode directory.`n$($_.Exception.Message)" } } if ($VSCodeWorkspaceSettings.Count -gt 0) { try { $File = 'extensions.json' $VSCodeWorkspaceExtensionIDsJSON = ConvertTo-Json ` -InputObject @{ recommendations = $VSCodeWorkspaceExtensionIDs } ` -Depth 100 ` -ErrorAction 'Stop' $File = 'settings.json' $VSCodeWorkspaceSettingsJSON = ConvertTo-Json ` -InputObject $VSCodeWorkspaceSettings ` -Depth 100 ` -ErrorAction 'Stop' } catch { throw "Failed to convert JSON for $File.`n$($_.Exception.Message)" } try { if (!(Test-Path $VSCodeExtensionsFilePath)) { $Verb = 'create' New-Item ` -Path $VSCodeExtensionsFilePath ` -ItemType File ` -Value $VSCodeWorkspaceExtensionIDsJSON ` -Force:$Force | Out-Null } else { $Verb = 'update' Set-Content ` -Path $VSCodeExtensionsFilePath ` -Value $VSCodeWorkspaceExtensionIDsJSON ` -ErrorAction 'Stop' | Out-Null } } catch { throw "Failed to $Verb '$VSCodeExtensionsFilePath'.`n$($_.Exception.Message)" } try { if (!(Test-Path $VSCodeWorkspaceSettingsFilePath)) { $Verb = 'create' New-Item ` -Path $VSCodeWorkspaceSettingsFilePath ` -ItemType File ` -Value $VSCodeWorkspaceSettingsJSON ` -Force:$Force | Out-Null } else { $Verb = 'update' Set-Content ` -Path $VSCodeWorkspaceSettingsFilePath ` -Value $VSCodeWorkspaceSettingsJSON ` -ErrorAction 'Stop' | Out-Null } } catch { throw "Failed to $Verb '$VSCodeWorkspaceSettingsFilePath'.`n$($_.Exception.Message)" } } if ($PaketDependenciesContent) { try { if (!(Test-Path $PaketDependenciesPath)) { $Verb = 'create' New-Item ` -Path $PaketDependenciesPath ` -ItemType File ` -Value $PaketDependenciesContent ` -Force:$Force | Out-Null } else { $Verb = 'update' Set-Content ` -Path $PaketDependenciesPath ` -Value $PaketDependenciesContent ` -NoNewline ` -ErrorAction 'Stop' | Out-Null } } catch { throw "Failed to $Verb '$PaketDependenciesPath'.`n$($_.Exception.Message)" } } if ($Devcontainer) { if (!(Test-Path $DevcontainerDirectoryPath)) { try { New-Item ` -Path $DevcontainerDirectoryPath ` -ItemType Directory ` -Force:$Force ` -ErrorAction 'Stop' | Out-Null } catch { throw "Failed to create '$DevcontainerDirectoryPath'" } try { New-Item ` -Path $DevcontainerPath ` -ItemType File ` -Value $Devcontainer.Devcontainer ` -ErrorAction 'Stop' | Out-Null } catch { throw "Failed to create '$DevcontainerPath'.`n$($_.Exception.Message)" } try { New-Item ` -Path $DockerfilePath ` -ItemType File ` -Value $Devcontainer.Dockerfile ` -ErrorAction 'Stop' | Out-Null } catch { throw "Failed to create '$DockerfilePath'.`n$($_.Exception.Message)" } } else { try { Set-Content ` -Path $DevcontainerPath ` -Value $Devcontainer.Devcontainer ` -NoNewline ` -ErrorAction 'Stop' | Out-Null } catch { throw "Failed to update '$DevcontainerPath'.`n$($_.Exception.Message)" } try { Set-Content ` -Path $DockerfilePath ` -Value $Devcontainer.Dockerfile ` -NoNewline ` -ErrorAction 'Stop' | Out-Null } catch { throw "Failed to update '$DockerfilePath'.`n$($_.Exception.Message)" } } } # Update the version of Paket we are using try { Write-Verbose 'Updating Paket' Invoke-NativeCommand ` -FilePath 'dotnet' ` -ArgumentList 'tool', 'update', 'Paket' ` -WorkingDirectory $RepoPath ` -SuppressOutput } catch { throw "Failed to generate dotnet tools manifest.`n$($_.Exception.Message)" } } end { } } |