Skip to content

Commit

Permalink
Improve markdown formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
seancolsen committed Mar 18, 2024
1 parent 34330ba commit 1612d00
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions docs/release/qa.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<version_number>
Expand All @@ -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
Expand All @@ -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"
Expand Down

0 comments on commit 1612d00

Please sign in to comment.