Skip to content

Commit

Permalink
Updated GitHub actions instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sujaya-sys committed Apr 16, 2024
1 parent dd6e296 commit 9a2c4e3
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions content/en/docs/How to/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can use any Score implementation CLI in your GitHub Action workflows, for ex

The following is a guide to setting up the Score implementation CLI in your GitHub Action workflows.

For the Score GitHub Action, see [Setup Score](https://github.com/score-spec/setup-score)
For the Score GitHub Action, see [Setup Score](https://github.com/score-spec/setup-score).

## Usage

Expand All @@ -24,17 +24,18 @@ To use the Score GitHub Action, add the following step to your [workflow](https:
steps:
- uses: score-spec/setup-score@v2
with:
file: score-compose
version: '0.6.0'
file: <score-cli>
version: '<x.y.z>'
- run: score-compose --version
```
This will download and cache the specified version of the `score-compose` CLI and add it to PATH.

The action accepts the following inputs:

- `file` - The Score CLI tool to install. For example, `score-humanitec`, `score-compose`, or `score-helm`.
- `version` - The version of the CLI to install.
- `file` - The Score CLI tool to install. For example `score-compose` or `score-helm`.

- `version` - The version of the CLI to install. You can retrieve the latest version from the release page of the respective CLI tool you're working with. For example [score-compose releases](https://github.com/score-spec/score-compose/releases) or [score-helm releases](https://github.com/score-spec/score-helm/releases).

## Example

Expand All @@ -53,10 +54,10 @@ jobs:
- uses: score-spec/setup-score@v2
with:
file: score-compose
version: '0.6.0'
version: '0.13.0'
- run: score-compose --version
```

This installs version `0.6.0` of `score-compose`, adds it to `$PATH`, and runs `score-compose --version` to verify it is set up correctly.
This installs version `0.13.0` of `score-compose`, adds it to `$PATH`, and runs `score-compose --version` to verify it is set up correctly.

The action caches the Score binary, so it won't need to download it each run.

0 comments on commit 9a2c4e3

Please sign in to comment.