Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.82 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.82 KB

Github Review Window

A GitHub Webhook Implementation

Build Status

To run it via Maven and the spring-boot plugin:

$ mvn spring-boot:run [OPTIONS]

To run it on the regular command line:

$ java [OPTIONS] -jar gh-review-window-(version)-full.jar

Where OPTIONS include:

option description
duration required This is the default window duration
duration.LABEL Additional durations for specific labels
secret The secret that will be used to compute the HMAC
startupRepos Comma separated full repository names to process at startup

For the syntax of period strings, see the java.time.Duration javadoc.

This is a superset of Spring Boot's autoconfiguration, see the list of common application properties for other supported configuration options.

Example:

$ mvn spring-boot:run -Dduration=P2D

Oauth

In order to give Review Window the ability to add commit statuses, you need to specify credentials that it can use to access those.

  • Generate an Oauth token that gives repo:status access.
  • Add it to your environment or ~/.github file as github_oauth.