Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.24 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.24 KB
Raw

Fiesta

Fiesta helps integrate deployment tools with GitHub pull requests and Slack, making sharing release reports with the rest of the team a breeze.

When deploying, Fiesta will compile an editable list of pull requests merged to the default branch since the last release, pulling out any images from the descriptions so they can be attached as screenshots:

The edited content will be posted to Slack:

Usage

Build a new report for the release:

report = Fiesta::Report.new('balvig/fiesta', {
  last_released_at: '20180920074104',
  comment: 'Only include new features',
  auto_compose: true,
})

Annouce the report to the Slack channel:

report.announce(
  webhook: 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX',
  payload: {
    channel: '#release',
    username: 'New Releases',
    icon_emoji: ':tada:'
  }
)

Save the report as a GitHub release:

report.create_release('20180927145914')

Integrating with Capistrano

Fiesta provides integration with Capistran.

  1. Add fiesta to your application's Gemfile:
gem 'fiesta'
  1. Require in the capfile or appropriate stage and configure the Slack channel:
require 'capistrano/fiesta'
set :fiesta_slack_channel, '#release'
set :slack_webhook 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX'
  1. If you're using hub, your GitHub credentials should already be configured. Otherwise you can use the ENV vars in Octokit to configure GitHub access.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/balvig/fiesta. After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests.

License

The gem is available as open source under the terms of the MIT License.