https://github.com/stscoundrel/goodbrother

List open PRs in Github by user
https://github.com/stscoundrel/goodbrother

github-api goodbrother javascript pull-requests typescript utility

Last synced: 21 days ago
JSON representation

List open PRs in Github by user

• Host: GitHub
• URL: https://github.com/stscoundrel/goodbrother
• Owner: stscoundrel
• License: mit
• Created: 2021-12-19T18:44:34.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-25T06:30:22.000Z (6 months ago)
• Last Synced: 2024-10-12T20:54:12.673Z (about 1 month ago)
• Topics: github-api, goodbrother, javascript, pull-requests, typescript, utility
• Language: TypeScript
• Homepage:
• Size: 918 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Goodbrother

List open PRs in Github by user.

## Motivation

If you have many repos that receive regular updades with Dependabot, you're simply likely to miss some of them. I occasionally only found PRs when I get notification that they were closed in favor of a even newer version.

Goodbrother is there to let me know if I still have some open.

### Install

`yarn add goodbrother`

##### Usage

Main method is to get open PRs by username.

```javascript

import { getPullRequestsByUser, groupPullRequestsByRepository } from 'goodbrother'

const openPRs = await getPullRequestsByUser('stscoundrel');

/**

 * Array of PRs with structure like:

 * {

 *   id: 1068208284,

 *   name: Bump eslint-config-airbnb-base from 14.2.1 to 15.0.0,

 *   link: https://github.com/stscoundrel/gatsby-source-plugin-zoega/pull/18,

 *   isDependabot: true,

 *   repository: stscoundrel/gatsby-source-plugin-zoega,

 * }

 */

console.log(openPRs);

// You can also group the result by repository.

const byRepository = groupPullRequestsByRepository(openPRs);

/**

 * Array of repo summaries with structure like:

 * {

 *   name: stscoundrel/gatsby-source-plugin-zoega,

 *   pullRequests: [

 *     {

 *       id: 1068208284,

 *       name: Bump eslint-config-airbnb-base from 14.2.1 to 15.0.0,

 *       link: https://github.com/stscoundrel/gatsby-source-plugin-zoega/pull/18,

 *       isDependabot: true,

 *       repository: stscoundrel/gatsby-source-plugin-zoega,

 *      },

 *     ...

 *   ]

 * }

 */

```