summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--bumper.md21
1 files changed, 6 insertions, 15 deletions
diff --git a/bumper.md b/bumper.md
index cebc1fb..a77a26f 100644
--- a/bumper.md
+++ b/bumper.md
@@ -2,18 +2,14 @@
Bumper is a small utility for updating the version number when making
a release of a software project. It updates the version number in the
-various locations in which it is stored in the source tree, creates a
-git tag for indicating the release, then updates the source tree again
-with a version number that indicates an unreleased version.
+various locations in which it is stored in the source tree, commits
+those changes, and creates a git tag for indicating the release.
The tool is used like this:
~~~{.numberLines}
$ cd ~/my-project
$ bumper 1.2.0
-Rust project my-project version set to 1.2.0
-Debian package version set to 1.2.0-1
-Release tagged as v1.2.0
$ git push --tags
...
$
@@ -22,8 +18,8 @@ $
In other words: you run Bumper and tell it the version of the release
you're making. Bumper sniffs out what kind of project it is, and sets
the version number in the right places. It then creates a git tag for
-that release. It's up to you to push the changes and tag, or to build
-the release: Bumper only makes local changes.
+that release. It's up to you to push the changes and tag to a git
+server, and to build the release: Bumper only makes local changes.
# Overview
@@ -38,17 +34,12 @@ tree, to keep things simple.
supported, since the author uses nothing else. (If you would like
support for other systems, please help.)
-* Python projects store the version number in a file `version.py` in a
- subdirectory. The project build system uses that file as the source
- of the version number.
-
* Rust projects store the version number in the `Cargo.toml` file. The
build system gets it from there.
* Debian packages have a `debian/changelog`, which specifies the
- package's version number.
-
-* Release notes are in a markdown file called `NEWS`.
+ 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`.
* Releases are marked with signed, annotated git tags named after the
release version with a `v` prefix.