Prevent release please pr creating useless pipelines

client/github/client.go

@@ -49,6 +49,13 @@ type Client interface {
 		prNumber int,
 		assignees []string,
 	) error
+	CreateStatus(
+		ctx context.Context,
+		org string,
+		repo string,
+		ref string,
+		status *github.RepoStatus,
+	) error
 
 	GetPullRequest(
 		ctx context.Context,
@@ -85,6 +92,11 @@ type Client interface {
 		owner, repo, path string,
 		opts *github.RepositoryContentGetOptions,
 	) (*github.RepositoryContent, []*github.RepositoryContent, error)
+	CompareCommits(
+		ctx context.Context,
+		owner, repo string,
+		base, head string,
+	) (*github.CommitsComparison, error)
 }
 
 type gitHubClient struct {
@@ -211,6 +223,24 @@ func (c *gitHubClient) AssignPullRequest(
 	return nil
 }
 
+func (c *gitHubClient) CreateStatus(
+	ctx context.Context,
+	org string,
+	repo string,
+	ref string,
+	status *github.RepoStatus,
+) error {
+	if c.dryRunMode {
+		msg := fmt.Sprintf("github.CreateStatus: org=%s,repo=%s,ref=%s,state=%s,context=%s",
+			org, repo, ref, status.GetState(), status.GetContext(),
+		)
+		logger.GetRequestLogger().Push(msg)
+		return nil
+	}
+	_, _, err := c.client.Repositories.CreateStatus(ctx, org, repo, ref, status)
+	return err
+}
+
 func (c *gitHubClient) GetPullRequest(
 	ctx context.Context,
 	org string,
@@ -274,3 +304,12 @@ func (c *gitHubClient) GetContents(
 	)
 	return fileContent, dirContents, err
 }
+
+func (c *gitHubClient) CompareCommits(
+	ctx context.Context,
+	owner, repo string,
+	base, head string,
+) (*github.CommitsComparison, error) {
+	comparison, _, err := c.client.Repositories.CompareCommits(ctx, owner, repo, base, head)
+	return comparison, err
+}

main_pullrequest.go

@@ -121,7 +121,9 @@ func processGitHubPullRequest(
 					pr.Sender.GetLogin(),
 				)
 			}
-			if !options.SkipCI {
+			if !options.SkipCI &&
+				!skipPipelineForReleasePR(
+					ctx, log, githubClient, pr, conf.githubOrganization) {
 				err = retryOnError(retryParams{
 					retryFunc: func() error {
 						return startPRPipeline(log, prBranchName, pr, conf, isOrgMember)

release_please.go

@@ -0,0 +1,127 @@
+package main
+
+import (
+	"context"
+	"path"
+	"strings"
+
+	"github.com/google/go-github/v28/github"
+	"github.com/sirupsen/logrus"
+
+	clientgithub "github.com/mendersoftware/integration-test-runner/client/github"
+)
+
+const (
+	releasePleaseBranchPrefix = "release-please--branches--"
+	releasePleaseLabel        = "autorelease: pending"
+	releasePleaseManifest     = ".release-please-manifest.json"
+	releasePleaseChangelog    = "CHANGELOG*.md"
+	gitLabStatusContext       = "ci/gitlab"
+)
+
+func skipPipelineForReleasePR(
+	ctx context.Context,
+	log *logrus.Entry,
+	githubClient clientgithub.Client,
+	pr *github.PullRequestEvent,
+	org string,
+) bool {
+	req := pr.GetPullRequest()
+	if ok, reason := isReleasePleasePR(req, githubBotName); !ok {
+		if strings.HasPrefix(req.GetHead().GetRef(), releasePleaseBranchPrefix) {
+			log.Infof("PR %d is on a release-please branch but needs a pipeline: %s",
+				pr.GetNumber(), reason)
+		}
+		return false
+	}
+
+	repo := pr.GetRepo().GetName()
+	head := req.GetHead().GetSHA()
+	comparison, err := githubClient.CompareCommits(
+		ctx, org, repo, req.GetBase().GetSHA(), head,
+	)
+	if err != nil {
+		log.Errorf("CompareCommits failed for PR %d, running the pipeline: %s",
+			pr.GetNumber(), err)
+		return false
+	}
+
+	ok, reason := isChangelogOnlyDiff(comparison.Files)
+	if !ok {
+		log.Infof("PR %d at %s needs a pipeline: %s", pr.GetNumber(), head, reason)
+		return false
+	}
+
+	status := &github.RepoStatus{
+		State:       github.String("success"),
+		Context:     github.String(gitLabStatusContext),
+		Description: github.String("Skipped: release-please PR, " + reason),
+	}
+	if err := githubClient.CreateStatus(ctx, org, repo, head, status); err != nil {
+		log.Errorf("CreateStatus failed for PR %d at %s, running the pipeline: %s",
+			pr.GetNumber(), head, err)
+		return false
+	}
+
+	log.Infof("PR %d at %s: skipped the pipeline, %s, files=%v",
+		pr.GetNumber(), head, reason, changedFileNames(comparison.Files))
+	return true
+}
+
+func changedFileNames(files []github.CommitFile) []string {
+	names := make([]string, 0, len(files))
+	for _, file := range files {
+		names = append(names, file.GetFilename())
+	}
+	return names
+}
+
+func isReleasePleasePR(pr *github.PullRequest, botName string) (bool, string) {
+	if pr.GetUser().GetLogin() != botName {
+		return false, "author is not " + botName
+	}
+	if pr.GetHead().GetRepo().GetFullName() != pr.GetBase().GetRepo().GetFullName() {
+		return false, "head is a fork"
+	}
+	if !strings.HasPrefix(pr.GetHead().GetRef(), releasePleaseBranchPrefix) {
+		return false, "head branch is not a release-please branch"
+	}
+	if !hasLabel(pr, releasePleaseLabel) {
+		return false, "missing the " + releasePleaseLabel + " label"
+	}
+	return true, "release-please pull request"
+}
+
+func isChangelogOnlyDiff(files []github.CommitFile) (bool, string) {
+	if len(files) == 0 {
+		return false, "empty diff"
+	}
+	for _, file := range files {
+		for _, name := range []string{file.GetFilename(), file.GetPreviousFilename()} {
+			if name == "" {
+				continue
+			}
+			if !isChangelogPath(name) {
+				return false, "diff touches " + name
+			}
+		}
+	}
+	return true, "changelog only"
+}
+
+func isChangelogPath(name string) bool {
+	if name == releasePleaseManifest {
+		return true
+	}
+	matched, err := path.Match(releasePleaseChangelog, path.Base(name))
+	return err == nil && matched
+}
+
+func hasLabel(pr *github.PullRequest, name string) bool {
+	for _, label := range pr.Labels {
+		if label.GetName() == name {
+			return true
+		}
+	}
+	return false
+}