Skip to content

Commit

Permalink
Minor updates
Browse files Browse the repository at this point in the history
  • Loading branch information
iamazeem committed Oct 11, 2024
1 parent 5e23556 commit 7db8fb7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/setup-action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ jobs:
- name: Set up
id: setup
uses: ./setup-action
with:
version: '0.3.9-alpha'

- name: Check output parameter [install-path]
run: echo '${{ steps.setup.outputs.install-path }}'
Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,17 +235,15 @@ baseline for your own use cases as needed.

#### GitHub Actions

In a GitHub Actions workflow, you can use `zsv/setup-action` to install
zsv+zsvlib:
In a GitHub Actions workflow, you can use [`zsv/setup-action`](./setup-action)
to set up zsv+zsvlib:

```yml
- name: Set up zsv+zsvlib
uses: liquidaty/zsv/setup-action@main
with:
version: 'version'
```
See [zsv/setup-action](./setup-action) for more details.
See [zsv/setup-action/README](./setup-action/README.md) for more details.
### From source
Expand Down
18 changes: 12 additions & 6 deletions setup-action/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Supports Linux, macOS, and Windows runners.

### Inputs

| Output | Description |
| :-------: | :------------------------- |
| `version` | Version/tag of the release |
| Input | Required | Default | Description |
| :-------: | :------- |
| `version` | `false` | `latest` | Version/tag of the release |

### Outputs

Expand All @@ -28,12 +28,18 @@ Under the installation directory, the subdirectories will include:

### Example

Set up the latest version:

```yml
- name: Set up zsv+zsvlib
uses: liquidaty/zsv/setup-action@main
```
Set up a specific version:
```yml
- name: Set up zsv+zsvlib
uses: liquidaty/zsv/setup-action@main
with:
version: '0.3.9-alpha'

- name: Check version
run: zsv version
```

0 comments on commit 7db8fb7

Please sign in to comment.