This application provides users with a simple way to download various pieces of information about a GitHub repository.
This is useful to me because I like to keep track of my accomplishments at work, and one high-level way to do that is to look at the titles of the PRs that I've merged.
Right now, this application will retrieve, format, and write to disk the following information from a specified repository:
- Pull request data:
- Titles
- Merged time
Here's an example of what the output file looks like:
- Clone this repository to your local disk, or download the latest version of the
mainbranch code here. - Ensure NodeJS v12.18.x is installed: https://nodejs.org/en/
- Rename
requestData.json.exampletorequestData.json. - Modify the values for all keys inside
requestData.jsonto fit your needs:- Replace the value of
GITHUB_ACCESS_TOKENwith your GitHub Access Token. Click here to get a GitHub Access Token. - Replace the value of
ownerwith the owner of the repository about which you want to retrieve data. - Replace the value of
repowith the name of the repository about which you want to retrieve data. - You can leave the value of
usernameFilterblank, unless you want to filter results such that they pertain only to this user.
- Replace the value of
- Open a PowerShell/Command Prompt/Terminal window, then
cdinto the directory containing this repository. - Run
npm ito install this project's dependencies.
Run node index.js. Script output will be placed inside the ./output/ folder.
