Skip to content

Commit ec3d077

Browse files
committed
docs: update README to reflect latest changes
1 parent 2fa35d8 commit ec3d077

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ and will install and expose a specified version of the `kosli` CLI on the runner
1111

1212
## Usage
1313

14-
Setup the `kosli` CLI:
14+
Setup the `kosli` CLI (installs the latest release by default):
1515

1616
```yaml
1717
steps:
@@ -25,15 +25,29 @@ steps:
2525
- name: setup-kosli-cli
2626
uses: kosli-dev/setup-cli-action@v3
2727
with:
28-
version:
29-
2.11.43
28+
version: 2.11.43
29+
```
30+
31+
To explicitly pin to the newest published release at runtime, pass `latest`:
32+
33+
```yaml
34+
steps:
35+
- name: setup-kosli-cli
36+
uses: kosli-dev/setup-cli-action@v3
37+
with:
38+
version: latest
3039
```
3140

3241
## Inputs
3342

34-
The actions supports the following inputs:
43+
The action supports the following inputs:
44+
45+
- `version`: The version of `kosli` to install. Accepts a semver (e.g. `2.11.43`) or the alias `latest`, which resolves to the newest GitHub release of `kosli-dev/cli` at runtime. Defaults to `latest`.
46+
- `github-token`: Token used to authenticate the GitHub API call that resolves `latest`. Defaults to `${{ github.token }}`; normally you do not need to set this.
47+
48+
## Outputs
3549

36-
- `version`: The version of `kosli` to install, defaulting to `2.11.43`
50+
- `version`: The resolved `kosli` CLI version that was installed. When `version: latest` is used, this will contain the concrete semver (e.g. `2.12.0`) and can be referenced by later steps via `steps.<id>.outputs.version`.
3751

3852
## Example job
3953
See [Kosli CLI documentation](https://docs.kosli.com/)

0 commit comments

Comments
 (0)