From e3431c7ac23fe48dab202582cdff22c5f7d88f7d Mon Sep 17 00:00:00 2001 From: Alex Pyrgiotis Date: Mon, 12 Dec 2022 21:29:51 +0200 Subject: [PATCH] dev_scripts: Add documentation for the QA script Add a short explanation of what is the purpose of the QA script, and what it uses underneath. Refs #287 --- dev_scripts/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/dev_scripts/README.md b/dev_scripts/README.md index f6ee87c..371a157 100644 --- a/dev_scripts/README.md +++ b/dev_scripts/README.md @@ -136,3 +136,18 @@ for running Dangerzone commands, and not doing actual development in them The only point where we allow mutability is the directory where Podman stores the images and stopped containers, which may be useful for developers. If this proves to be an issue, we will reconsider. + +## Run QA (`qa.py`) + +This script runs the QA steps for a supported platform, in order to make sure +that the dev does not skip something. These steps are taken from our [release +instructions](../RELEASE.md#qa). + +The idea behind this script is that it will present each step to the user and +ask them to perform it manually and specify it passes, in order to continue to +the next one. For specific steps, it allows the user to run them automatically. +In steps that require a Dangerzone dev environment, this script uses the +`env.py` script to create one. + +Including all the supported platforms in this script is still a work in +progress.