Changes for making the release fetcher script public

README.md

@@ -52,6 +52,17 @@ Currently this tests for:
 New-ALZEnvironment -o <output_directory>
 ```
 
+## Additonal Cmdlets
+
+### Update an existing Azure Landing Zone Environment
+
+#### Downloads and pulls down the specified release version from the remote GitHub repository to a local directory
+
+
+```powershell
+Get-ALZGithubRelease -githubRepoUrl "https://github.com/Azure/ALZ-Bicep" -releases "v0.13.0" -directoryForReleases "C:\Repos\ALZ\accelerator\upstream-releases\"
+```
+
 ## Development
 
 ### Development Prerequisites
@@ -69,7 +80,7 @@ Import-Module .\src\Artifacts\ALZ.psd1 -Force
 ## Contributing
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
 
 When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
 

src/ALZ/ALZ.psd1

@@ -70,6 +70,7 @@
 
     # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
     FunctionsToExport = @(
+        'Get-ALZGithubRelease'
         'New-ALZEnvironment'
         'Test-ALZRequirement'
     )

src/ALZ/Private/Get-GithubRelease.ps1 → src/ALZ/Public/Get-ALZGithubRelease.ps1

@@ -1,5 +1,5 @@
 ####################################
-# Get-GithubRelease.ps1 #
+# Get-ALZGithubRelease.ps1 #
 ####################################
 # Version: 0.1.0
 # Based on Invoke-GitHubReleaseFetcher by Jack Tracey:
@@ -19,7 +19,7 @@ Checks for the releases of a GitHub repository and downloads the latest release
 #>
 
 
-function Get-GithubRelease {
+function Get-ALZGithubRelease {
     [CmdletBinding()]
     param (
         [Parameter(Mandatory = $true, Position = 1, HelpMessage = "Please the provide the full URL of the GitHub repository you wish to check for the latest release.")]

src/ALZ/Public/New-ALZEnvironment.ps1

@@ -52,7 +52,9 @@ function New-ALZEnvironment {
         New-ALZDirectoryEnvironment -alzEnvironmentDestination $alzEnvironmentDestination | Out-String | Write-Verbose
 
         $alzEnvironmentDestinationInternalCode = Join-Path $alzEnvironmentDestination "upstream-releases"
-        Get-GithubRelease -directoryForReleases $alzEnvironmentDestinationInternalCode -githubRepoUrl $bicepConfig.module_url -releases @($bicepConfig.version) | Out-String | Write-Verbose
+
+        Get-ALZGithubRelease -directoryForReleases $alzEnvironmentDestinationInternalCode -githubRepoUrl $bicepConfig.module_url -releases @($bicepConfig.version) | Out-String | Write-Verbose
+
         Write-InformationColored "Copying ALZ-Bicep module to $alzEnvironmentDestinationInternalCode" -ForegroundColor Green -InformationAction Continue
         Copy-ALZParametersFile -alzEnvironmentDestination $alzEnvironmentDestination -upstreamReleaseDirectory $(Join-Path $alzEnvironmentDestinationInternalCode $bicepConfig.version) -configFiles $bicepConfig.config_files | Out-String | Write-Verbose
         Write-InformationColored "ALZ-Bicep source directory: $alzBicepSourceDirectory" -ForegroundColor Green -InformationAction Continue

src/Tests/Unit/Private/Get-GithubRelease.Tests.ps1 → src/Tests/Unit/Public/Get-ALZGithubRelease.Tests.ps1

@@ -12,7 +12,7 @@ Import-Module $PathToManifest -Force
 #-------------------------------------------------------------------------
 
 InModuleScope 'ALZ' {
-    Describe 'Get-GithubRelease Function Tests' -Tag Unit {
+    Describe 'Get-ALZGithubRelease Function Tests' -Tag Unit {
         BeforeAll {
             $WarningPreference = 'SilentlyContinue'
             $ErrorActionPreference = 'SilentlyContinue'
@@ -99,18 +99,18 @@ InModuleScope 'ALZ' {
             }
 
             It 'Should get the correct releases' {
-                Get-GithubRelease -githubRepoUrl "http://github.com/test/repo" -directoryAndFilesToKeep @('repo-1.0.0') -directoryForReleases "output"
+                Get-ALZGithubRelease -githubRepoUrl "http://github.com/test/repo" -directoryAndFilesToKeep @('repo-1.0.0') -directoryForReleases "output"
                 Should -Invoke Expand-Archive
                 Should -Not -Invoke Write-Warning
             }
 
             It 'Should warn when you ask for a release that does not exist' {
-                Get-GithubRelease -githubRepoUrl "http://github.com/test/repo" -releases @('v2.0.0') -directoryAndFilesToKeep @('repo-1.0.0') -directoryForReleases "output"
+                Get-ALZGithubRelease -githubRepoUrl "http://github.com/test/repo" -releases @('v2.0.0') -directoryAndFilesToKeep @('repo-1.0.0') -directoryForReleases "output"
                 Should -Invoke Write-Warning
             }
 
             It 'Should download all the releases with all' {
-                Get-GithubRelease -githubRepoUrl "http://github.com/test/repo" -releases @('all') -directoryAndFilesToKeep @('repo-1.0.0') -directoryForReleases "output"
+                Get-ALZGithubRelease -githubRepoUrl "http://github.com/test/repo" -releases @('all') -directoryAndFilesToKeep @('repo-1.0.0') -directoryForReleases "output"
                 Should -Invoke Expand-Archive -Times 2
                 Should -Not -Invoke Write-Warning
             }

src/Tests/Unit/Public/New-ALZEnvironment.Tests.ps1

@@ -47,23 +47,23 @@ InModuleScope 'ALZ' {
 
                 Mock -CommandName Get-ALZBicepConfig -MockWith {
                     @{
-                        "module_url" = "test"
-                        "version" = "v1.0.0"
+                        "module_url"   = "test"
+                        "version"      = "v1.0.0"
                         "config_files" = @(
                             @{
-                                "source" = "a"
+                                "source"      = "a"
                                 "destination" = "b"
                             }
                         )
-                        "parameters" = @{
+                        "parameters"   = @{
                             "test" = @{
                                 "type" = "string"
                             }
                         }
                     }
-                 }
+                }
 
-                Mock -CommandName Get-GithubRelease -MockWith { }
+                Mock -CommandName Get-ALZGithubRelease -MockWith { }
 
                 Mock -CommandName Test-ALZGitRepository -MockWith { $false }