https://github.com/railsware/capistrano-changelog

Chagelog based on Git commits with a Pivotal story tags
https://github.com/railsware/capistrano-changelog

Last synced: about 1 year ago
JSON representation

Chagelog based on Git commits with a Pivotal story tags

• Host: GitHub
• URL: https://github.com/railsware/capistrano-changelog
• Owner: railsware
• License: mit
• Created: 2013-11-19T11:05:11.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2016-02-10T17:15:51.000Z (over 10 years ago)
• Last Synced: 2025-05-26T21:52:49.256Z (about 1 year ago)
• Language: Ruby
• Size: 47.9 KB
• Stars: 5
• Watchers: 50
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          

# 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