Skip to content

railsware/capistrano-changelog

Repository files navigation

capistrano-changelog

Uses git commits to recognize tracker stories and generates ChangeLog.

Integration with Capistrano.

Installation

Add this line to your application's Gemfile:

gem 'capistrano-changelog', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-changelog

Put into deploy.rb

require 'capistrano/changelog'

Usage

Use following settings at deploy.rb

role :changelog, %w{ host.name }, cache: true, version: true

set :changelog,         File.join(current_path, 'public', 'changelog.html')
set :changelog_version, File.join(current_path, 'public', 'version.json')

Hooks

# Generates ChangeLog file
#
after 'deploy:finished', 'deploy:changelog'

# Generates version.json with last commit hash
#
after 'deploy:update_code', 'deploy:version'

Contributing

  1. Fork it
  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

About

Chagelog based on Git commits with a Pivotal story tags

Resources

License

Stars

Watchers

Forks

Packages

No packages published