From 1612d00ecbc291baf86e05639ff2b584c5416e1a Mon Sep 17 00:00:00 2001 From: Sean Colsen Date: Mon, 18 Mar 2024 09:07:41 -0400 Subject: [PATCH] Improve markdown formatting --- docs/release/qa.md | 41 +++++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 14 deletions(-) diff --git a/docs/release/qa.md b/docs/release/qa.md index ddab4b748..b86da9898 100644 --- a/docs/release/qa.md +++ b/docs/release/qa.md @@ -7,31 +7,41 @@ This page describes manual QA testing routines that we perform before a release. ### Pre-requisites for testing Installation & Upgrades #### For setups from scratch -* Create and push a tag on GitHub with a draft release version. + +- Create and push a tag on GitHub with a draft release version. + ```sh git checkout $VERSION git pull git tag "draft-$VERSION" git push origin "draft-$VERSION" ``` - * GH will automatically create a draft release containing the static assets for this tag. This will take a few minutes. -* Use the following command to download the static_files.zip asset from the draft release for the "Download release static files and extract into the correct directory" step during installation. + + - GH will automatically create a draft release containing the static assets for this tag. This will take a few minutes. + +- Use the following command to download the static_files.zip asset from the draft release for the "Download release static files and extract into the correct directory" step during installation. + ```sh gh release download --repo mathesar-foundation/mathesar "draft-$VERSION" -p 'static_files.zip' ``` - * You could also download this file via the GH web UI. - * Since draft releases aren't final, the urls generated by GH for the assets are dynamic. The static urls are formed when the release is published. + + - You could also download this file via the GH web UI. + - Since draft releases aren't final, the urls generated by GH for the assets are dynamic. The static urls are formed when the release is published. #### For docker related setups -**For installations** -* Clear out remains of any previous installations. -**For upgrades** -* Clear out remains of any previous installations. -* Install the current published version of Mathesar. +For installations: + +- Clear out remains of any previous installations. -**For both** -* Locally download and tag the new version images as `latest`: +For upgrades: + +- Clear out remains of any previous installations. +- Install the current published version of Mathesar. + +For both: + +- Locally download and tag the new version images as `latest`: ```sh docker image pull mathesar/mathesar-caddy: @@ -42,6 +52,7 @@ This page describes manual QA testing routines that we perform before a release. ``` ### Tasks + - [ ] Test installing the release from scratch by following our documentation - [ ] Test all different installation methods - [ ] Docker compose @@ -66,8 +77,10 @@ This page describes manual QA testing routines that we perform before a release. ### Cleanup -* Destroy any infra setup on GCP that was created for QA purposes. -* Delete the draft release and tag that were created when testing "Setups from scratch". + +- Destroy any infra setup on GCP that was created for QA purposes. +- Delete the draft release and tag that were created when testing "Setups from scratch". + ```sh gh release delete "draft-$VERSION" -y git tag -d "draft-$VERSION"