Skip to content

Commit c3097e8

Browse files
committed
Language improvements
And make sure options are ordered in the same way in `README.md` and `action.yaml`.
1 parent a84973a commit c3097e8

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,56 @@
22

33
A GitHub action for using the latest released Go version and your
44
projects minimal support Go version (from go.mod), and a build matrix
5-
of them and all versions in between.
5+
of them, and all versions in between.
66

77
## Motive
88

99
Being consistent is hard.
1010

11-
I used to hard code the Go versions my projects needed for test and
11+
I used to hard-code the Go versions my projects needed for test and
1212
builds in my GitHub Actions workflow files.
1313

14-
Of course the result was that I used different versions in the
14+
Of course, the result was that I used different versions in the
1515
`go.mod` file and my workflow files.
1616

17-
Whenever a new version of Go was released I forgot to add the new
17+
Whenever a new version of Go was released, I forgot to add the new
1818
version to my build matrix and my projects weren't tested on the new
1919
release(s).
2020

21-
So I build this action.
21+
So, I build this action.
2222

2323
The action reads the minimal supported Go version from your `go.mod`
24-
file and exposes it as a variable to you workflow.
24+
file and exposes it as a variable to your workflow.
2525

2626
It also pulls the list of release tags from
2727
[https://go.dev/dl/](https://go.dev/dl/) and exposes the latest
2828
released Go version as a variable as well.
2929

30-
From the list of released Go versions and the minimal version your
30+
From the list of released Go versions and the minimal version, your
3131
module supports we also build a "matrix" variable to be used as a
3232
build matrix.
3333

34-
While we are at it we also extract the module path from the `go.mod`
35-
file even though it hasn't really anything to do with versions ;)
34+
While we are at it, we also extract the module path from the `go.mod`
35+
file, even though it hasn't really anything to do with versions ;)
3636

3737
## Inputs
3838

39-
If your `go mod` file is located in a non standard location you can
39+
If your `go mod` file is located in a non-standard location, you can
4040
specify the working directory where it is located:
4141

4242
```yaml
4343
working-directory:
44-
description: Working directory where you go.mod file is located
44+
description: Working directory where your go.mod file is located
4545
required: false
4646
default: .
47-
unsupported:
48-
description: Include unsupported versions of Go
49-
required: false
50-
default: 'true'
5147
unstable:
5248
description: Include unstable versions of Go (beta, release candidates)
5349
required: false
5450
default: 'false'
51+
unsupported:
52+
description: Include unsupported versions of Go
53+
required: false
54+
default: 'true'
5555
patch-level:
5656
description: Include the patch levels on the versions (default is major.minor)
5757
required: false
@@ -61,22 +61,22 @@ patch-level:
6161
## Outputs
6262
6363
```yaml
64-
module:
65-
description: The Go module path (as specified by go.mod)
6664
go-mod-version:
6765
description: The Go version specified by go.mod
66+
latest:
67+
description: The latest Go version
6868
minimal:
6969
description: The minimal Go version
7070
matrix:
71-
description: An (stringified) array of Go versions from the minimal supported version to the latest released version
72-
latest:
73-
description: The latest Go version
71+
description: A (stringified) array of Go versions from the minimal supported version to the latest released version
72+
module:
73+
description: The Go module path (as specified by go.mod)
7474
```
7575
7676
## Examples
7777
7878
Let's say your `go.mod` specifies Go 1.13 as the minimal supported
79-
version and you want your workflow to setup Go version 1.13 using the
79+
version and you want your workflow to set up Go version 1.13 using the
8080
[actions/setup-go](https://github.com/actions/setup-go) action:
8181

8282
```yaml

action.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,32 +5,32 @@ branding:
55
color: blue
66
inputs:
77
working-directory:
8-
description: Working direcory
8+
description: Working directory where your go.mod file is located
99
required: false
1010
default: .
1111
unstable:
12-
description: With unstable versions
12+
description: Include unstable versions of Go (beta, release candidates)
1313
required: false
1414
default: 'false'
1515
unsupported:
16-
description: With no longer supported versions
16+
description: Include unsupported versions of Go
1717
required: false
1818
default: 'true'
1919
patch-level:
20-
description: With patch level of the versions
20+
description: Include the patch levels on the versions (default is major.minor)
2121
required: false
2222
default: 'false'
2323
outputs:
2424
go-mod-version:
25-
description: The minial go version (as specified by go.mod)
25+
description: The Go version specified by go.mod
2626
latest:
27-
description: The latest go version
27+
description: The latest Go version
2828
minimal:
29-
description: The minial go version
29+
description: The minimal Go version
3030
matrix:
31-
description: An (stringified) array of go versions from the minimal supported version to the latest released version
31+
description: A (stringified) array of Go versions from the minimal supported version to the latest released version
3232
module:
33-
description: The go module path (as specified by go.mod)
33+
description: The Go module path (as specified by go.mod)
3434
runs:
3535
using: node16
3636
main: dist/index.js

0 commit comments

Comments
 (0)