From 9a2c4e3b29ff2ca2ee75a9e905ae4b72b66b8fa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Susa=20T=C3=BCnker?= Date: Tue, 16 Apr 2024 13:32:01 +0200 Subject: [PATCH] Updated GitHub actions instructions --- content/en/docs/How to/github.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/content/en/docs/How to/github.md b/content/en/docs/How to/github.md index 508e7060..51e398eb 100644 --- a/content/en/docs/How to/github.md +++ b/content/en/docs/How to/github.md @@ -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 @@ -24,8 +24,8 @@ 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: + version: '' - run: score-compose --version ``` @@ -33,8 +33,9 @@ This will download and cache the specified version of the `score-compose` CLI an 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 @@ -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.