https://github.com/promiseofcake/merged-prs

Tool to determine GitHub Pull Requests merged between two given commit hashes, branches, or tags.
https://github.com/promiseofcake/merged-prs

Last synced: 11 days ago
JSON representation

Tool to determine GitHub Pull Requests merged between two given commit hashes, branches, or tags.

• Host: GitHub
• URL: https://github.com/promiseofcake/merged-prs
• Owner: promiseofcake
• Archived: true
• Created: 2016-01-14T21:55:26.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2021-01-15T00:28:24.000Z (over 3 years ago)
• Last Synced: 2024-05-28T21:30:57.031Z (30 days ago)
• Language: Go
• Size: 24.4 KB
• Stars: 14
• Watchers: 3
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - promiseofcake/merged-prs - Tool to determine GitHub Pull Requests merged between two given commit hashes, branches, or tags. (Go)

README

        
# merged-prs

merged-prs is a go tool to assist in determining differences between git hashes

based upon the GitHub PR as the vehicle for change.

## Requirements

* Go 1.12 (lower may work)

* Dep

* Git

* GitHub

* Slack (optional)

## Features

* Built in Go

* Given a set of git hashes, a list of merged GitHub Pull Requests will be

  retrieved and parsed.

* List will be output to console containing the PR #, Author, Summary, and a

  link to the PR

* If Slack credentials are configured, a notification will be sent to the

  channel of your choosing (from config, or override)

## Configuration

A `.merged-prs` configuration file must be created in your `$HOME` directory.

This configuration uses [HashiCorp's HCLSyntax](https://github.com/hashicorp/hcl#syntax).

Using the example configuration below create a file in `~/.merged-prs`

*Example Config*

```

// GitHub Personal Access Token && Org/Username required for use.

GitHub {

    Token = "foo"

    Org   = "promiseofcake"

}

// Optional config for Slack notifications

Slack {

    WebhookURL = "https://hooks.slack.com/services/foo/bar/baz"

    Channel    = "@lucas"

    Emoji      = ":shipit:"

}

```

## Installation

In order to use the `merged-prs` tool one should use `go get`

```bash

go get github.com/promiseofcake/merged-prs

```

## Usage

Calling the `merged-prs` tool will act in the current directory's context.

### Flags

```bash

# Runtime Flags

  -path       

  -dev=false  

  -test       

  -c          

```

### Example

```bash

# merged-prs [-test] [-c @lucas] [-dev=false] [-path /path/to/repo] [Previous Git Hash] [Current Git Hash]

# User should specify the older revision first ie. merging `dev` into `master` would necessitate that `master` is the older commit, and `dev` is the newer

$ merged-prs master dev

Determining merged branches between the following hashes: master dev

REPO: Merged GitHub PRs between the following refs: master dev

PR   Author    Description              URL

#55  @lucas    Typo 100 vs 1000         http://github.com/promiseofcake/foo/pull/55

#54  @lucas    LRU Cache Store Results  http://github.com/promiseofcake/foo/pull/54

```