almet/dangerzone
1
0
Fork 0
mirror of https://github.com/freedomofpress/dangerzone.git synced 2025-04-28 18:02:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

dev_scripts: Add documentation for the QA script

Browse source 
Add a short explanation of what is the purpose of the QA script, and
what it uses underneath.

Refs #287
This commit is contained in:
Alex Pyrgiotis 2022-12-12 21:29:51 +02:00
parent 14a7ca1ae5
commit e3431c7ac2
No known key found for this signature in database
GPG key ID: B6C15EBA0357C9AA
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
dev_scripts/README.md
View file

@ -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 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 the images and stopped containers, which may be useful for developers. If this
proves to be an issue, we will reconsider. 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.