update go-version-file description

WillAbides · Aug 10, 2023 · 84bfb85 · 84bfb85
1 parent 012ce74
commit 84bfb85
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -104,7 +104,10 @@ For those who learn best from examples:
 
 ### go-version-file
 
-Path to the go.mod or go.work file.
+Path to a go.mod or go.work file. setup-go-faster will take the version from the "go" directive
+in this file and convert it to a semver minimum version. For example, if the go directive is `go 1.21rc1`,
+setup-go-faster will use the constraint `>= 1.21.0-rc1`.
+
 
 ### ignore-local
 

diff --git a/action.yml b/action.yml
@@ -42,7 +42,10 @@ inputs:
 
   go-version-file:
     required: false
-    description: 'Path to the go.mod or go.work file.'
+    description: |
+      Path to a go.mod or go.work file. setup-go-faster will take the version from the "go" directive
+      in this file and convert it to a semver minimum version. For example, if the go directive is `go 1.21rc1`,
+      setup-go-faster will use the constraint `>= 1.21.0-rc1`.
   ignore-local:
     required: false
     description: |