Skip to content

Commit bdaa2e4

Browse files
authored
docs: condense Deno version information in one section (denoland#100)
1 parent e4ff81c commit bdaa2e4

File tree

1 file changed

+19
-52
lines changed

1 file changed

+19
-52
lines changed

README.md

Lines changed: 19 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4,79 +4,46 @@ Set up your GitHub Actions workflow with a specific version of Deno.
44

55
## Usage
66

7-
### Latest stable for a major
7+
The installed version is `v2.x` by default.
88

99
```yaml
1010
- uses: denoland/setup-deno@v2
11-
with:
12-
deno-version: v2.x
13-
```
14-
15-
### Latest stable for any major
16-
17-
Targets the latest major, minor and patch version of Deno.
18-
19-
```yaml
20-
- uses: denoland/setup-deno@v2
21-
with:
22-
deno-version: vx.x.x
23-
```
24-
25-
### Specific stable
26-
27-
```yaml
28-
- uses: denoland/setup-deno@v2
29-
with:
30-
deno-version: "1.8.2"
31-
```
32-
33-
### Semver range
34-
35-
```yaml
36-
- uses: denoland/setup-deno@v2
37-
with:
38-
deno-version: "~1.7"
3911
```
4012
41-
### Latest canary
13+
### Version from input
4214
43-
```yaml
44-
- uses: denoland/setup-deno@v2
45-
with:
46-
deno-version: canary
47-
```
15+
To pick the latest version of specific release channel, set `deno-version` to
16+
one of the following:
4817

49-
### Specific canary
18+
| Channel | Description |
19+
| -------- | -------------------------------- |
20+
| `stable` | Latest Stable release version |
21+
| `lts` | Latest Long-Term-Support version |
22+
| `rc` | Latest Release-Candidate version |
23+
| `canary` | Latest Canary release version |
5024

5125
```yaml
5226
- uses: denoland/setup-deno@v2
5327
with:
54-
deno-version: e7b7129b7a92b7500ded88f8f5baa25a7f59e56e
28+
deno-version: lts
5529
```
5630

57-
### Latest release candidate
31+
A version can also be selected by providing a valid [Semver][sv] range or commit
32+
hash.
5833

59-
```yaml
60-
- uses: denoland/setup-deno@v2
61-
with:
62-
deno-version: rc
63-
```
34+
**Examples**
6435

65-
### Specific release candidate
36+
- Specific versions: `"1.8.2"`, `2.0.0-rc.1`
37+
- Semver range: `"^2"`, `"~1.7"`, `v2.1.x`, `vx.x.x`
38+
- Commit hash: `e7b7129b7a92b7500ded88f8f5baa25a7f59e56e`
6639

6740
```yaml
6841
- uses: denoland/setup-deno@v2
6942
with:
70-
deno-version: 2.0.0-rc.1
43+
deno-version: v2.1.x
7144
```
7245

73-
### Latest LTS
74-
75-
```yaml
76-
- uses: denoland/setup-deno@v2
77-
with:
78-
deno-version: lts
79-
```
46+
[sv]: https://devhints.io/semver
8047

8148
### Version from file
8249

0 commit comments

Comments
 (0)