almet/dangerzone
1
0
Fork 0
mirror of https://github.com/freedomofpress/dangerzone.git synced 2025-05-06 13:31:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
dangerzone/docs/developer/doit.md
Alex Pyrgiotis 2f29095b31
docs: Update release instructions 
Update our release instructions with a way to run manual tasks via
`doit`. Also, add developer documentation on how to use `doit`, and some
tips and tricks.
2024-12-04 14:23:04 +02:00

2.2 KiB
Raw Blame History

Using the Doit Automation Tool

Developers can use the Doit automation tool to create release artifacts. The purpose of the tool is to automate our manual release instructions in RELEASE.md file. Not everything is automated yet, since we're still experimenting with this tool. You can find our task definitions in this repo's dodo.py file.

Why Doit?

We picked Doit out of the various tools out there for the following reasons:

  • Pythonic: The configuration file and tasks can be written in Python. Where applicable, it's easy to issue shell commands as well.
  • File targets: Doit borrows the file target concept from Makefiles. Tasks can have file dependencies, and targets they build. This makes it easy to define a dependency graph (DAG) for tasks.
  • Hash-based caching: Unlike Makefiles, doit does not look at the modification timestamp of source/target files, to figure out if it needs to run them. Instead, it hashes those files, and will run a task only if the hash of a file dependency has changed.
  • Parallelization: Tasks can be run in parallel with the -n argument, which is similar to make's -j argument.

How to Doit?

First, enter your Poetry shell. Then, make sure that your environment is clean, and you have ample disk space. You can run:

doit clean --dry-run  # if you want to see what would happen
doit clean  # you'll be asked to cofirm that you want to clean everything

Finally, you can build all the release artifacts with doit, or a specific task with:

doit <task>

Tips and tricks

  • You can run doit list --all -s to see the full list of tasks, their dependencies, and whether they are up to date.

  • You can run doit info <task> to see which dependencies are missing.

  • You can change this line in pyproject.toml to true, to allow using the Docker/Podman build cache:

    use_cache = true

  • You can pass the following global parameters with doit <param>=<value>:

    • runtime: The container runtime to use. Either podman or docker
    • release_dir: Where to store the release artifacts. Default path is ~/release-assets/<version>
    • apple_id: The Apple ID to use when signing/notarizing the macOS DMG.