diff --git a/README.md b/README.md index 4f276b8..da29363 100644 --- a/README.md +++ b/README.md @@ -4,79 +4,46 @@ Set up your GitHub Actions workflow with a specific version of Deno. ## Usage -### Latest stable for a major +The installed version is `v2.x` by default. ```yaml - uses: denoland/setup-deno@v2 - with: - deno-version: v2.x -``` - -### Latest stable for any major - -Targets the latest major, minor and patch version of Deno. - -```yaml -- uses: denoland/setup-deno@v2 - with: - deno-version: vx.x.x -``` - -### Specific stable - -```yaml -- uses: denoland/setup-deno@v2 - with: - deno-version: "1.8.2" -``` - -### Semver range - -```yaml -- uses: denoland/setup-deno@v2 - with: - deno-version: "~1.7" ``` -### Latest canary +### Version from input -```yaml -- uses: denoland/setup-deno@v2 - with: - deno-version: canary -``` +To pick the latest version of specific release channel, set `deno-version` to +one of the following: -### Specific canary +| Channel | Description | +| -------- | -------------------------------- | +| `stable` | Latest Stable release version | +| `lts` | Latest Long-Term-Support version | +| `rc` | Latest Release-Candidate version | +| `canary` | Latest Canary release version | ```yaml - uses: denoland/setup-deno@v2 with: - deno-version: e7b7129b7a92b7500ded88f8f5baa25a7f59e56e + deno-version: lts ``` -### Latest release candidate +A version can also be selected by providing a valid [Semver][sv] range or commit +hash. -```yaml -- uses: denoland/setup-deno@v2 - with: - deno-version: rc -``` +**Examples** -### Specific release candidate +- Specific versions: `"1.8.2"`, `2.0.0-rc.1` +- Semver range: `"^2"`, `"~1.7"`, `v2.1.x`, `vx.x.x` +- Commit hash: `e7b7129b7a92b7500ded88f8f5baa25a7f59e56e` ```yaml - uses: denoland/setup-deno@v2 with: - deno-version: 2.0.0-rc.1 + deno-version: v2.1.x ``` -### Latest LTS - -```yaml -- uses: denoland/setup-deno@v2 - with: - deno-version: lts -``` +[sv]: https://devhints.io/semver ### Version from file