docs: 📝 add behavior comment to GetAWSProfile function

JamesChung · Apr 9, 2023 · 55ae7f7 · 55ae7f7
1 parent 01a62ee
commit 55ae7f7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -153,5 +153,9 @@ func GetAWSProfile(cmd *cobra.Command) (string, error) {
 			),
 		), nil
 	}
+	// AWS will use the default profile if a profile is not specified. We will
+	// follow the same behavior when --aws-profile is not set and aws-profile is
+	// not specified in the cprl.yaml configuration file.
+	// https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html
 	return "default", nil
 }