feat(github)!: Do not comment on draft pull requests

Detect draft PRs and only comment on those if --comment-drafts is enabled.
Users may use draft pull requests as form of communication within teams and to
test stuff, having convcommitlint commenting all the time is probably too spammy.

Author: coolapso

cmd/github.go

@@ -5,8 +5,6 @@ import (
 	"fmt"
 	"github.com/google/go-github/v72/github"
 	"log"
-	"os"
-	"strconv"
 	"strings"
 )
 
@@ -19,29 +17,7 @@ const (
 
 // reviewGHPR creates a github pull request review
 // If no PR Number is provided in flags or env variable, tries to guess it from github actions context
-func createPrReview(issuesMessage string) (err error) {
-	token, exists := os.LookupEnv("GITHUB_TOKEN")
-	if !exists {
-		return errMissingGHToken
-	}
-
-	if prNumber == 0 {
-		if !githubAction() {
-			return errMissingPRNum
-		}
-
-		prNumber, err = getPRNumber()
-		if err != nil {
-			return fmt.Errorf("failed to get pull request number from github context GITHUB_REF_NAME, %v", err)
-		}
-	}
-
-	if repository == "" {
-		if repository, exists = os.LookupEnv("GITHUB_REPOSITORY"); !exists {
-			return errMissingRepository
-		}
-	}
-
+func createPrReview(c *github.Client, issuesMessage string) (err error) {
 	owner, repo := splitOwnerRepo(repository)
 	event := "REQUEST_CHANGES"
 	if commentOnly {
@@ -51,14 +27,13 @@ func createPrReview(issuesMessage string) (err error) {
 	markdownIssues := strings.ReplaceAll(issuesMessage, "\t", "")
 	reviewMessage := reviewTitle + reviewTitleText + markdownIssues + whatNowTitle + whatNowText
 
-	client := github.NewClient(nil).WithAuthToken(token)
 	review := github.PullRequestReviewRequest{
 		Body:  &reviewMessage,
 		Event: &event,
 	}
 
 	fmt.Println(owner + " " + repo)
-	_, resp, err := client.PullRequests.CreateReview(context.TODO(), owner, repo, prNumber, &review)
+	_, resp, err := c.PullRequests.CreateReview(context.TODO(), owner, repo, prNumber, &review)
 	if err != nil {
 		log.Fatal("failed to create pull request review: ", err)
 	}
@@ -71,29 +46,3 @@ func createPrReview(issuesMessage string) (err error) {
 	return nil
 }
 
-func splitOwnerRepo(repository string) (owner, repo string) {
-	owner = strings.Split(repository, "/")[0]
-	repo = strings.Split(repository, "/")[1]
-
-	return owner, repo
-}
-
-func getPRNumber() (n int, err error) {
-	return strconv.Atoi(strings.Split(os.Getenv("GITHUB_REF_NAME"), "/")[0])
-}
-
-func githubAction() bool {
-	if _, e := os.LookupEnv("GITHUB_ACTIONS"); e {
-		return true
-	}
-
-	return false
-}
-
-func pullRequest() bool {
-	if v := os.Getenv("GITHUB_EVENT_TYPE"); v == "pull_request" {
-		return true
-	}
-
-	return false
-}

cmd/root.go

@@ -6,10 +6,12 @@ import (
 	"os"
 	"slices"
 	"strings"
+	"context"
 
 	"github.com/go-git/go-git/v5"
 	"github.com/go-git/go-git/v5/plumbing"
 	"github.com/go-git/go-git/v5/plumbing/object"
+	"github.com/google/go-github/v72/github"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
@@ -21,6 +23,7 @@ type message struct {
 }
 
 var (
+	Version       = "DEV"
 	path          = "./"
 	baseBranch    = "main"
 	lintAll       bool
@@ -29,7 +32,8 @@ var (
 	prNumber      int
 	repository    string
 	commentOnly   bool
-	Version       = "DEV"
+	commentDrafts bool
+	token		  string
 )
 
 var rootCmd = &cobra.Command{
@@ -50,6 +54,12 @@ var versionCmd = &cobra.Command{
 }
 
 func lint() {
+	if createReview {
+		if err := initGHSettings(); err != nil {
+			log.Fatal(err)	
+		}
+	}
+
 	r, err := git.PlainOpen(path)
 	if err != nil {
 		log.Fatal("Failed to open repository")
@@ -113,7 +123,19 @@ func lint() {
 	if issuesFound {
 		fmt.Print(issuesMessage)
 		if createReview {
-			err := createPrReview(issuesMessage)
+			client := github.NewClient(nil).WithAuthToken(token)
+			owner, repo := splitOwnerRepo(repository)
+			pr, r, err := client.PullRequests.Get(context.TODO(), owner, repo, prNumber)
+			if err != nil || r.StatusCode != 200 {
+				log.Fatalf("failed to get pull request data, response: %v,  err: %v", fmt.Sprintf(r.Status, r.Response.Body), err)
+			}
+
+			if prIsDraft(pr) && !commentDrafts {
+				log.Println("PR is a draft, if you want to comment on draft PRs, use --comment-drafts flag")
+				os.Exit(1)
+			}
+
+			err = createPrReview(client, issuesMessage)
 			if err != nil {
 				log.Println("Failed to create pull request review: ", err)
 			}
@@ -122,18 +144,6 @@ func lint() {
 	}
 }
 
-func getBaseRef(r *git.Repository, branchName string) (baseRef *plumbing.Reference, err error) {
-	if !lintAll {
-		baseRefName := plumbing.NewBranchReferenceName(branchName)
-		baseRef, err = r.Reference(baseRefName, true)
-		if err != nil {
-			return nil, err
-		}
-	}
-
-	return baseRef, nil
-}
-
 func printIssues(issues []error, c *object.Commit) string {
 	header := fmt.Sprintf("%s Commit %s by %s:\n", "⛔", c.Hash.String()[:7], c.Author.Name)
 	subHeader := fmt.Sprintf("  Message: %s\n", strings.Split(strings.TrimSpace(c.Message), "\n")[0])
@@ -209,14 +219,6 @@ func lintCommitMessage(msg message) (errs []error) {
 	return errs
 }
 
-func emptyLine(s string) bool {
-	if s == "" || s == " " || s == "\n" {
-		return true
-	}
-
-	return false
-}
-
 func Execute() {
 	err := rootCmd.Execute()
 	if err != nil {
@@ -263,5 +265,9 @@ func init() {
 	_ = viper.BindPFlag("repository", rootCmd.Flags().Lookup("repository"))
 	repository = viper.GetString("repository")
 
+	rootCmd.PersistentFlags().BoolVar(&commentDrafts, "comment-drafts", false, "Comment on draft pull requests")
+	_ = viper.BindPFlag("comment-drafts", rootCmd.Flags().Lookup("comment-drafts"))
+	commentDrafts = viper.GetBool("comment-drafts")
+
 	rootCmd.MarkFlagsMutuallyExclusive("lint-all", "current", "base-branch")
 }

cmd/root_test.go

@@ -226,22 +226,3 @@ the convention`
 		}
 	})
 }
-
-func TestEmptyLine(t *testing.T) {
-	testsCases := []struct {
-		want   bool
-		string string
-	}{
-		{want: true, string: ""},
-		{want: true, string: " "},
-		{want: true, string: "\n"},
-		{want: false, string: "foo"},
-	}
-
-	for i, testCase := range testsCases {
-		got := emptyLine(testCase.string)
-		if testCase.want != got {
-			t.Fatalf("case [ %v ]: want [ %v ], got [ %v ]", i, testCase.want, got)
-		}
-	}
-}

cmd/utils.go

@@ -0,0 +1,109 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"strings"
+	"strconv"
+
+	"github.com/go-git/go-git/v5"
+	"github.com/go-git/go-git/v5/plumbing"
+	"github.com/google/go-github/v72/github"
+)
+
+// This function could use a better name
+func initGHSettings() (err error) {
+	token, err = getGHToken()
+	if err != nil {
+		return err
+	}
+
+	if prNumber == 0 {
+		if !githubAction() {
+			return errMissingPRNum
+		}
+
+		prNumber, err = getPRNumber()
+		if err != nil {
+			return fmt.Errorf("failed to get pull request number from github context GITHUB_REF_NAME, %v", err)
+		}
+	}
+
+	if repository == "" {
+		repository, err = getRepository()
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func getGHToken() (string, error) {
+	token, exists := os.LookupEnv("GITHUB_TOKEN")
+	if !exists {
+		return "", errMissingGHToken
+	}
+
+	return token, nil
+}
+
+func getRepository() (string, error) {
+	repo, exists := os.LookupEnv("GITHUB_REPOSITORY")
+	if !exists {
+		return "", errMissingRepository
+	}	
+
+	return repo, nil
+}
+
+func prIsDraft(pr *github.PullRequest) bool { 
+	return pr.GetDraft()
+}
+
+func getPRNumber() (n int, err error) {
+	return strconv.Atoi(strings.Split(os.Getenv("GITHUB_REF_NAME"), "/")[0])
+}
+
+func githubAction() bool {
+	if _, e := os.LookupEnv("GITHUB_ACTIONS"); e {
+		return true
+	}
+
+	return false
+}
+
+func pullRequest() bool {
+	if v := os.Getenv("GITHUB_EVENT_TYPE"); v == "pull_request" {
+		return true
+	}
+
+	return false
+}
+
+func splitOwnerRepo(repository string) (owner, repo string) {
+	owner = strings.Split(repository, "/")[0]
+	repo = strings.Split(repository, "/")[1]
+
+	return owner, repo
+}
+
+func getBaseRef(r *git.Repository, branchName string) (baseRef *plumbing.Reference, err error) {
+	if !lintAll {
+		baseRefName := plumbing.NewBranchReferenceName(branchName)
+		baseRef, err = r.Reference(baseRefName, true)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	return baseRef, nil
+}
+
+func emptyLine(s string) bool {
+	if s == "" || s == " " || s == "\n" {
+		return true
+	}
+
+	return false
+}