refact: capitalize env variables to showup in documentation

Go doc doesn't shows internal functions, in order to be abble to document the needed env vars it's necessary to capitalize it. Signed-off-by: Lincoln Wallace <[email protected]>
canonical · Mar 27, 2024 · e86bb46 · e86bb46
1 parent ecc755f
commit e86bb46
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # Matter Snap Testing
 
+[![Go Reference](https://pkg.go.dev/badge/github.com/canonical/matter-snap-testing.svg)](https://pkg.go.dev/github.com/canonical/matter-snap-testing)
+
 Utility package for testing Matter snaps in Go.
 
 Test the testing utils:

diff --git a/env/env.go b/env/env.go
@@ -8,14 +8,14 @@ import (
 // Environment variables, used to override defaults
 const (
 	// Channel/Revision of the service snap (has default)
-	envSnapChannel = "SNAP_CHANNEL"
+	EnvSnapChannel = "SNAP_CHANNEL"
 
 	// Path to snap instead, used for testing a local snap instead of
 	// downloading from the store
-	envSnapPath = "SNAP_PATH"
+	EnvSnapPath = "SNAP_PATH"
 
 	// Toggle the teardown operations during tests (has default)
-	envTeardown = "TEARDOWN"
+	EnvTeardown = "TEARDOWN"
 )
 
 var (
@@ -47,15 +47,15 @@ func init() {
 // Read environment variables and perform type conversion/casting
 func loadEnvVars() {
 
-	if v := os.Getenv(envSnapChannel); v != "" {
+	if v := os.Getenv(EnvSnapChannel); v != "" {
 		snapChannel = v
 	}
 
-	if v := os.Getenv(envSnapPath); v != "" {
+	if v := os.Getenv(EnvSnapPath); v != "" {
 		snapPath = v
 	}
 
-	if v := os.Getenv(envTeardown); v != "" {
+	if v := os.Getenv(EnvTeardown); v != "" {
 		var err error
 		teardown, err = strconv.ParseBool(v)
 		if err != nil {