github.com/inflatablewoman/deis@v1.0.1-0.20141111034523-a4511c46a6ce/contrib/bumpver/README.md (about)

     1  # bumpver
     2  
     3  `bumpver` is a go command-line tool that changes [semantic version](http://semver.org/)
     4  strings in source and doc files. It was created to help with [Deis](http://deis.io/)
     5  releases.
     6  
     7  ## Build
     8  
     9  ```console
    10  $ make test build
    11  $ ./bumpver --help
    12  Updates the current semantic version number to a new one in the specified
    13  source and doc files.
    14  
    15  Usage:
    16    bumpver [-f <current>] <version> <files>...
    17  
    18  Options:
    19    -f --from=<current>  An explicit version string to replace. Otherwise, use
    20                         the first semantic version found in the first file.
    21  ```
    22  
    23  ## Usage
    24  
    25  Let's use `bumpver` to update the deis codebase for a new release, 0.13.3:
    26  
    27  ```console
    28  $ make -C contrib/bumpver/ test build
    29  $ # update from an explicit (bad) version string
    30  $ ./contrib/bumpver/bumpver -f latest 0.13.3 contrib/coreos/user-data
    31  $ ./contrib/bumpver/bumpver -f 0.13.0-dev 0.13.3 \
    32      version/version.go \
    33      client/deis.py \
    34      client/setup.py \
    35      deisctl/deis-version \
    36      deisctl/deisctl.go \
    37      deisctl/README.md \
    38      controller/deis/__init__.py \
    39      README.md
    40  $ # update from the first semver string found
    41  $ # this type of command should now be enough to bump everything
    42  $ ./contrib/bumpver/bumpver 0.14.0 \
    43      version/version.go \
    44      client/deis.py \
    45      client/setup.py \
    46      deisctl/deis-version \
    47      deisctl/deisctl.go \
    48      deisctl/README.md \
    49      contrib/coreos/user-data.example \
    50      controller/deis/__init__.py \
    51      README.md
    52  ```
    53  
    54  Of course, you should **always** check the changes with `git diff` before committing
    55  anything to version control.
    56  
    57  Please add any issues you find with this software to the
    58  [Deis project](https://github.com/deis/deis/issues).