Giter Club home page Giter Club logo

release_tagger's Introduction

ReleaseTagger

A simple command-line tool to manage a git tag-based release workflow. It:

  1. Ensures the working directory is clean and up-to-date
  2. Bumps the requested version number (major, minor or patch)
  3. Creates an annotated tag noting changes since the last release
  4. Pushes the tag to the origin repo

The actual version of the software will be retrieved from our package repository in the cloud (packagecloud) That's all. Any other build steps are to be managed manually, or by CI watching for release tags in the origin repo.

Installation

Add this line to your application's Gemfile:

gem 'release_tagger'

And then execute:

$ bundle

Or install it yourself as:

$ gem install release_tagger

Configuration

The only required configuration is the packagecloud API key to retrieve the latest version. You can configure it adding the API key (ask the infra/geoff squad for it) at:

  • /etc/release_tagger/packagecloud_token
  • ~/.release_tagger/packagecloud_token
  • as an environment variable, PACKAGECLOUD_API_TOKEN

Usage

$ do_release (major|minor|patch)

When doing a release from a non-master branch, the tag will contain a token to mark that release as a qa one. Only releases done from the master branch will contain the tag for production

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment. Run bundle exec release_tagger to use the gem in this directory, ignoring other installed copies of this gem.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, use the gem itself to apply the version tag, then manually:

$ gem build release_tagger.gemspec
$ gem push

This will be handled by CI when this has tests.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Lostmyname/release_tagger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

release_tagger's People

Contributors

nadirollo avatar urbanautomaton avatar mcmillan avatar jackbot avatar alexstoick avatar

Stargazers

Martyn Cross avatar Jelmer Snoeck avatar Yuki Iwanaga avatar Juanito Fatas avatar

Watchers

Patrick Sinclair avatar Peter Roome avatar Ali avatar Barney Fox avatar  avatar Gianluca Trombetta avatar Peter Green avatar Robert Watts avatar Tom Cartwright avatar Edward Woodcock avatar Stephen Fulljames avatar James Cloos avatar Jonathan Tapia avatar Chris Villa avatar Liam Walsh avatar Gareth Weaver avatar Jesse Zwaan avatar Mike Harris avatar Marc Thomas avatar Paul Stakem avatar Slava avatar Nick Marsh avatar Raúl Contreras avatar Saad Koubeissi avatar Carmen Mardiros avatar  avatar Gerardo avatar Peter avatar Daniel Evans Jones avatar Daisy Smith avatar  avatar Nico avatar Simon Meyborg avatar  avatar Lee Giles avatar  avatar  avatar  avatar  avatar Chris Nokes avatar Dan Nokes avatar Florence Clutha avatar Lambro Anastasiou avatar Rifke Sadleir 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.