initial

Alex Buchanan · Alex Buchanan · commit c30566a4918e · 2018-03-25T13:27:00.000-07:00
diff --git a/ghrn/ghrn.go b/ghrn/ghrn.go
@@ -0,0 +1,117 @@
+package ghrn
+
+import (
+	"context"
+  "net/http"
+	"fmt"
+  "io"
+	"strings"
+
+	"github.com/google/go-github/github"
+	"golang.org/x/oauth2"
+)
+
+// Config describes configuration for BuildReleaseNotes.
+type Config struct {
+  // Org is the name of the GitHub organization. Required.
+  Org string
+  // Repo is the name of the GitHub repository. Required.
+  Repo string
+
+  // GitHubToken is a GitHub API access token.
+  GitHubToken string
+
+  // StopAt is the number of the Pull Request to stop at.
+  // Useful for building the notes of PRs since the last release, for example.
+  StopAt int
+  // IncludeCommits will include commmits messages for each PR.
+  IncludeCommits bool
+}
+
+// BuildReleaseNotes lists GitHub Pull Requests and writes formatted release notes
+// to the given writer.
+func BuildReleaseNotes(ctx context.Context, w io.Writer, conf Config) error {
+
+  if conf.Org == "" {
+    return fmt.Errorf("Config.Org is required")
+  }
+  if conf.Repo == "" {
+    return fmt.Errorf("Config.Repo is required")
+  }
+
+  var httpClient *http.Client
+  if conf.GitHubToken != "" {
+    ts := oauth2.StaticTokenSource(
+      &oauth2.Token{AccessToken: conf.GitHubToken},
+    )
+    httpClient = oauth2.NewClient(ctx, ts)
+  }
+	cl := github.NewClient(httpClient)
+
+	opt := &github.PullRequestListOptions{
+		ListOptions: github.ListOptions{PerPage: 100},
+		State:       "closed",
+	}
+
+	// Iterate over all PRs
+	for {
+		prs, resp, err := cl.PullRequests.List(ctx, conf.Org, conf.Repo, opt)
+		if err != nil {
+      return fmt.Errorf("listing PRs: %s", err)
+		}
+
+		// Iterate over PRs in this page.
+		for _, pr := range prs {
+			if *pr.Number == conf.StopAt {
+        return nil
+			}
+			if pr.MergedAt == nil {
+				continue
+			}
+
+			fmt.Fprintf(w, "- PR #%d %s\n", pr.GetNumber(), pr.GetTitle())
+
+			if conf.IncludeCommits {
+				// Iterate over all commits in this PR.
+				commitOpt := &github.ListOptions{PerPage: 100}
+				for {
+
+					commits, resp, err := cl.PullRequests.ListCommits(ctx, conf.Org, conf.Repo, pr.GetNumber(), commitOpt)
+					if err != nil {
+            return fmt.Errorf("listing PR commits: %s", err)
+					}
+
+					// Iterate over commits in this page.
+					for _, commit := range commits {
+						sha := *commit.SHA
+						msg := *commit.Commit.Message
+
+						// Strip multiple lines (i.e. only take first line)
+						if i := strings.Index(msg, "\n"); i != -1 {
+							msg = msg[:i]
+						}
+						// Trim long lines
+						if len(msg) > 90 {
+							msg = msg[:90] + "..."
+						}
+						msg = strings.TrimSpace(msg)
+
+						fmt.Fprintf(w, "    - %s %s\n", sha, msg)
+					}
+
+					if resp.NextPage == 0 {
+						break
+					}
+					commitOpt.Page = resp.NextPage
+				}
+				fmt.Fprintln(w)
+			}
+		}
+
+		if resp.NextPage == 0 {
+			break
+		}
+		opt.Page = resp.NextPage
+	}
+  return nil
+}
diff --git a/main.go b/main.go
@@ -0,0 +1,40 @@
+package main
+
+import (
+	"context"
+  "flag"
+	"fmt"
+	"os"
+
+  "github.com/buchanae/github-release-notes/ghrn"
+)
+
+func main() {
+  conf := ghrn.Config{}
+
+  flag.StringVar(&conf.Org, "org", conf.Org, "Organization. (Required)")
+  flag.StringVar(&conf.Repo, "repo", conf.Repo, "Repo. (Required)")
+  flag.IntVar(&conf.StopAt, "stop-at", conf.StopAt, "PR number to stop at")
+  flag.BoolVar(&conf.IncludeCommits, "include-commits", conf.IncludeCommits, "Include commit messages")
+  flag.Parse()
+
+  if conf.Org == "" {
+    flag.Usage()
+    fmt.Fprintln(os.Stderr, "\nError: -org is required.")
+    os.Exit(1)
+  }
+  if conf.Repo == "" {
+    flag.Usage()
+    fmt.Fprintln(os.Stderr, "\nError: -repo is required.")
+    os.Exit(1)
+  }
+
+  conf.GitHubToken = os.Getenv("GITHUB_TOKEN")
+
+	ctx := context.Background()
+  err := ghrn.BuildReleaseNotes(ctx, os.Stdout, conf)
+  if err != nil {
+    fmt.Fprintln(os.Stderr, "Error: " + err.Error())
+    os.Exit(1)
+  }
+}
diff --git a/readme.md b/readme.md
@@ -0,0 +1,46 @@
+`github-release-notes` is a basic utility for generating release notes content from GitHub Pull Request history.
+
+## Usage
+
+Download a binary from the [releases](/releases) page, or run `go get github.com/buchanae/github-release-notes`.
+
+Run:
+```
+github-release-notes -org ohsu-comp-bio -repo funnel
+- PR #519 webdash: fixed elapsedTime calculation
+- PR #516 storage/swift: wrap errors with useful context
+- PR #515 Moving code
+- PR #514 build: fix release notes command
+- PR #513 Webdash upgrades
+- PR #512 worker/docker: log container metadata
+- PR #511 Unexport
+- PR #510 build: goreleaser, 0.6.0, github release notes gen
+...
+```
+
+You can stop generating notes at a specific PR:
+```
+github-release-notes -org ohsu-comp-bio -repo funnel -stop-at 513
+- PR #519 webdash: fixed elapsedTime calculation
+- PR #516 storage/swift: wrap errors with useful context
+- PR #515 Moving code
+- PR #514 build: fix release notes command
+```
+
+You can include the git commit messages for each PR:
+```
+github-release-notes -org ohsu-comp-bio -repo funnel -include-commits
+- PR #519 webdash: fixed elapsedTime calculation
+    - 7675a5a5d577340b47e4dbdc5b83338c35a26392 webdash: fixed elapsedTime calculation
+
+- PR #516 storage/swift: wrap errors with useful context
+    - 53b583c71da5e06c7dddd26e480f9099d6e8e60d storage/swift: wrap errors with useful context
+```
+
+You can use an [API access token][tok] by setting the `GITHUB_TOKEN` environment variable:
+```
+export GITHUB_TOKEN=1234...
+github-release-notes -org ohsu-comp-bio -repo funnel
+```
+
+[tok]: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
