Skip to content
A tool to help you automate semantic versioning in your project
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
Versionfile
autoversion.gemspec

README.md

Status

Build Status

Autoversion

Autoversion is a command line tool that can automate semantic versioning during development. It integrates nicely with git to give you automatic & atomic commits of version increments. Don't trust humans (not even yourself) to commit and tag proper versions, let autoversion do it for you.

Autoversion is great for library development where proper version management is important. Also, Autoversion uses Autoversion for versioning ;)

Installation

gem install autoversion

Usage

Read current version

$ autoversion

Increment versions

$ autoversion major
$ autoversion minor
$ autoversion patch

The Versionfile

The project you want to version needs to have a file called 'Versionfile'. Autoversion will evaluate this file as a ruby script. Autoversion provides a small DSL to allow you to read and write versions to your files. Below is an example of the DSL usage:

# This block should return a valid Semantic object. 
# Example: Read a file and parse a verson from it.
read_version do
  # Should return a string representation of a semantic version
end

# This block takes the current and next version (strings). 
# Example: Rewriting a version file.
write_version do |currentVersion, nextVersion|
  # Write the new version to a file
end

after :version do
  # Run some command after any versioning action
  # Example: Run a package script, trigger CI, etc.
end

after :patch do
  # Run some command after patch
end

after :minor do
  # Run some command after minor
end

after :major do
  # Run some command after release
end

Versionfile Examples

A ruby gem

automate_git

read_version do
  contents = File.read File.join(Dir.pwd, "lib/autoversion/version.rb")
  instance_eval(contents)
  Autoversion::VERSION
end

write_version do |currentVersion, nextVersion|
  contents = File.read File.join(Dir.pwd, "lib/autoversion/version.rb")
  contents = contents.sub(currentVersion.to_s, nextVersion.to_s)

  File.open(File.join(Dir.pwd, "lib/autoversion/version.rb"), 'w') do |file| 
    file.write contents
  end
end

A Chrome Extension

require 'json'
require 'crxmake'

automate_git :actions => [:commit]

read_version do
  doc = JSON.load File.read('./app/source/manifest.json')
  doc['version']
end

write_version do |currentVersion, nextVersion|
  doc = JSON.load File.read './app/source/manifest.json'
  doc['version'] = nextVersion.to_s
  File.open('./app/source/manifest.json', 'w') {|f| f.write JSON.pretty_generate(doc) }
end

after :version do |currentVersion|
  CrxMake.make(
    :ex_dir => "./app/build",
    :pkey   => "./app/build.pem",
    :crx_output => "./app/releases/#{currentVersion.to_s}.crx",
    :verbose => true,
    :ignorefile => /\.swp/,
    :ignoredir => /\.(?:svn|git|cvs)/
  )
end

A bower module

require 'json'

# Automatically create an atomic commit of the version file update
# and create a new tag.
automate_git :actions => [:commit, :tag]

file = './bower.json'

read_version do
  doc = JSON.load File.read file
  doc['version']
end

write_version do |currentVersion, nextVersion|
  doc = JSON.load File.read file
  doc['version'] = nextVersion.to_s
  File.open(file, 'w') {|f| f.write JSON.pretty_generate(doc) }
end

Advanced usage: Update several files using a pattern matcher

You can also read & update versions using a pattern matcher. The following Versionfile is from a ruby gem that has several plugins (also packaged as gems) contained in the same git repo. The VERSION_PATTERN is used for both reading and writing the version. Note that the write_version method updates several files using a glob pattern.

# The matched files look like this:

# module YourProject
#  VERSION = "0.0.2"
# end

VERSION_PATTERN = /^\s*VERSION = \"(.+)\"$/

matcher = proc do |line|
  if m = VERSION_PATTERN.match(line)
    m[1]
  else
    nil
  end
end

read_version do
  parse_file "lib/your-project/version.rb", matcher
end

write_version do |oldVersion, newVersion|
  update_files Dir.glob("**/version.rb"), matcher, oldVersion, newVersion
end
Something went wrong with that request. Please try again.