update docs

Author: vladopajic

.testcoverage.example.yml

@@ -41,11 +41,31 @@ exclude:
     - \.pb\.go$    # excludes all protobuf generated files
     - ^pkg/bar     # exclude package `pkg/bar`
 
-# File name of go-test-coverage breakdown file, which can be used to 
-# analyze coverage difference.
+# If specified, saves the current test coverage breakdown to this file.
+#
+# Typically, this breakdown is generated only for main (base) branches and 
+# stored as an artifact. Later, this file can be used in feature branches 
+# to compare test coverage against the base branch.
 breakdown-file-name: ''
 
 diff:
-  # File name of go-test-coverage breakdown file which will be used to 
-  # report coverage difference.
-  base-breakdown-file-name: ''
+  # Path to the test coverage breakdown file from the base branch.
+  #
+  # This file is usually generated and stored in the main (base) branch,
+  # controled via `breakdown-file-name` property.
+  # When set in a feature branch, it allows the tool to compute and report 
+  # the coverage difference between the current (feature) branch and the base.
+  base-breakdown-file-name: ''
+
+  # Allowed threshold for the test coverage difference (in percentage) 
+  # between the feature branch and the base branch.
+  #
+  # By default, this is disabled (set to nil). Valid values range from 
+  # -100.0 to +100.0.
+  #
+  # Example: 
+  #   If set to 0.5, an error will be reported if the feature branch has 
+  #   less than 0.5% more coverage than the base.
+  #
+  #   If set to -0.5, the check allows up to 0.5% less coverage than the base.
+  threshold: nil

README.md

@@ -125,14 +125,34 @@ exclude:
     - \.pb\.go$    # excludes all protobuf generated files
     - ^pkg/bar     # exclude package `pkg/bar`
 
-# File name of go-test-coverage breakdown file, which can be used to 
-# analyze coverage difference.
+# If specified, saves the current test coverage breakdown to this file.
+#
+# Typically, this breakdown is generated only for main (base) branches and 
+# stored as an artifact. Later, this file can be used in feature branches 
+# to compare test coverage against the base branch.
 breakdown-file-name: ''
 
 diff:
-  # File name of go-test-coverage breakdown file which will be used to 
-  # report coverage difference.
+  # Path to the test coverage breakdown file from the base branch.
+  #
+  # This file is usually generated and stored in the main (base) branch,
+  # controled via `breakdown-file-name` property.
+  # When set in a feature branch, it allows the tool to compute and report 
+  # the coverage difference between the current (feature) branch and the base.
   base-breakdown-file-name: ''
+
+  # Allowed threshold for the test coverage difference (in percentage) 
+  # between the feature branch and the base branch.
+  #
+  # By default, this is disabled (set to nil). Valid values range from 
+  # -100.0 to +100.0.
+  #
+  # Example: 
+  #   If set to 0.5, an error will be reported if the feature branch has 
+  #   less than 0.5% more coverage than the base.
+  #
+  #   If set to -0.5, the check allows up to 0.5% less coverage than the base.
+  threshold: nil
 ```
 
 ### Exclude Code from Coverage

pkg/testcoverage/config.go

@@ -54,7 +54,7 @@ type Exclude struct {
 
 type Diff struct {
 	BaseBreakdownFileName string   `yaml:"base-breakdown-file-name"`
-	Threshold             *float64 `yaml:"threshold"`
+	Threshold             *float64 `yaml:"threshold,omitempty"`
 }
 
 type Badge struct {

pkg/testcoverage/config_test.go

@@ -240,7 +240,7 @@ func nonZeroConfig() Config {
 		BreakdownFileName: "breakdown.testcoverage",
 		Diff: Diff{
 			BaseBreakdownFileName: "breakdown.testcoverage",
-			Threshold:             ptr(-1.1),
+			Threshold:             ptr(-1.01),
 		},
 		GithubActionOutput: true,
 	}
@@ -263,7 +263,7 @@ exclude:
 breakdown-file-name: 'breakdown.testcoverage'
 diff:
   base-breakdown-file-name: 'breakdown.testcoverage'
-  threshold: -1.1	
+  threshold: -1.01
 github-action-output: true`
 }