Creating Release documentation

docs/index.md

@@ -74,6 +74,7 @@ source/06_developers_contrib_guide/01_architecture.md
 source/06_developers_contrib_guide/02_adv_docs.md
 source/06_developers_contrib_guide/04_tests.md
 source/06_developers_contrib_guide/05_changelog.md
+source/06_developers_contrib_guide/06_release.md
 ```
 
 ```{toctree}

docs/source/06_developers_contrib_guide/06_release.md

@@ -0,0 +1,41 @@
+# Release Process for QHub
+
+In order to create a release:
+
+1. Make sure the `RELEASE.md` is up to date with change, bug fixes,
+   and breaking changes and move all the `Upcoming Release` into a new
+   section titled `Release <version> - <month>/<day>/<year>`
+
+2. Update file `qhub/VERSION` to be `<version>`
+
+3. Update `README.md` to reflect version of QHub cli
+
+```
+positional arguments:
+  {deploy,destroy,render,init,validate}
+...
+                        QHub - <version>
+...  
+```
+
+4. Update the github actions and gitlab ci to use upcoming QHub
+   version in `qhub/template/{{ cookiecutter.repo_directory }}/.gitlab-ci.yml` and `qhub/template/{{ cookiecutter.repo_directory }}/.github/workflows/qhub-ops.yaml`
+
+5. Commit these changes to `main` branch
+
+6. Create a Release branch in [Quansight/qhub-terraform-modules](https://github.com/quansight/qhub-terraform-modules) with name `release-<version>` off of the `main` branch.
+
+7. Create a Release branch in [Quansight/qhub](https://github.com/Quansight/qhub) with name `release-<version>` off of the `main` branch.
+
+8. Inside of the `release-<version>` branch of [Quansight/qhub](https://github.com/Quansight/qhub) update `qhub/template/cookiecutter.json` to use the `release-<version>` branch from qhub-terraform-modules.
+
+```json
+...
+    "terraform_modules": {
+        "repository": "github.com/quansight/qhub-terraform-modules",
+        "rev": "release-<version>"
+    },
+...
+```
+
+9. Finally [create a Release on QHub](https://github.com/Quansight/qhub/releases/new). The tag should be `v<version>` off of branch `release-<version>`. Use the `RELEASE.md` to get the title `Release <version> - <month>/<day>/<year>` and set the text description to the `RELEASE.md` for the given version. Click `Publish Release` if this worked a new version will be [uploaded to pypi for QHub](https://pypi.org/project/qhub/)