Updated CLI usage docs with coverage-files flag

buildpulse · Jul 28, 2023 · 1e23f9d · 1e23f9d
1 parent c859735
commit 1e23f9d
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/cmd/test-reporter/main.go b/cmd/test-reporter/main.go
@@ -29,6 +29,7 @@ FLAGS
   --repository-id   (required) BuildPulse repository ID for the repository that produced the test results
   --repository-dir  Path to local git clone of the repository (default: ".")
   --tree            SHA-1 hash of the git tree that produced the test results (for use only if a local git clone does not exist)
+  --coverage-files  Paths to coverage files or directories containing coverage files (space-separated)
 
 ENVIRONMENT VARIABLES
 	Set the following environment variables:
@@ -38,7 +39,7 @@ ENVIRONMENT VARIABLES
 	BUILDPULSE_SECRET_ACCESS_KEY  BuildPulse secret access key for the account that owns the repository
 
 EXAMPLE
-	$ %s submit test/reports/*.xml --account-id 42 --repository-id 8675309
+	$ %s submit test/reports/*.xml --account-id 42 --repository-id 8675309 --coverage-files coverage/coverage.xml coverage/coverage2.xml
 `, "\t", "  ")
 
 func main() {

diff --git a/go.mod b/go.mod
@@ -11,8 +11,8 @@ require (
 	github.com/mholt/archiver/v3 v3.5.1
 	github.com/otiai10/copy v1.9.0
 	github.com/stretchr/testify v1.8.2
+	github.com/yargevad/filepathx v1.0.0
 	gopkg.in/yaml.v3 v3.0.1
-	github.com/yargevad/filepathx	v1.0.0
 )
 
 require (

diff --git a/internal/cmd/submit/submit.go b/internal/cmd/submit/submit.go
@@ -94,7 +94,7 @@ func NewSubmit(version *metadata.Version, log logger.Logger) *Submit {
 	s.fs.Uint64Var(&s.repositoryID, "repository-id", 0, "BuildPulse repository ID (required)")
 	s.fs.StringVar(&s.repositoryPath, "repository-dir", ".", "Path to local clone of repository")
 	s.fs.StringVar(&s.tree, "tree", "", "SHA-1 hash of git tree")
-	s.fs.StringVar(&s.coveragePathsString, "coverage-files", "", "Paths to coverage files or directories containing coverage files")
+	s.fs.StringVar(&s.coveragePathsString, "coverage-files", "", "Paths to coverage files or directories containing coverage files (space-separated)")
 	s.fs.SetOutput(io.Discard) // Disable automatic writing to STDERR
 
 	s.logger.Printf("Current version: %s", s.version.String())