From ecdbc0b100cc50adffb1262ab485837d5dd2f709 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Tue, 13 Apr 2021 10:46:37 +0300 Subject: feat: support Python projects --- bumper.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) (limited to 'bumper.md') diff --git a/bumper.md b/bumper.md index dafd216..67979ab 100644 --- a/bumper.md +++ b/bumper.md @@ -41,6 +41,10 @@ tree, to keep things simple. package's version number. Bumper assumes the file is otherwise up to date for the release, and sets the version to `X.Y.Z-1`. +* Python projects have a `setup.py` file at the root of the source + tree, and at least one `version.py` in a sub-directory where the + version number is stored in the `__version__` variable. + * Releases are marked with signed, annotated git tags named after the release version with a `v` prefix. @@ -74,11 +78,10 @@ Some random text file Bumper knows nothing about. ~~~ -## Creates a release tag +## Sets version for Rust project -This scenario verifies that Bumper creates a git tag to mark a -release. For this to work, Bumper needs to recognize the type of -project. We use a Rust project for simplicity. +This scenario verifies that Bumper creates a git tag to mark a release +for a Rust project. ~~~scenario given an installed Bumper @@ -124,6 +127,25 @@ dummy (0.1.0-1) unstable; urgency=low -- Lars Wirzenius Tue, 30 Mar 2021 08:33:35 +0300 ~~~ +## Sets version for Python project + +This scenario verifies that Bumper creates a git tag to mark a +release for a Python project. + +~~~scenario +given an installed Bumper +given file foo/setup.py from empty +given file foo/lib/version.py from empty +given all files in foo are committed to git +when I run, in foo, bumper 105.12765.42 +then all changes in foo are committed +then in foo, git tag v105.12765.42 is a signed tag +then file foo/lib/version.py matches regex /__version__\s*=\s*"105\.12765\.42"/ +~~~ + +~~~{#empty .file} +~~~ + --- -- cgit v1.2.1