The Release Ninja

Provide your product manager, internal stakeholders, and customers with real-time release notes from your Github based project. By seamlessly integrating with Github, The Release Ninja is able to provide a format for "release notes" that are synced, edited, and finally published.

Getting Started (via Heroku)

Keeping Heroku up to date is a bit more involved than clicking a button. If you clone this repo (origin), add your heroku git repo as a remote (called production), then you can run

git pull origin master && git push production master --force && heroku run rake db:migrate

then it should keep it up to date! This is only needed if we added a cool feature that you want.

0 to Tests Passing

1. bundle install
2. rake db:setup
3. cp .template.env .env
4. Obtain your Github Client ID and Secret from https://github.com/settings/developers > Register new application. Place these in the .env file in the correct place. The settings should look like the github settings at the bottom of this document.
5. Create a new Github Personal Access Token with [repo, write_repo_hook] and enter this into the .env you created.
6. Create a Google API Application and copy your id and secret to your .env. The settings are at the bottom of this document.
7. cp spec/fixtures/your_repos.template.yaml spec/fixtures/your_repos.private.yaml
8. Enter in some repos that you have both private / public / organizationally in spec/fixtures/your_repos.private.yaml. This will allow for the RepositoryList spec to come out of it's pending state. These private files should not go in VCS.
9. rspec and your specs pass!...hopefully

License

This project is provided under the MIT License, see LICENSE for a copy.

In Due Time

• Emails for a user are customizable
• Releases are in an rss feed
• Releases are in beautiful 1 page format
• Reviewers are in groups and groups can be notified in the workflow
• Workflow editor that triggers on different events
• UI for project settings is more intuitive

Github Settings - Local

Note Use ngrok.com to allow external ips to connect to your local machine. This will allow Github to send you webhooks locally. Do not use stevegrok as your subdomain, as it is locked down such that only I can use it.

Github Settings - Production

Your production URL will obviously be different than mine.

Google API Settings - Local & Production

You can use the same API settings for local and production, but I recommend having 2 separate applications so you can easily cycle keys. Create a new project at console.developers.google.com > APIs & auth > credentials > Create new Client ID and update your settings to look like this (local & production merged)