Skip to content

librariesio/lib2issues

Repository files navigation

Sinatra app for creating GitHub issues whenever a new version of a dependency is discovered by Libraries.io using the repository web hook feature.

Usage

The easiest option is to deploy to heroku with the deploy button below:

Deploy

Before you deploy the heroku app, create a Personal Access Token under your GitHub account Settings -> Developer Settings

Add that token to the GITHUB_TOKEN field on heroku

Once deployed on heroku, visit https://libraries.io and go the the web hooks section of the repository you would like use Lib2Issues on

Then add the url of your deployed heroku app to the web hooks section for your repo on and add /webhook at the end of the url, i.e. https://mylib2issues.herokuapp.com/webhook


Or to run it somewhere else, clone it from github:

git clone https://github.com/librariesio/lib2issues.git

Install dependencies:

bundle install

Setup config environment variables:

GITHUB_TOKEN=mygithubapitoken
GITHUB_LABELS=help wanted,enhancement

Start the app:

rackup

Add the url of your app to web hooks section for your repo on https://libraries.io

Development

Source hosted at GitHub. Report issues/feature requests on GitHub Issues. Follow us on Twitter @librariesio. We also hangout on Gitter.

Getting Started

New to Ruby? No worries! You can follow these instructions to install a local server, or you can use the included Vagrant setup.

Installing a Local Server

First things first, you'll need to install Ruby 2.5.0. I recommend using the excellent rbenv, and ruby-build

rbenv install 2.5.0
rbenv global 2.5.0

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Add documentation if necessary.
  • Commit, do not change procfile, version, or history.
  • Send a pull request. Bonus points for topic branches.

Copyright

Copyright (c) 2018 Andrew Nesbitt. See LICENSE for details.