From feb78bb0a41d170c04dfaca7a57d4b23c1d0c874 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A5le=20Johnsen?= <98233333+stalejohnsen@users.noreply.github.com> Date: Fri, 22 Dec 2023 10:08:44 +0100 Subject: [PATCH 1/3] Upgrade guidance added --- docs/wiki/Accelerator.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/wiki/Accelerator.md b/docs/wiki/Accelerator.md index 26ba424f2..f3b5782b7 100644 --- a/docs/wiki/Accelerator.md +++ b/docs/wiki/Accelerator.md @@ -228,9 +228,16 @@ With the ALZ Accelerator framework, we have designed the pipelines and directory ```powershell Get-ALZGithubRelease -i "bicep" -v "v0.17.0" -o "C:\Repos\ALZ\accelerator" ``` - + Verify that the cmdlet has updated the environment variables file (.env): + ``` + UPSTREAM_RELEASE_VERSION="v0.17.0" + ``` 1. You can now deploy the updated modules. - + > **Note:** + > The current pipelines trigger What-If deployment in PRs for changes in the Bicep parameter files. If you also want to include the What-If deployment process in the module upgrade process, consider the following options: + > - Adding the environment variables file (.env) as an additional trigger in the module pipelines + > - Introducing inputs/parameters in the module pipelines so you can manually trigger What-If deployments in a controlled manner. + ### Incorporating Modified ALZ Modules We recommend that you do not modify the ALZ Bicep modules directly within the upstream-releases directory. Instead, we recommend that you copy the module file (e.g., logging.bicep, hubNetworking.bicep, etc.) that you would like to modify to the config\custom-modules directory. This will allow you to easily upgrade the ALZ Bicep version without having to worry about losing your customizations. From eac68623ce5f004e8dd72f5f22398b63b16e5797 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A5le=20Johnsen?= <98233333+stalejohnsen@users.noreply.github.com> Date: Fri, 22 Dec 2023 10:39:19 +0100 Subject: [PATCH 2/3] Fix trailing whitespace --- docs/wiki/Accelerator.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/wiki/Accelerator.md b/docs/wiki/Accelerator.md index f3b5782b7..a38f07f59 100644 --- a/docs/wiki/Accelerator.md +++ b/docs/wiki/Accelerator.md @@ -236,8 +236,8 @@ With the ALZ Accelerator framework, we have designed the pipelines and directory > **Note:** > The current pipelines trigger What-If deployment in PRs for changes in the Bicep parameter files. If you also want to include the What-If deployment process in the module upgrade process, consider the following options: > - Adding the environment variables file (.env) as an additional trigger in the module pipelines - > - Introducing inputs/parameters in the module pipelines so you can manually trigger What-If deployments in a controlled manner. - + > - Introducing inputs/parameters in the module pipelines so you can manually trigger What-If deployments in a controlled manner. + ### Incorporating Modified ALZ Modules We recommend that you do not modify the ALZ Bicep modules directly within the upstream-releases directory. Instead, we recommend that you copy the module file (e.g., logging.bicep, hubNetworking.bicep, etc.) that you would like to modify to the config\custom-modules directory. This will allow you to easily upgrade the ALZ Bicep version without having to worry about losing your customizations. From 6c1c25de0f88a730a6336bd8f6ce65f926dd854a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A5le=20Johnsen?= <98233333+stalejohnsen@users.noreply.github.com> Date: Fri, 22 Dec 2023 10:47:33 +0100 Subject: [PATCH 3/3] fix code language --- docs/wiki/Accelerator.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/wiki/Accelerator.md b/docs/wiki/Accelerator.md index a38f07f59..c6871a8d9 100644 --- a/docs/wiki/Accelerator.md +++ b/docs/wiki/Accelerator.md @@ -229,7 +229,7 @@ With the ALZ Accelerator framework, we have designed the pipelines and directory Get-ALZGithubRelease -i "bicep" -v "v0.17.0" -o "C:\Repos\ALZ\accelerator" ``` Verify that the cmdlet has updated the environment variables file (.env): - ``` + ```bash UPSTREAM_RELEASE_VERSION="v0.17.0" ``` 1. You can now deploy the updated modules.