Make goal optional and show a success status if not defined

Author: davegaeddert

README.md

@@ -28,16 +28,18 @@ $ curl https://raw.githubusercontent.com/dropseed/commitstat/master/install.sh |
 
 ## Options
 
-### `--goal`
-
-Either "increase" or "decrease". This is the direction you *want* the stat to go. For example, test coverage should "increase" and if it actually decreases, then a failling status will be reported. If the stat is new or doesn't change, it is considered successful.
-
 ### `--name`
 
 The name of the stat.
 Will show up as `commitstat/{name}` when submitted as a GitHub commit status.
 Changing the name for an existing stat will break the pass/fail comparison until the new name shows up on your main/master branch.
 
+### `--goal` (optional)
+
+Either "increase" or "decrease". This is the direction you *want* the stat to go. For example, test coverage should "increase" and if it actually decreases, then a failling status will be reported. If the stat is new or doesn't change, it is considered successful.
+
+If you don't specify a goal, then you'll get a successful status and the stat/change will be purely informational.
+
 ### `--regex` (optional)
 
 A regular expression to parse the file/stdin for a specific value.

cmd/commitstat/main.go

@@ -107,10 +107,9 @@ var rootCmd = &cobra.Command{
 
 func init() {
 	rootCmd.Flags().StringVar(&regex, "regex", "", "regex to parse the stat (optional)")
+	rootCmd.Flags().StringVar(&goal, "goal", "", "goal for the stat (\"increase\" or \"decrease\", optional)")
 	rootCmd.Flags().StringVar(&statName, "name", "", "name for the stat")
 	rootCmd.MarkFlagRequired("name")
-	rootCmd.Flags().StringVar(&goal, "goal", "", "goal for the stat (\"increase\" or \"decrease\")")
-	rootCmd.MarkFlagRequired("goal")
 }
 
 func printErrAndExitFailure(err error) {

internal/status/main.go

@@ -53,26 +53,37 @@ func compareStats(stat, comparisonStat, comparisonRef, goal string) (state, stri
 		return stateError, fmt.Sprintf("Stats are not the same units: %s vs %s", statUnits, prevStatUnits), nil
 	}
 
+	description := ""
+
+	if statNum > prevStatNum {
+		diff := strings.TrimRight(fmt.Sprintf("%f", statNum-prevStatNum), ".0")
+		description = fmt.Sprintf("%s - increased by %s%s (%s on %s)", stat, diff, statUnits, comparisonStat, comparisonRef)
+	} else if statNum == prevStatNum {
+		description = fmt.Sprintf("%s - same as %s", stat, comparisonRef)
+	} else {
+		diff := strings.TrimRight(fmt.Sprintf("%f", prevStatNum-statNum), ".0")
+		description = fmt.Sprintf("%s - decreased by %s%s (%s on %s)", stat, diff, statUnits, comparisonStat, comparisonRef)
+	}
+
 	if goal == "decrease" {
 		if statNum < prevStatNum {
-			diff := strings.TrimRight(fmt.Sprintf("%f", prevStatNum-statNum), ".0")
-			return stateSuccess, fmt.Sprintf("%s - decreased by %s%s (%s on %s)", stat, diff, statUnits, comparisonStat, comparisonRef), nil
+			return stateSuccess, description, nil
 		} else if statNum == prevStatNum {
-			return stateSuccess, fmt.Sprintf("%s - same as %s", stat, comparisonRef), nil
+			return stateSuccess, description, nil
 		} else {
-			diff := strings.TrimRight(fmt.Sprintf("%f", statNum-prevStatNum), ".0")
-			return stateFailure, fmt.Sprintf("%s - increased by %s%s (%s on %s)", stat, diff, statUnits, comparisonStat, comparisonRef), nil
+			return stateFailure, description, nil
 		}
 	} else if goal == "increase" {
 		if statNum > prevStatNum {
-			diff := strings.TrimRight(fmt.Sprintf("%f", statNum-prevStatNum), ".0")
-			return stateSuccess, fmt.Sprintf("%s - increased by %s%s (%s on %s)", stat, diff, statUnits, comparisonStat, comparisonRef), nil
+			return stateSuccess, description, nil
 		} else if statNum == prevStatNum {
-			return stateSuccess, fmt.Sprintf("%s - same as %s", stat, comparisonRef), nil
+			return stateSuccess, description, nil
 		} else {
-			diff := strings.TrimRight(fmt.Sprintf("%f", prevStatNum-statNum), ".0")
-			return stateFailure, fmt.Sprintf("%s - decreased by %s%s (%s on %s)", stat, diff, statUnits, comparisonStat, comparisonRef), nil
+			return stateFailure, description, nil
 		}
+	} else if goal == "" {
+		// Always success if there was no stated goal
+		return stateSuccess, description, nil
 	} else {
 		return stateError, "unknown goal", errors.New("unknown goal")
 	}