Include comparison sha/branch in descriptions

Author: davegaeddert

cmd/commitstat/main.go

@@ -88,7 +88,7 @@ var rootCmd = &cobra.Command{
 				fmt.Printf("No comparison stat found on %s\n", comparisonRef)
 			}
 
-			status, err := status.NewStatus(stat, comparisonStat, goal)
+			status, err := status.NewStatus(stat, comparisonStat, comparisonRef, goal)
 			if err != nil {
 				printErrAndExitFailure(err)
 			}

internal/github/events.go

@@ -35,11 +35,11 @@ func NewGitHubPushEvent(path string) *githubPushEvent {
 }
 
 func (event *githubPushEvent) GetComparisonRef() string {
-	defaultRef := "refs/heads/" + event.Repository.DefaultBranch
-	if event.Ref == defaultRef {
+	if event.Ref == "refs/heads/"+event.Repository.DefaultBranch {
 		// This is a push to master/main, so compare stat to previous commit sha
-		return event.Before
+		// (shorten for readability)
+		return event.Before[:7]
 	}
 	// Compare to latest on the default branch
-	return defaultRef
+	return event.Repository.DefaultBranch
 }

internal/status/main.go

@@ -16,32 +16,26 @@ const (
 )
 
 type Status struct {
-	Stat           string
-	ComparisonStat string
-	Goal           string
-	State          state
-	Description    string
+	State       state
+	Description string
 }
 
-func NewStatus(stat, comparisonStat, goal string) (*Status, error) {
-	state, description, err := compareStats(stat, comparisonStat, goal)
+func NewStatus(stat, comparisonStat, comparisonRef, goal string) (*Status, error) {
+	state, description, err := compareStats(stat, comparisonStat, comparisonRef, goal)
 	if err != nil {
 		return nil, err
 	}
 	return &Status{
-		Stat:           stat,
-		ComparisonStat: comparisonStat,
-		Goal:           goal,
-		State:          state,
-		Description:    description,
+		State:       state,
+		Description: description,
 	}, nil
 }
 
-func compareStats(stat, comparisonStat, goal string) (state, string, error) {
+func compareStats(stat, comparisonStat, comparisonRef, goal string) (state, string, error) {
 	// IMPORTANT: the current stat needs to be the first thing in the description
 	// because that's how we will parse it back off
 	if comparisonStat == "" {
-		return stateError, fmt.Sprintf("%s - nothing to compare to (stat is either new or being processed simultaneously)", stat), nil
+		return stateError, fmt.Sprintf("%s - nothing to compare on %s (stat is either new or being processed simultaneously)", comparisonRef, stat), nil
 	}
 
 	statNum, err := parse.ParseStatNumber(stat)
@@ -51,24 +45,24 @@ func compareStats(stat, comparisonStat, goal string) (state, string, error) {
 
 	prevStatNum, err := parse.ParseStatNumber(comparisonStat)
 	if err != nil {
-		return stateError, "unable to parse comparison stat", err
+		return stateError, fmt.Sprintf("unable to parse comparison stat from %s", comparisonRef), err
 	}
 
 	if goal == "decrease" {
 		if statNum < prevStatNum {
-			return stateSuccess, fmt.Sprintf("%s - less than %s", stat, comparisonStat), nil
+			return stateSuccess, fmt.Sprintf("%s - less than %s (%s)", stat, comparisonStat, comparisonRef), nil
 		} else if statNum == prevStatNum {
-			return stateSuccess, fmt.Sprintf("%s - no change", stat), nil
+			return stateSuccess, fmt.Sprintf("%s - no change compared to %s", stat, comparisonRef), nil
 		} else {
-			return stateFailure, fmt.Sprintf("%s - more than %s", stat, comparisonStat), nil
+			return stateFailure, fmt.Sprintf("%s - more than %s (%s)", stat, comparisonStat, comparisonRef), nil
 		}
 	} else if goal == "increase" {
 		if statNum > prevStatNum {
-			return stateSuccess, fmt.Sprintf("%s - more than %s", stat, comparisonStat), nil
+			return stateSuccess, fmt.Sprintf("%s - more than %s (%s)", stat, comparisonStat, comparisonRef), nil
 		} else if statNum == prevStatNum {
-			return stateSuccess, fmt.Sprintf("%s - no change", stat), nil
+			return stateSuccess, fmt.Sprintf("%s - no change compared to %s", stat, comparisonRef), nil
 		} else {
-			return stateFailure, fmt.Sprintf("%s - less than %s", stat, comparisonStat), nil
+			return stateFailure, fmt.Sprintf("%s - less than %s (%s)", stat, comparisonStat, comparisonRef), nil
 		}
 	} else {
 		return stateError, "unknown goal", errors.New("unknown goal")