Merge pull request #12 from CarlJi/rebase

feat: add Rebase suggestion lint

README.md

@@ -17,4 +17,4 @@ Please note that cr-bot is still in its early stages, and we have plans to integ
 
 Lastly, we welcome any contributions to the project! Your bug reports, feature suggestions, and active participation in the development process are greatly appreciated. Together, we can make cr-bot even better.
 
-![Alt text](docs/static/image.png)
+![Alt text](docs/static/image.png)

config/config.go

@@ -34,7 +34,7 @@ func NewConfig(conf string) (Config, error) {
 	return c, nil
 }
 
-func (c Config) Linters(org, repo string) map[string]Linter {
+func (c Config) CustomLinterConfigs(org, repo string) map[string]Linter {
 	if repoConfig, ok := c[org+"/"+repo]; ok {
 		return repoConfig
 	}

config/config.yaml

@@ -1,10 +1,15 @@
-qbox: # github organization name
-  staticcheck: # linters
-    enable: true
-    command: staticcheck # linter command, if not set, will use the linter name registered in init stage
-    args: ["./..."]
-    run_if_changed: [".go$"] # only run if changed files match the regex
-
+# This is the default config file, you can override it by creating a config.yaml in the same directory
+# by default, all linters are enabled if you don't specify. You can disable them by setting enable to false
+# example1: disable staticcheck for org
+# qbox:
+#  staticcheck:
+#    enable: false
+#   
+# example2: disable staticcheck for repo
+# qbox/kodo:
+#  staticcheck:
+#    enable: false
+#
 qbox/kodo: # github repository name, which will override the settings in qbox org
   staticcheck: # repo specific settings will override the settings in qbox org
     enable: true

pulls.go → github.go

@@ -1,18 +1,19 @@
 /*
-Copyright 2023 Qiniu Cloud (qiniu.com).
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ Copyright 2024 Qiniu Cloud (qiniu.com).
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
 */
+
 package main
 
 import (
@@ -22,7 +23,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/cr-bot/linters"
+	"github.com/cr-bot/internal/linters"
 	"github.com/google/go-github/v57/github"
 	"github.com/qiniu/x/log"
 )
@@ -51,7 +52,7 @@ func (s *Server) ListPullRequestsFiles(ctx context.Context, owner string, repo s
 	}
 }
 
-func (s *Server) PostCommentsWithRetry(ctx context.Context, owner string, repo string, number int, comments []*github.PullRequestComment) error {
+func (s *Server) PostPullReviewCommentsWithRetry(ctx context.Context, owner string, repo string, number int, comments []*github.PullRequestComment) error {
 	var existedComments []*github.PullRequestComment
 	err := retryWithBackoff(ctx, func() error {
 		originalComments, resp, err := s.gc.PullRequests.ListComments(ctx, owner, repo, number, nil)

hunk.go

@@ -1,18 +1,19 @@
 /*
-Copyright 2023 Qiniu Cloud (qiniu.com).
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ Copyright 2024 Qiniu Cloud (qiniu.com).
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
 */
+
 package main
 
 import (

hunk_test.go

@@ -1,18 +1,19 @@
 /*
-Copyright 2023 Qiniu Cloud (qiniu.com).
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ Copyright 2024 Qiniu Cloud (qiniu.com).
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
 */
+
 package main
 
 import (

internal/linters/git-flow/rebase-suggestion/rebase-suggestion.go

@@ -0,0 +1,83 @@
+/*
+ Copyright 2024 Qiniu Cloud (qiniu.com).
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
+package rebase_suggestion
+
+import (
+	"context"
+	"fmt"
+	"regexp"
+
+	"github.com/cr-bot/config"
+	"github.com/cr-bot/internal/linters"
+	"github.com/google/go-github/v57/github"
+	"github.com/qiniu/x/log"
+)
+
+var lintName = "rebase-suggestion"
+
+func init() {
+	// register linter
+	linters.RegisterCommentHandler(lintName, rebaseSuggestionHandler)
+}
+
+func rebaseSuggestionHandler(linterConfig config.Linter, agent linters.Agent, event github.PullRequestEvent) error {
+	opts := &github.ListOptions{}
+	commits, response, err := agent.GitHubClient().PullRequests.ListCommits(context.Background(), event.GetRepo().GetOwner().GetLogin(), event.GetRepo().GetName(), event.GetNumber(), opts)
+	if err != nil {
+		return err
+	}
+
+	if response.StatusCode != 200 {
+		log.Errorf("list commits failed: %v", response)
+		return fmt.Errorf("list commits failed: %v", response.Body)
+	}
+
+	comment := checkCommitMessage(commits)
+	if len(comment) == 0 {
+		return nil
+	}
+	c, resp, err := agent.GitHubClient().Issues.CreateComment(context.Background(), event.GetRepo().GetOwner().GetLogin(), event.GetRepo().GetName(), event.GetNumber(), &github.IssueComment{
+		Body: &comment,
+	})
+	if err != nil {
+		return err
+	}
+
+	if resp.StatusCode != 201 {
+		log.Errorf("create comment failed: %v", resp)
+		return fmt.Errorf("create comment failed: %v", resp.Body)
+	}
+
+	log.Infof("create comment success: %v", c)
+
+	return nil
+}
+
+func checkCommitMessage(commits []*github.RepositoryCommit) string {
+	pattern := `^Merge (.*) into (.*)$`
+	reg := regexp.MustCompile(pattern)
+
+	for _, commit := range commits {
+		if commit.Commit != nil && commit.Commit.Message != nil {
+			if reg.MatchString(*commit.Commit.Message) {
+				return "please rebase your PR"
+			}
+		}
+	}
+
+	return ""
+}

linters/staticcheck/staticcheck.go → internal/linters/go/staticcheck/staticcheck.go

@@ -1,18 +1,19 @@
 /*
-Copyright 2023 Qiniu Cloud (qiniu.com).
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+ Copyright 2024 Qiniu Cloud (qiniu.com).
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
 */
+
 package staticcheck
 
 import (
@@ -23,15 +24,18 @@ import (
 	"strings"
 
 	"github.com/cr-bot/config"
-	"github.com/cr-bot/linters"
+	"github.com/cr-bot/internal/linters"
+	"github.com/google/go-github/v57/github"
 	"github.com/qiniu/x/log"
 )
 
+var lintName = "staticcheck"
+
 func init() {
-	linters.RegisterLinter("staticcheck", staticcheckHandler)
+	linters.RegisterCodeReviewHandler(lintName, staticcheckHandler)
 }
 
-func staticcheckHandler(linterConfig config.Linter) (map[string][]linters.LinterOutput, error) {
+func staticcheckHandler(linterConfig config.Linter, agent linters.Agent, event github.PullRequestEvent) (map[string][]linters.LinterOutput, error) {
 	executor, err := NewStaticcheckExecutor(linterConfig.WorkDir)
 	if err != nil {
 		return nil, err

linters/staticcheck/staticcheck_test.go → internal/linters/go/staticcheck/staticcheck_test.go

@@ -1,9 +1,25 @@
+/*
+ Copyright 2024 Qiniu Cloud (qiniu.com).
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+*/
+
 package staticcheck
 
 import (
 	"testing"
 
-	"github.com/cr-bot/linters"
+	"github.com/cr-bot/internal/linters"
 )
 
 func TestFormatStaticcheckLine(t *testing.T) {