Git Product home page Git Product logo

github-multi-repo-dependency-tool's Introduction

Github Multi Repo Dependency Tool

Synopsis

Usage

API Reference

The application contains four public API routes:

  • GET: "/" (Server Test Ping)
  • POST: "/" (Main Repo Hook)
  • POST: "/dep" (Dependency Repo Hook)
  • GET: "/flush" (Flush The Database)

###Server Test Ping:

Sending a GET request to the root API("/") will ping the server and print out Server is up and running

###Main Repo Hook:

Sending a POST request to the root API("/") will trigger the functionality that checks if the Pull Request has a dependency, then locks it if it does. The POST request expects data in the format of Githubs Pull Request Hook.

###Dependency Repo Hook:

Sending a POST request to the "/dep" of the API will trigger the functionality that unlocks the Pull Request from the main repo, allowing it to be merged in. The POST request expects data in the format of Githubs Pull Request Hook.

###Flush The Database:

Sending a GET request to the "/flush" of the API will clear the database of all it's stored values. (WARNING: Don't flush the database if you have a Pull Request open that is currently being blocked by a dependency)

Deployment Via Heroku

License

github-multi-repo-dependency-tool's People

Contributors

tcrands avatar

Watchers

 avatar  avatar

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.