(feat) reduce freq of PR comments (#23)

Author: kevincobain2000

README.md

@@ -178,6 +178,14 @@ Before using this action, enable Github Actions
     - uses: kevincobain2000/action-coveritup@v2
       with:
         pr_comment: true
+        # optional
+        ## report only these types on PR comment, empty means all
+        types: coverage,go-sec-issues,go-lint-errors
+        # optional
+        ## report only these types after 1st comment
+        # 1st comment will have all types or types specified in `types`
+        # 2nd comment onwards will have only these types
+        diff_types: coverage
 ```
 
 ## Time taken

action.yml

@@ -13,6 +13,8 @@ inputs:
     description: "Type of score"
   types:
     description: "Types to report on PR comment. If empty then it will report all types"
+  diff_types:
+    description: "Only types to report on PR comment after 1st comment. 1st comment will have all types"
   metric:
     description: "Metric of score"
   command:
@@ -154,7 +156,7 @@ runs:
           -x "${{ env.COVERITUP_HTTP_PROXY }}" \
           -H 'Content-Type: application/json' \
           -w "%{http_code}" \
-          "${{env.COVERITUP_HOST}}/pr?org=${{github.repository_owner}}&repo=${{ github.event.repository.name }}&types=${{ inputs.types }}&theme=${{ inputs.theme }}&pr_num=${{ steps.pr-number-id.outputs.pr }}&branch=${{ env.BRANCH_OR_TAG_NAME }}&base_branch=${{ steps.branch-name.outputs.base_ref_branch }}" \
+          "${{env.COVERITUP_HOST}}/pr?org=${{github.repository_owner}}&repo=${{ github.event.repository.name }}&types=${{ inputs.types }}&diff_types=${{ inputs.diff_types }}&theme=${{ inputs.theme }}&pr_num=${{ steps.pr-number-id.outputs.pr }}&branch=${{ env.BRANCH_OR_TAG_NAME }}&base_branch=${{ steps.branch-name.outputs.base_ref_branch }}" \
           -o comment_body.txt)
         echo "PR_HTTP_RESPONSE=$response" >> $GITHUB_ENV
 

app/pkg/pr.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/fbiville/markdown-table-formatter/pkg/markdown"
 	"github.com/kevincobain2000/action-coveritup/models"
@@ -45,6 +46,17 @@ func (p *PR) Get(req *PRRequest, types []models.Type) (string, error) {
 	commitHistoryImgUrls := []string{} // stores urls for commit history trends (line charts)
 	userHistoryImgUrls := []string{}   // stores urls for user history trends (line charts)
 	mdText.H4("CoverItUp Report")
+	// if it is not first PR, then only report the types that are different from diff_types
+	if !isFirstPR && req.DiffTypes != "" {
+		onlyReportTypes := []models.Type{}
+		diffTypes := strings.Split(req.DiffTypes, ",")
+		for _, t := range types {
+			if Contains(diffTypes, t.Name) {
+				onlyReportTypes = append(onlyReportTypes, t)
+			}
+		}
+		types = onlyReportTypes
+	}
 
 	for _, t := range types {
 		y := make([]float64, 2)

app/pkg/pr_handler.go

@@ -26,6 +26,7 @@ type PRRequest struct {
 	PRNum      int    `json:"pr_num" query:"pr_num" validate:"required,numeric" message:"pr_num is required"`
 	Theme      string `json:"theme" query:"theme" default:"light" validate:"oneof=light dark" message:"theme must be light or dark"`
 	Types      string `json:"types" query:"types" validate:"ascii" message:"ascii types are required"`
+	DiffTypes  string `json:"diff_types" query:"diff_types" validate:"ascii" message:"ascii diff_types are required"`
 
 	host   string
 	scheme string

app/pkg/utils.go

@@ -82,3 +82,12 @@ func TrimStringFields(v interface{}) {
 		}
 	}
 }
+
+func Contains(slice []string, item string) bool {
+	for _, element := range slice {
+		if element == item {
+			return true
+		}
+	}
+	return false
+}