Skip to content

Uses the Github API to provide some useful utilities, such as analyzing pull requests.

Notifications You must be signed in to change notification settings

AndrewZurn/github-utilities

Repository files navigation

github-utilities

Uses the Github API to provide some useful utilities, such as analyzing pull requests.

To Build

Run ./gradlew packageDistribution. This will build a jar for the application and move it and a bash script to execute it to the dist directory.

To Run

Once you've built the app, you can execute it from the dist/ directory.

NOTE: You need to have a Github Access Token configured on your system as an environment variable called GITHUB_OAUTH in order for it to connect and read from the repository (must be public or you must own it/have read permissions if it's private) specified below.

Example - Print Merged Stats

github-utilities/dist> ./github-utilities --analyze merged --pr-limit 10 --repo-name <your-repo-name> --include-labels team1,release2

Example - Print in JSON

github-utilities/dist> ./github-utilities --output json --analyze open --pr-limit 5 --repo-name <your-repo-name>

Example - Analyze Multiple Repos with short-commands, individual statistics and a Not Before Date (due to only being able to provide a limit to the Github library)

github-utilities/dist> ./github-utilities -a merged -i -r <your-repo-name> -l 20 -r <your-repo-name> -l 50 -nb 2024-06-24

About

Uses the Github API to provide some useful utilities, such as analyzing pull requests.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages