feat: posting comments

.github/workflows/test.yml

@@ -62,7 +62,7 @@ jobs:
 
       - name: check test coverage
         id: coverage
-        uses: vladopajic/go-test-coverage@v2
+        uses: dmitriitimoshenko/go-test-coverage@v2
         continue-on-error: true # Should fail after coverage comment is posted
         with:
           config: ./.github/.testcoverage.yml

pkg/testcoverage/check.go

@@ -3,8 +3,10 @@ package testcoverage
 import (
 	"bufio"
 	"bytes"
+	"encoding/json"
 	"fmt"
 	"io"
+	"net/http"
 	"os"
 	"strings"
 
@@ -55,6 +57,14 @@ func Check(w io.Writer, cfg Config) bool {
 		return false
 	}
 
+	// New: post coverage comment to PR if enabled.
+	if cfg.PostCoverageComment {
+		if err := postPRComment(w, cfg, result, report); err != nil {
+			fmt.Fprintf(w, "failed to post PR comment: %v\n", err)
+			// do not fail the check due to comment-posting issues
+		}
+	}
+
 	return result.Pass()
 }
 
@@ -139,3 +149,77 @@ func loadBaseCoverageBreakdown(cfg Config) ([]coverage.Stats, error) {
 
 	return stats, nil
 }
+
+// New helper function to post a comment to the PR using GitHub API.
+func postPRComment(w io.Writer, cfg Config, result AnalyzeResult, report string) error {
+	// Expecting a GitHub token in the environment.
+	token := os.Getenv("GITHUB_TOKEN")
+	if token == "" {
+		return fmt.Errorf("GITHUB_TOKEN not set")
+	}
+
+	// Read the event payload to extract the PR number.
+	eventPath := os.Getenv("GITHUB_EVENT_PATH")
+	if eventPath == "" {
+		// Not running in GitHub Actions or no event payload available.
+		return nil
+	}
+	data, err := os.ReadFile(eventPath)
+	if err != nil {
+		return fmt.Errorf("failed reading GITHUB_EVENT_PATH: %w", err)
+	}
+	// Define a minimal structure to get the pull_request number.
+	var event struct {
+		PullRequest struct {
+			Number int `json:"number"`
+		} `json:"pull_request"`
+	}
+	if err := json.Unmarshal(data, &event); err != nil {
+		return fmt.Errorf("failed parsing event payload: %w", err)
+	}
+	if event.PullRequest.Number == 0 {
+		// Not a pull request event.
+		return nil
+	}
+
+	// Get repository information from environment.
+	repoStr := os.Getenv("GITHUB_REPOSITORY") // format: owner/repo
+	if repoStr == "" {
+		return fmt.Errorf("GITHUB_REPOSITORY not set")
+	}
+	parts := strings.Split(repoStr, "/")
+	if len(parts) != 2 {
+		return fmt.Errorf("GITHUB_REPOSITORY formatted invalidly")
+	}
+	owner, repoName := parts[0], parts[1]
+	commentURL := fmt.Sprintf("https://api.github.com/repos/%s/%s/issues/%d/comments", owner, repoName, event.PullRequest.Number)
+
+	// Construct the comment body.
+	commentBody := fmt.Sprintf("Coverage Report:\n```\n%s\n```", report)
+	payload, err := json.Marshal(map[string]string{
+		"body": commentBody,
+	})
+	if err != nil {
+		return fmt.Errorf("failed marshaling payload: %w", err)
+	}
+
+	req, err := http.NewRequest("POST", commentURL, bytes.NewBuffer(payload))
+	if err != nil {
+		return fmt.Errorf("failed creating request: %w", err)
+	}
+	req.Header.Set("Authorization", "token "+token)
+	req.Header.Set("Content-Type", "application/json")
+
+	client := &http.Client{}
+	resp, err := client.Do(req)
+	if err != nil {
+		return fmt.Errorf("failed executing request: %w", err)
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusCreated {
+		respBody, _ := io.ReadAll(resp.Body)
+		return fmt.Errorf("failed to post comment, status: %d, response: %s", resp.StatusCode, string(respBody))
+	}
+	return nil
+}

pkg/testcoverage/config.go

@@ -32,6 +32,7 @@ type Config struct {
 	GithubActionOutput    bool       `yaml:"github-action-output"`
 	Diff                  Diff       `yaml:"diff"`
 	Badge                 Badge      `yaml:"-"`
+	PostCoverageComment   bool       `yaml:"post-coverage-comment"`
 }
 
 type Threshold struct {