Introducing changelog generation tool

bot/go.mod

@@ -10,6 +10,12 @@ require (
 )
 
 require (
+	github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 // indirect
+	github.com/xhit/go-str2duration/v2 v2.1.0 // indirect
+)
+
+require (
+	github.com/alecthomas/kingpin/v2 v2.4.0
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect

bot/go.sum

@@ -1,6 +1,10 @@
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
 cloud.google.com/go v0.34.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/alecthomas/kingpin/v2 v2.4.0 h1:f48lwail6p8zpO1bC4TxtqACaGqHYA22qkHjHpqDjYY=
+github.com/alecthomas/kingpin/v2 v2.4.0/go.mod h1:0gyi0zQnjuFk8xrkNKamJoyUo382HRL7ATRpFZCw6tE=
+github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 h1:s6gZFSlWYmbqAuRjVTiNNhvNRfY2Wxp9nhfyel4rklc=
+github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137/go.mod h1:OMCwj8VM1Kc9e19TLln2VL61YJF0x1XFtfdL4JdbSyE=
 github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/cespare/xxhash/v2 v2.1.1/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
@@ -69,10 +73,13 @@ github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ
 github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/xhit/go-str2duration/v2 v2.1.0 h1:lxklc02Drh6ynqX+DdPyp5pCKLUQpRT8bp8Ydu2Bstc=
+github.com/xhit/go-str2duration/v2 v2.1.0/go.mod h1:ohY8p+0f07DiV6Em5LKB0s2YpLtXVyJfNt1+BlmyAsU=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
 go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=

go.mod

@@ -0,0 +1,18 @@
+module github.com/gravitational/shared-workflows
+
+go 1.22.4
+
+require (
+	github.com/alecthomas/kingpin/v2 v2.4.0
+	github.com/gravitational/trace v1.4.0
+	github.com/stretchr/testify v1.9.0
+)
+
+require (
+	github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/xhit/go-str2duration/v2 v2.1.0 // indirect
+	golang.org/x/net v0.17.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)

libs/gh/gh.go

@@ -0,0 +1,34 @@
+package gh
+
+import (
+	"bytes"
+	"os/exec"
+	"strings"
+
+	"github.com/gravitational/trace"
+)
+
+// IsAvailable returns status of git
+func IsAvailable() error {
+	_, err := exec.LookPath("gh")
+	return err
+}
+
+// RunCmd runs the GitHub CLI returns output (stdout/stderr, depends on the cmd result) and error
+func RunCmd(dir string, args ...string) (string, error) {
+	var stdout bytes.Buffer
+	var stderr bytes.Buffer
+
+	cmd := exec.Command("gh", args...)
+	cmd.Stdout = &stdout
+	cmd.Stderr = &stderr
+	cmd.Dir = dir
+
+	err := cmd.Run()
+
+	if err != nil {
+		return strings.TrimSpace(stderr.String()), trace.Wrap(err)
+	}
+
+	return strings.TrimSpace(stdout.String()), nil
+}

libs/gh/pull_request.go

@@ -0,0 +1,51 @@
+package gh
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"strings"
+
+	"github.com/gravitational/trace"
+)
+
+// ChangelogPR contains all the data necessary for a changelog from the PR
+type ChangelogPR struct {
+	Body   string `json:"body,omitempty"`
+	Number int    `json:"number,omitempty"`
+	Title  string `json:"title,omitempty"`
+	URL    string `json:"url,omitempty"`
+}
+
+// ListChangelogPullRequestsOpts contains options for searching for changelog pull requests.
+type ListChangelogPullRequestsOpts struct {
+	Branch   string
+	FromDate string
+	ToDate   string
+}
+
+// ListChangelogPullRequests will search for pull requests that provide changelog information.
+func ListChangelogPullRequests(ctx context.Context, dir string, opts *ListChangelogPullRequestsOpts) ([]ChangelogPR, error) {
+	var prs []ChangelogPR
+	query := fmt.Sprintf("base:%s merged:%s -label:no-changelog", opts.Branch, dateRangeFormat(opts.FromDate, opts.ToDate))
+
+	data, err := RunCmd(dir, "pr", "list", "--search", query, "--limit", "200", "--json", "number,url,title,body")
+	if err != nil {
+		return prs, trace.Wrap(err)
+	}
+
+	dec := json.NewDecoder(strings.NewReader(data))
+	if err := dec.Decode(&prs); err != nil {
+		return prs, trace.Wrap(err)
+	}
+	return prs, nil
+}
+
+// dateRangeFormat takes in a date range and will format it for GitHub search syntax.
+// to can be empty and the format will be to search everything after from
+func dateRangeFormat(from, to string) string {
+	if to == "" {
+		return fmt.Sprintf(">%s", from)
+	}
+	return fmt.Sprintf("%s..%s", from, to)
+}

