Github release doc (#2495)

devops/scripts/list_versions.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+set -o errexit
+set -o pipefail
+set -o nounset
+# set -o xtrace
+
+function template_version () {
+  version=$(yq eval ".version" "$1")
+  name=$(yq eval ".name" "$1")
+  echo -e "| $name | $version |"
+}
+
+function component_version () {
+  version_line=$(cat "$2")
+
+  # doesn't work with quotes
+  # shellcheck disable=SC2206
+  version_array=( ${version_line//=/ } ) # split by =
+  version="${version_array[1]//\"}" # second element is what we want, remove " chars
+  echo -e "| $1 | $version |"
+}
+
+echo -e "| name | version |\n| ----- | ----- |"
+
+component_version "devops" "devops/version.txt"
+component_version "core" "templates/core/version.txt"
+
+find . -type f -name "porter.yaml" -not -path "*/.cnab/*" -print0 | sort | while read -r -d $'\0' file
+do
+  template_version "$file"
+done
+
+
+

docs/tre-developers/release.md

@@ -0,0 +1,20 @@
+# How to release an AzureTRE version
+
+A release is created when enough changes have been made and the main branch is stable enough.
+
+The process follows these steps:
+
+1. Update `CHANGELOG.md` in a PR with the following:
+    1. Rename the top-most verion noted as unreleaed with the version number that makes sense. Note that you don't have to keep the one that is currently in the file as the version number chosen should reflect the changes made (major, minor, etc.)
+    1. Create a new section for the next-unreleaed version so that future changes will be placed there.
+    1. Run `devops/scripts/list_versions.sh` and include the output in the change log for the version you're about the release
+1. Merge the PR
+1. Create a GitHub Release
+    <!-- markdownlint-disable-next-line MD034 -->
+    1. Go to https://github.com/microsoft/AzureTRE/releases/new
+    1. Click on `Choose a tag` and type a new one for you version. It should be in the form of `v0.9.2` - note the "v" in the begining.
+    1. The release title should be just the version number "0.9.2" in the example above.
+    1. Copy the text from the CHANGELOG.md file and paste in the release description.
+    1. Include a final line with a link to the full changelog similar to this:
+    <!-- markdownlint-disable-next-line MD034 -->
+          **Full Changelog**: https://github.com/microsoft/AzureTRE/compare/v0.9.1...v0.9.2

mkdocs.yml

@@ -128,6 +128,8 @@ nav:
                   - GitHub Actions: tre-admins/setup-instructions/workflows.md
                   - Azure DevOps: coming-soon.md
 
+          - Releases: tre-developers/release.md
+
       - Troubleshooting FAQ: # General Troubleshooting Section for Development
           - troubleshooting-faq/index.md
           - Enabling Debugging for the API: troubleshooting-faq/debug-api.md