https://github.com/alphahydrae/rake-version
Rake tasks for version management.
https://github.com/alphahydrae/rake-version
Last synced: 8 months ago
JSON representation
Rake tasks for version management.
- Host: GitHub
- URL: https://github.com/alphahydrae/rake-version
- Owner: AlphaHydrae
- License: mit
- Created: 2012-02-21T10:19:01.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2023-06-18T00:59:22.000Z (over 2 years ago)
- Last Synced: 2024-11-17T14:09:11.338Z (about 1 year ago)
- Language: Ruby
- Homepage:
- Size: 53.7 KB
- Stars: 7
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# rake-version
**Simple rake tasks for version management.**
[](http://badge.fury.io/rb/rake-version)
[](https://gemnasium.com/AlphaHydrae/rake-version)
[](http://travis-ci.org/AlphaHydrae/rake-version)
[](https://coveralls.io/r/AlphaHydrae/rake-version?branch=master)
**rake-version** helps you manage your `VERSION` file according to the rules of [semantic versioning](http://semver.org).
It does nothing more.
It does not create tags; it does not commit; it does not push; it does not release.
## Installation
Add to your Gemfile and `bundle install`:
```rb
gem "rake-version", "~> 1.0"
```
Add the tasks to your Rakefile:
```rb
require 'rake-version'
RakeVersion::Tasks.new
```
## Usage
```bash
# show current version
rake version #=> 1.0.0
# bump version
rake version:bump:patch #=> 1.0.1
rake version:bump:minor #=> 1.1.0
rake version:bump:major #=> 2.0.0
# set version
rake "version:set[1.2.3]" #=> 1.2.3
```
### Auto-update other files
When you add the rake version tasks in your Rakefile, you may specify additional files to update with the new version.
```rb
require 'rake-version'
RakeVersion::Tasks.new do |v|
v.copy 'lib/my-gem.rb' # update single file
v.copy 'lib/a.rb', 'lib/b.rb' # update multiple files
v.copy 'lib/*.rb' # update all files matching a glob pattern
v.copy /lib/ # update all files whose path matches a regexp
end
```
By default, **rake-version** will replace the first occurrence of a semantic version pattern (`number.number.number(-prerelease)(+build)`) with the new version.
It will not modify the prerelease version or build metadata.
For example, when bumping the minor version from 1.0.0, it will change the contents of this file:
```rb
class Thing
VERSION = '1.0.0'
end
```
To this:
```rb
class Thing
VERSION = '1.1.0'
end
```
You can customize this behavior as follows:
```rb
RakeVersion::Tasks.new do |v|
v.copy 'lib/my-gem.rb', all: true # replace all occurrences
end
```
### Semantic versioning
**rake-version** partially supports [semantic versioning v2.0.0](http://semver.org/spec/v2.0.0.html).
You can add prerelease (e.g. `-beta`) and build (e.g. `+20131313`) information to your versions,
but there are currently no tasks to update them other than `version:set`.
## Meta
* **Author:** Simon Oulevay (Alpha Hydrae)
* **License:** MIT (see [LICENSE.txt](https://raw.github.com/AlphaHydrae/rake-version/master/LICENSE.txt))