Merge pull request #43 from theohbrothers/docs/readme-update-variant-…

…versions-section Docs (readme): Update Variant versions section
theohbrothers · Sep 20, 2023 · 39c7122 · 39c7122
2 parents 6a3b11a + 269a538
commit 39c7122
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -44,3 +44,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
@@ -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`.
+
 '@