Setup GitHub Actions

You can use any Score implementation CLI in your GitHub Action workflows, for example, when you make a code change, and you want to deploy your code to a new environment in a specific platform.

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.

Usage

To use the Score GitHub Action, add the following step to your workflow:

steps:
  - uses: score-spec/setup-score@v2
    with:
      file: <score-cli>
      version: '<x.y.z>'
      token: ${{ secrets.GITHUB_TOKEN }}
  - 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-compose or score-k8s.

• version - The version of the CLI to install. latest can be used, or you can retrieve a specific version from the release page of the respective CLI tool you’re working with. For example score-compose releases or score-k8s releases.

• token - The GitHub Actions Token in the environment (${{ secrets.GITHUB_TOKEN }}).

Example

Here is a complete example workflow:

name: Score Example

on: push

jobs:
  test:
    runs-on: ubuntu-latest

    steps:
      - uses: score-spec/setup-score@v2
        with:
          file: score-compose
          version: '0.13.0'
          token: ${{ secrets.GITHUB_TOKEN }}
      - run: score-compose --version

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.