From 1f742d7165536dda9d473035a7c2981c86e83ab0 Mon Sep 17 00:00:00 2001
From: Leonard Jonathan Oh <leonardjonathanoh@live.com>
Date: Wed, 20 Sep 2023 10:13:44 +0000
Subject: [PATCH] Docs (readme): Update Variant versions section

---
 README.md                        | 19 +++++++++++++++++++
 generate/templates/README.md.ps1 | 19 +++++++++++++++++++
 2 files changed, 38 insertions(+)

diff --git a/README.md b/README.md
index c0304ed..ec257a4 100644
--- a/README.md
+++ b/README.md
@@ -42,3 +42,22 @@ Install-Module -Name Generate-DockerImageVariants -Repository PSGallery -Scope C
 # Generate the variants
 Generate-DockerImageVariants .
 ```
+
+### Variant versions
+
+[versions.json](generate/definitions/versions.json) contains a list of [Semver](https://semver.org/) versions, one per line.
+
+To update versions in `versions.json`:
+
+```powershell
+./Update-Versions.ps1
+```
+
+To update versions in `versions.json`, and open a PR for each changed version, and merge successful PRs one after another (to prevent merge conflicts), and finally create a tagged release and close milestone:
+
+```powershell
+$env:GITHUB_TOKEN = 'xxx'
+./Update-Versions.ps1 -PR -AutoMergeQueue -AutoRelease
+```
+
+To perform a dry run, use `-WhatIf`.
diff --git a/generate/templates/README.md.ps1 b/generate/templates/README.md.ps1
index 785598f..f9fb809 100644
--- a/generate/templates/README.md.ps1
+++ b/generate/templates/README.md.ps1
@@ -44,4 +44,23 @@ Install-Module -Name Generate-DockerImageVariants -Repository PSGallery -Scope C
 Generate-DockerImageVariants .
 ```
 
+### Variant versions
+
+[versions.json](generate/definitions/versions.json) contains a list of [Semver](https://semver.org/) versions, one per line.
+
+To update versions in `versions.json`:
+
+```powershell
+./Update-Versions.ps1
+```
+
+To update versions in `versions.json`, and open a PR for each changed version, and merge successful PRs one after another (to prevent merge conflicts), and finally create a tagged release and close milestone:
+
+```powershell
+$env:GITHUB_TOKEN = 'xxx'
+./Update-Versions.ps1 -PR -AutoMergeQueue -AutoRelease
+```
+
+To perform a dry run, use `-WhatIf`.
+
 '@