https://github.com/suchipi/prs-merged-since

CLI and JS API to list all PRs merged into a GitHub repo since a given tag
https://github.com/suchipi/prs-merged-since

Last synced: 4 months ago
JSON representation

CLI and JS API to list all PRs merged into a GitHub repo since a given tag

• Host: GitHub
• URL: https://github.com/suchipi/prs-merged-since
• Owner: suchipi
• Created: 2018-04-11T05:06:33.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-05-10T18:24:41.000Z (almost 4 years ago)
• Last Synced: 2024-10-04T13:32:16.003Z (5 months ago)
• Language: JavaScript
• Size: 139 KB
• Stars: 18
• Watchers: 4
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# prs-merged-since

This is a simple tool to list the PRs merged in a GitHub repo since a certain tag.

You can use it to find all the PRs merged since your last release, for example.

## CLI Usage

```

Options:

  --help     Show help                                                 [boolean]

  --version  Show version number                                       [boolean]

  --repo     GitHub repository, eg Microsoft/vscode                   [required]

  --tag      Tag to show merged PRs relative to, eg 1.1.3             [required]

  --format   Output format. Can be 'json' or 'markdown'.       [default: "json"]

  --references  Extract link references when format is markdown

                                                      [boolean] [default: false]

```

For example:

```sh

$ prs-merged-since --repo prettier/prettier --tag 1.11.1

```

You can provide a GitHub API Authorization Token by using the `GITHUB_API_TOKEN` environment variable:

```

$ GITHUB_API_TOKEN=your_token_goes_here prs-merged-since --repo prettier/prettier --tag 1.11.1

```

## JS Usage

There is also a JavaScript API:

```js

const prsMergedSince = require("prs-merged-since");

prsMergedSince({

  repo: "prettier/prettier", // required

  tag: "1.11.1", // required

  githubApiToken: "your_token_goes_here", // optional

}).then((prs) => {

  // prs is an array of PR objects as returned by the GitHub API

});

```

## License

MIT