Add instructions for how new versions are published and how to update the version number

Author: deadlydog

ReadMe.md

@@ -110,7 +110,6 @@ Things to still do:
 
 - Allow using a custom PowerShell Gallery feed URL.
 - Create new deployment on tag creation maybe.
-- Add instructions for how to assign version number in the contributing docs depending on if they are using actions or pipelines
 - Prompt user for module name, org name, pipelines or actions, PowerShell gallery or custom feed with an option to leave it blank to fill it in later.
 - Make azure DevOps and GitHub steps in the ReadMe collapsible.
   Have screenshots and link to recording of the setup in both, since they involve clicking around in the UI.

docs/Contributing.md

@@ -2,6 +2,27 @@
 
 Feel free to open an issue or pull request.
 
+## 🚀 Publishing new versions
+
+This project acts as a template repository in GitHub, meaning that as soon as a change is pushed to the `main` branch, it will be used when new GitHub repositories are created from this template.
+
+This project also creates a PowerShell module that can be used to create new repositories.
+A prerelease version of the module is published to the PowerShell Gallery automatically on every commit to the `main` branch.
+The [GitHub Actions `deploy` workflow run](https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate/actions/workflows/build-test-and-deploy-powershell-module.yml) must be manually approved to publish a stable version.
+
+### Incrementing the version number
+
+The version number is of the format Major.Minor.Patch and follows [semantic versioning](https://semver.org).
+By default, every commit to the `main` branch will increment the Patch version number.
+
+If you want to increment the Major or Minor version number, you have 2 options:
+
+1. Manually start a [`deploy` workflow](https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate/actions/workflows/build-test-and-deploy-powershell-module.yml) run and specify the version number to use.
+   e.g. Specifying `2.4.0` will produce a new version of `2.4.0`.
+1. Create a new version tag and pushing it up to GitHub.
+   Builds are not triggered on tags, and thus the version tag will be used as the starting point for the next version.
+   e.g. Creating a new tag of `v2.4.0` will produce a new version of `2.4.1` on the next commit to the `main` branch.
+
 ## ⁉ Why was a specific decision made
 
 Curious about some of the choices made in this project?

src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/docs/Contributing.md

@@ -1,3 +1,21 @@
 # Contributing to this project
 
 Feel free to open an issue or pull request.
+
+## 🚀 Publishing new versions
+
+A prerelease version of the module is published automatically on every commit to the `main` branch.
+The [GitHub Actions `deploy` workflow](/.github/workflows/build-test-and-deploy-powershell-module.yml) run must be manually approved to publish a stable version.
+
+### Incrementing the version number
+
+The version number is of the format Major.Minor.Patch and follows [semantic versioning](https://semver.org).
+By default, every commit to the `main` branch will increment the Patch version number.
+
+If you want to increment the Major or Minor version number, you have 2 options:
+
+1. Manually start a [`deploy` workflow](/.github/workflows/build-test-and-deploy-powershell-module.yml) run and specify the version number to use.
+   e.g. Specifying `2.4.0` will produce a new version of `2.4.0`.
+1. Create a new version tag and pushing it up to GitHub.
+   Builds are not triggered on tags, and thus the version tag will be used as the starting point for the next version.
+   e.g. Creating a new tag of `v2.4.0` will produce a new version of `2.4.1` on the next commit to the `main` branch.