From 5bb1f42bb3114daa09047185bf2f919923b73261 Mon Sep 17 00:00:00 2001 From: Rafael Bradley Date: Sun, 13 Jul 2025 21:52:27 +0000 Subject: [PATCH] Add documentation to release.py --- release.py | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/release.py b/release.py index 96bea03..2836b78 100644 --- a/release.py +++ b/release.py @@ -1,17 +1,29 @@ +""" +A release script to build and tag docker files, commit changes, and create release tags. + +It requires `toml` to be installed (in Ubuntu via `sudo apt install python3 python3-toml` and then +`python3 release.py`). + +Bump the version manually in Cargo.toml before running this script. You'll be asked for +confirmation before running all the steps, so you're safe if you forget. +""" + import os import toml + def get_release_version(): """ Reads the version from the Cargo.toml file. """ - cargo_toml_path = os.path.join(os.path.dirname(__file__), 'Cargo.toml') - - with open(cargo_toml_path, 'r', encoding="UTF-8") as f: + cargo_toml_path = os.path.join(os.path.dirname(__file__), "Cargo.toml") + + with open(cargo_toml_path, "r", encoding="UTF-8") as f: cargo_toml = toml.load(f) - - return cargo_toml['package']['version'] + + return cargo_toml["package"]["version"] + version = get_release_version()