libs/git/git.go

@@ -0,0 +1,52 @@
+/*
+ * Teleport
+ * Copyright (C) 2024  Gravitational, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package git
+
+import (
+	"bytes"
+	"os/exec"
+	"strings"
+
+	"github.com/gravitational/trace"
+)
+
+// IsAvailable returns status of git
+func IsAvailable() error {
+	_, err := exec.LookPath("git")
+	return err
+}
+
+// RunCmd runs git and returns output (stdout/stderr, depends on the cmd result) and error
+func RunCmd(dir string, args ...string) (string, error) {
+	var stdout bytes.Buffer
+	var stderr bytes.Buffer
+
+	cmd := exec.Command("git", args...)
+	cmd.Stdout = &stdout
+	cmd.Stderr = &stderr
+	cmd.Dir = dir
+
+	err := cmd.Run()
+
+	if err != nil {
+		return strings.TrimSpace(stderr.String()), trace.Wrap(err)
+	}
+
+	return strings.TrimSpace(stdout.String()), nil
+}

tools/changelog/README.md

@@ -0,0 +1,75 @@
+# changelog
+
+This script generates a changelog for a release.
+
+## Usage
+
+```
+usage: changelog [<flags>]
+
+Flags:
+  --[no-]help              Show context-sensitive help (also try --help-long and --help-man).
+  --base-branch=BASEBRANCH  The base release branch to generate the changelog for. It will be of the form branch/v* ($BASE_BRANCH)
+  --base-tag=BASETAG        The tag/version to generate the changelog from. It will be of the form vXX.Y.Z, e.g. v15.1.1 ($BASE_TAG)
+```
+
+It can optionally take two input variables: BASE_BRANCH: The base release
+branch to generate the changelog for. It will be of the form "branch/v*".
+BASE_TAG: The tag/version to generate the changelog from. It will be of the
+form "vXX.Y.Z", e.g. "v15.1.1"
+
+
+If neither are provided, the values will be automatically determined if
+possible:
+* The current branch will be used as the base branch if it matches the
+  pattern branch/v*
+* If the current branch is forked from a base branch, the base branch will be
+  used. e.g. if you create release/15.1.1 from branch/v15, the branch/v15
+  will be the base branch.
+* The base tag will be determined by running "make print-version" from the
+  root of the repo.
+
+
+Enterprise PR changelogs will be listed after the OSS changelogs. You need to
+determine if it is suitable to include them. If you do, remove the markdown
+link from each changelog when adding the changelog to CHANGELOG.md. These
+links won't work for the general public. Keep the links when adding the
+changelog to the release PR so that the enterprise PRs will link to the
+release PR.
+
+If you reword changelogs, it is best to go to the source PR and change it
+there and then regenerate the changelog.
+
+
+Caveats:
+* If you update the "e" ref in your release PR, and you also run `make
+  changelog` from the release PR branch, if you have already updated the
+  version in the makefile, you will need to run `make changelog
+  BASE_TAG=X.Y.Z` as this script will determine the base tag to be the
+  current release version not the last released version.
+
+
+One preferred way of using this script is to run `make changelog` from the
+base branch and save it: `make changelog > /tmp/changelog`. If any PRs are
+merged to the base branch after you have created your release PR but before
+you have merged it, you can see any new entries with:
+
+```
+git checkout branch/vNN
+diff -u /tmp/changelog $(make changelog)
+```
+If there are changes, you can update your changelog and rebase your branch:
+```
+git pull on branch/vNN
+make changelog > /tmp/changelog
+git checkout release/XX.Y.Z
+git rebase branch/vNN
+<include /tmp/changelog in CHANGELOG.md>
+git add CHANGELOG.md && git commit --amend --no-edit && git push -f
+```
+
+Ensure you update the PR body with the new changelog, doable on the command
+line with `gh`:
+```
+gh pr edit --body-file /tmp/changelog
+```