Use strings in README, add notice about versions as strings

0e4061c · Jonathan Clem · 2020-05-17 15:01

1 files +10 -6

Files changed

modified README.md
+10 −6
@@ -21,6 +21,10 @@ For best results, we recommend specifying exact OTP and Elixir versions.
21 21 However, values like `22.x` are also accepted, and we attempt to resolve them
22 22 according to semantic versioning rules.
23 23
24 +Additionally, it is recommended that one specifies OTP and Elixir versions
25 +using YAML strings, as these examples do, so that numbers like `23.0` don't
26 +end up being parsed as `23`, which is not equivalent.
27 +
24 28 ### Basic example
25 29
26 30 ```yaml
@@ -33,8 +37,8 @@ jobs:
33 37 - uses: actions/checkout@v2
34 38 - uses: actions/setup-elixir@v1
35 39 with:
36 otp-version: 22.2
37 elixir-version: 1.9.4
40 + otp-version: '22.2'
41 + elixir-version: '1.9.4'
38 42 - run: mix deps.get
39 43 - run: mix test
40 44 ```
@@ -50,8 +54,8 @@ jobs:
50 54 name: OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
51 55 strategy:
52 56 matrix:
53 otp: [20.3, 21.3, 22.2]
54 elixir: [1.8.2, 1.9.4]
57 + otp: ['20.3', '21.3', '22.2']
58 + elixir: ['1.8.2', '1.9.4']
55 59 steps:
56 60 - uses: actions/checkout@v2
57 61 - uses: actions/setup-elixir@v1
@@ -87,8 +91,8 @@ jobs:
87 91 - uses: actions/checkout@v2
88 92 - uses: actions/setup-elixir@v1
89 93 with:
90 otp-version: 22.2
91 elixir-version: 1.9.4
94 + otp-version: '22.2'
95 + elixir-version: '1.9.4'
92 96 - run: mix deps.get
93 97 - run: mix test
94 98 ```

Parents: 2229635