Giter Club home page Giter Club logo

license-bot's Introduction

License Bot

License bot adds a comment to Reddit submissions that link to any Github repository which doesn't contain a license file.

Setup

Create a .env file in the root project directory, based off of the .env.example file.

// Required on OSX >=10.11

brew install openssl

export OPENSSL_INCLUDE_DIR="$(brew --prefix openssl)/include"
export OPENSSL_LIB_DIR="$(brew --prefix openssl)/lib"

cargo build

Run

Local
// First be sure to complete the setup above

cargo run 
Heroku
  1. Create a new Heroku app
  2. Install the Heroku Scheduler add-on
  3. Add Heroku as a git remote heroku git:remote -a license-bot
  4. Tell Heroku to use the Rust buildpack heroku buildpacks:set https://github.com/emk/heroku-buildpack-rust.git
  5. Push to the Heroku repo git push heroku master
  6. Setup the environment variables on Heroku
  7. Setup the heroku scheduler to run ./target/release/license-bot
  8. Test run the bot with heroku run ./target/release/license-bot

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

license-bot's People

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

neonvim

license-bot's Issues

License detection regarding package files (composer.json, package.json, etc)

It seems that the bot only checks for licences via repo link and Readme, but not in package files.

Example:

https://www.reddit.com/r/javascript/comments/dzm2ia/my_first_opensource_release_for_my_side_project_a/

A license is set in the package.json.

See:

https://github.com/hikerfeed/restful-resource/blob/develop/package.json#L17

This is more likely a possible enhancement than an error and could very well be out of scope for this bot though.

Thoughts?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.