added update instructions and changelog (#69)

Co-authored-by: Jack Tracey <[email protected]>
Azure · Aug 17, 2023 · c30eaa0 · c30eaa0
1 parent 10e95d3
commit c30eaa0
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,22 @@ You can install this module using PowerShellGet.
 Install-Module -Name ALZ
 ```
 
+### Update
+
+Whenever a new release from the module has been released, you can update it easily. The changelog can be found [here](/docs/CHANGELOG.md).
+
+```powershell
+# find out which version you have installed
+PS C:\Users\you> Get-InstalledModule -Name ALZ
+
+Version    Name                                Repository           Description
+-------    ----                                ----------           -----------
+0.2.6      ALZ                                 PSGallery            Azure Landing Zones Powershell Module
+
+# update to the latest version
+Update-Module -Name ALZ
+```
+
 ### Quick start
 
 Before you start you can utilize the functionality of the module to verify if you have all the prerequisites installed with the built in command:

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -5,13 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.2.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.2.3]
 
-- TBD
+- fix min prefix length from 3 to 2
 
-## [0.1.0]
+## [0.2.2]
 
-### Added
+- Add fix for resource group name reference for LAW id
+- Change supported ALZ version to v0.14.0
 
-- Initial release.
-
+## [0.2.1]
+
+- Fixed the issue by adding in two new computed values to correlate to
+each parameter
+- Changed alz bicep config for the soon to be new release
+
+## [0.2.0]
+
+- Need to adjust the policy assignment param file as switched to the ALZ
+defaults.
+- Need to switch to orchestration version of management diagnostic
+setting module param file.
+- Switching custom modules directory to match naming convention of
+custom parameters directory.
+
+## [0.1.4]
+
+- Adding Computed values to Environment
+- Adding file targeted config to ALZ-BICEP-CONFIG