# DeployNotes

This gem provides an interface that allows you to get deploy information for use in your application.

The interface provides you with the following string
`deployed branch name`:`commiter_email`:`commit_subject`:`commit_time`

`notify-branch-environments ::luis@homestars.com:deploy_notes gem notify-branch-environments:33 seconds ago`

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'deploy_notes'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install deploy_notes

## Usage

mount this gem as an engine to your `config/routes.rb`

`mount DeployNotes::Engine, at: 'deploy_notes'`

Use it in your views

`= render "deploy_notes/show" unless Rails.env.production?`

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

### To build:

1. bump version

2. `rake build`

3. `rake release`

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lsaffie/deploy_notes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the DeployNotes project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lsaffie/deploy_notes/blob/master/CODE_OF_CONDUCT.md).