Skip to content

Commit c30eaa0

Browse files
added update instructions and changelog (#69)
Co-authored-by: Jack Tracey <[email protected]>
1 parent 10e95d3 commit c30eaa0

File tree

2 files changed

+40
-6
lines changed

2 files changed

+40
-6
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,22 @@ You can install this module using PowerShellGet.
3030
Install-Module -Name ALZ
3131
```
3232

33+
### Update
34+
35+
Whenever a new release from the module has been released, you can update it easily. The changelog can be found [here](/docs/CHANGELOG.md).
36+
37+
```powershell
38+
# find out which version you have installed
39+
PS C:\Users\you> Get-InstalledModule -Name ALZ
40+
41+
Version Name Repository Description
42+
------- ---- ---------- -----------
43+
0.2.6 ALZ PSGallery Azure Landing Zones Powershell Module
44+
45+
# update to the latest version
46+
Update-Module -Name ALZ
47+
```
48+
3349
### Quick start
3450

3551
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:

docs/CHANGELOG.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,31 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.2.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [0.2.3]
99

10-
- TBD
10+
- fix min prefix length from 3 to 2
1111

12-
## [0.1.0]
12+
## [0.2.2]
1313

14-
### Added
14+
- Add fix for resource group name reference for LAW id
15+
- Change supported ALZ version to v0.14.0
1516

16-
- Initial release.
17-
17+
## [0.2.1]
18+
19+
- Fixed the issue by adding in two new computed values to correlate to
20+
each parameter
21+
- Changed alz bicep config for the soon to be new release
22+
23+
## [0.2.0]
24+
25+
- Need to adjust the policy assignment param file as switched to the ALZ
26+
defaults.
27+
- Need to switch to orchestration version of management diagnostic
28+
setting module param file.
29+
- Switching custom modules directory to match naming convention of
30+
custom parameters directory.
31+
32+
## [0.1.4]
33+
34+
- Adding Computed values to Environment
35+
- Adding file targeted config to ALZ-BICEP-CONFIG

0 commit comments

Comments
 (0)