Skip to content

Commit ffd1649

Browse files
put quotes on readme version examples (#203)
* put quotes on readme version examples * Update README.md
1 parent f3d4142 commit ffd1649

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ steps:
8989
- uses: actions/[email protected]
9090
- uses: julia-actions/setup-julia@v1
9191
with:
92-
version: 1.0.4
92+
version: '1.10'
9393
- run: julia -e 'println("Hello, World!")'
9494
```
9595
@@ -103,22 +103,22 @@ You can either specify specific Julia versions or version ranges. If you specify
103103

104104
#### Examples
105105

106-
- `1.2.0` is a valid semver version. The action will try to download exactly this version. If it's not available, the build step will fail.
107-
- `1.0` is a version range that will match the highest available Julia version that starts with `1.0`, e.g. `1.0.5`, excluding pre-releases.
108-
- `^1.3.0-rc1` is a **caret** version range that includes pre-releases of `1.3.0` starting at `rc1`. It matches all versions `≥ 1.3.0-rc1` and `< 2.0.0`.
109-
- `~1.3.0-rc1` is a **tilde** version range that includes pre-releases of `1.3.0` starting at `rc1`. It matches all versions `≥ 1.3.0-rc1` and `< 1.4.0`.
110-
- `^1.3.0-0` is a **caret** version range that includes _all_ pre-releases of `1.3.0`. It matches all versions `≥ 1.3.0-` and `< 2.0.0`.
111-
- `~1.3.0-0` is a **tilde** version range that includes _all_ pre-releases of `1.3.0`. It matches all versions `≥ 1.3.0-` and `< 1.4.0`.
112-
- `nightly` will install the latest nightly build.
113-
- `1.7-nightly` will install the latest nightly build for the upcoming 1.7 release. This version will only be available during certain phases of the Julia release cycle.
106+
- `'1.2.0'` is a valid semver version. The action will try to download exactly this version. If it's not available, the build step will fail.
107+
- `'1.0'` is a version range that will match the highest available Julia version that starts with `1.0`, e.g. `1.0.5`, excluding pre-releases.
108+
- `'^1.3.0-rc1'` is a **caret** version range that includes pre-releases of `1.3.0` starting at `rc1`. It matches all versions `≥ 1.3.0-rc1` and `< 2.0.0`.
109+
- `'~1.3.0-rc1'` is a **tilde** version range that includes pre-releases of `1.3.0` starting at `rc1`. It matches all versions `≥ 1.3.0-rc1` and `< 1.4.0`.
110+
- `'^1.3.0-0'` is a **caret** version range that includes _all_ pre-releases of `1.3.0`. It matches all versions `≥ 1.3.0-` and `< 2.0.0`.
111+
- `'~1.3.0-0'` is a **tilde** version range that includes _all_ pre-releases of `1.3.0`. It matches all versions `≥ 1.3.0-` and `< 1.4.0`.
112+
- `'nightly'` will install the latest nightly build.
113+
- `'1.7-nightly'` will install the latest nightly build for the upcoming 1.7 release. This version will only be available during certain phases of the Julia release cycle.
114114

115115
Internally the action uses node's semver package to resolve version ranges. Its [documentation](https://github.com/npm/node-semver#advanced-range-syntax) contains more details on the version range syntax. You can test what version will be selected for a given input in this JavaScript [REPL](https://repl.it/@SaschaMann/setup-julia-version-logic).
116116

117117
#### Prereleases
118118

119119
There are two methods of including pre-releases in version matching:
120120

121-
1. Including the pre-release tag in the version itself, e.g. `^1.3.0-rc1`.
121+
1. Including the pre-release tag in the version itself, e.g. `'^1.3.0-rc1'`.
122122
2. Setting the input `include-all-prereleases` to `true`.
123123

124124
These behave slightly differently.

0 commit comments

Comments
 (0)