Git Product home page Git Product logo

rake_roll's Introduction

RakeRoll

RakeRoll: Roll out your release versions with ease, RakeRoll will version and tag a release then create an updated changelog of the git commits, picking only those starting with a *

Installation

Add this line to your application's Gemfile:

gem 'rake_roll'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rake_roll

Usage

rake roll

rake roll                        # shows version and all options
rake roll:pre                    # Bump to 0.1.0a
rake roll:revision               # Bump to 0.1.1
rake roll:major                  # Bump to 1.0.0
rake roll:minor                  # Bump to 0.2.0
rake roll:bump                   # pass VERSION=*.*.* to create manual version number
rake roll:next                   # run and update changelog without creating a tag

The above will do a dry run, and show the changelog updates in the terminal window

ROLLING OUT FOR REAL

To Roll out the command for real, (update the version, changelog and
push everything up on the current branch of the git repo) use:

rake roll:bump PUSH=true

CHANGELOG

Only commits starting with *, 'Tech' or matching regex /^@[0-9a-zA-Z\-_]{3,27} #[0-9]{4,6} .{5,}/ will be added to the changelog, example:

* BugFix: #1234 IE6 Positioning fix
* Feature: #1111 Adding rake_roll to the Gemfile
* HotFix: Don't Delete current users

or

@assembla-space #1234 Assembla style ticket heading
@assembla-space #2345 Put what you want here
@assembla-space #4567 Some title
space-4567: Some Message

FILES

rake roll will create a VERSION and CHANGELOG file on the root of
your project if they do not already exist.

TODO

Write tests
Write RDocs
Code Tidy

Contributing

  1. Fork it ( http://github.com//rake_roll/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

rake_roll's People

Contributors

thelazycamel avatar jfuentesdelgado avatar filiperocha avatar

Stargazers

 avatar Denys Pankratov avatar  avatar  avatar Anthony Laibe avatar J. Rodríguez avatar

Watchers

 avatar  avatar James Cloos avatar J. Rodríguez avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.