summaryrefslogtreecommitdiff
path: root/bumper.yarn
diff options
context:
space:
mode:
Diffstat (limited to 'bumper.yarn')
-rw-r--r--bumper.yarn11
1 files changed, 6 insertions, 5 deletions
diff --git a/bumper.yarn b/bumper.yarn
index a3d0400..d204a96 100644
--- a/bumper.yarn
+++ b/bumper.yarn
@@ -25,13 +25,14 @@ simpler. Here's a list:
* The project is in Python. Again, this is just because that's what
the author uses.
-* The code gets its version numbers from two variables in a Python
- module that contains nothing else. The variables are `__version__`
- and `__version_info__`. Bumper will overwrite the file with new
- values when it runs, and commit its version to git.
+* The project contains exactly one file called `version.py`, and that
+ file only sets the variables `__version__` and `__version_info__`.
+ Bumper will overwrite that file so it sets the desired values, and
+ commits those changes to git.
* `setup.py` is assumed to get the version from `__version__` from the
- file Bumper writes, in some suitable way.
+ file Bumper writes, in some suitable way. Likewise the rest of the
+ project.
* It's OK for Bumper to make several commits and a tag in the git
repository.