feat: Add pullnote command to extract notes detected with pullvet

Author: mumoshu

Makefile

@@ -7,6 +7,9 @@ build/exec:
 build:
 	go build -o bin/actions ./cmd
 
+install: build
+	mv bin/actions ~/bin/actions
+
 test/integration:
 	echo aaa
 	GITHUB_EVENT_NAME=issues GITHUB_EVENT_PATH=testdata/issues_event.json bin/actions exec -status-context milestone -- bin/actions pullvet -require-any -milestone-match 'test-v.+' label milestone/none

cmd/main.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/variantdev/go-actions/cmd/pullnote"
 	"github.com/variantdev/go-actions/cmd/pullvet"
 	"github.com/variantdev/go-actions/pkg/cli"
 	"github.com/variantdev/go-actions/pkg/exec"
@@ -54,6 +55,7 @@ func main() {
 
 	subCommands := []cli.Command{
 		pullvet.Command,
+		pullnote.Command,
 	}
 
 	for _, subCmd := range subCommands {

cmd/pullnote/pullnote.go

@@ -0,0 +1,36 @@
+package pullnote
+
+import (
+	"flag"
+
+	"github.com/variantdev/go-actions/pkg/cli"
+	"github.com/variantdev/go-actions/pkg/pullnote"
+	"github.com/variantdev/go-actions/pkg/pullvet"
+)
+
+var Command cli.Command = &cmd{}
+
+type cmd struct {}
+
+func (c *cmd) Name() string {
+	return "pullnote"
+}
+
+func (c *cmd) Run(args []string) error {
+	action := pullnote.New()
+
+	usage := `pullnote extracts notes detected by pullvet. The input should be provided as NDJSON via stdin or a file
+`
+
+	if err := cli.Setup(c, args, usage, func(fs *flag.FlagSet) {
+		fs.StringVar(&action.File, "file", "", "NDJSON file to read")
+		fs.StringVar(&action.NoteRegex, "note-regex", pullvet.DefaultNoteRegex, "Regexp pattern of each note(including the title and the body)")
+		fs.StringVar(&action.BodyKey, "body-key", "body", "Read pull request body containing notes from this key in the JSON object read from a NDJSON line")
+		fs.StringVar(&action.KindKey, "kind-key", "kind", "Extracted kind of the note is set to this key")
+		fs.StringVar(&action.DescKey, "desc-key", "desc", "Extracted description of the note is set to this key")
+	}); err != nil {
+		return err
+	}
+
+	return action.Run()
+}

pkg/pullnote/pullnote.go

@@ -0,0 +1,80 @@
+package pullnote
+
+import (
+	"bufio"
+	"encoding/json"
+	"fmt"
+	"io"
+	"os"
+	"regexp"
+)
+
+var newlineRegex = regexp.MustCompile(`\r\n|\r|\n`)
+
+type Action struct {
+	NoteRegex string
+	File      string
+	BodyKey   string
+	KindKey   string
+	DescKey   string
+}
+
+func normalizeNewlines(str string) string {
+	return newlineRegex.ReplaceAllString(str, "\n")
+}
+
+func New() *Action {
+	return &Action{
+	}
+}
+
+func (c *Action) Run() error {
+	regex := regexp.MustCompile(c.NoteRegex)
+
+	var in io.Reader
+
+	if c.File != "" {
+		file, err := os.Open(c.File)
+		if err != nil {
+			return err
+		}
+		defer file.Close()
+		in = file
+	} else {
+		in = os.Stdin
+	}
+
+	scanner := bufio.NewScanner(in)
+	for scanner.Scan() {
+		line := scanner.Text()
+		m := map[string]interface{}{}
+		if err := json.Unmarshal([]byte(line), &m); err != nil {
+			return err
+		}
+		key := c.BodyKey
+		value, ok := m[key]
+		if !ok {
+			return fmt.Errorf("required key %q does not exist: %s", key, line)
+		}
+
+		body, ok := value.(string)
+		if !ok {
+			return fmt.Errorf("unexpected type of body: expected string, got %T(%v)", value, value)
+		}
+
+		allNoteMatches := regex.FindAllStringSubmatch(normalizeNewlines(body), -1)
+		for _, match := range allNoteMatches {
+			kind, desc := match[1], match[2]
+			delete(m, c.BodyKey)
+			m[c.KindKey] = kind
+			m[c.DescKey] = desc
+			res, err := json.Marshal(m)
+			if err != nil {
+				return err
+			}
+			println(string(res))
+		}
+	}
+
+	return nil
+}