Skip to content

lekkodev/lekko-setup-action

Repository files navigation

lekko-setup-action

This Action installs the lekko CLI in your GitHub Actions pipelines so that it can be used by other actions.

After lekko-setup-action is run, the lekko command is available to other Actions in the pipeline's PATH. You can also use the lekko command directly inside of workflow steps.

Usage

Here's an example usage of lekko-setup-action:

steps:
  # Run `git checkout`
  - uses: actions/checkout@v3
  # Install the `lekko` CLI
  - uses: lekkodev/lekko-setup-action@v1
  # Ensure that `lekko` is installed
  - run: lekko --version

Configuration

Input

You can configure lekko-setup-action with these parameters:

Parameter Description Default
version The version of lekko to install v0.2.32
apikey The Lekko apikey that provides you with access to Lekko developer resources
github_token The GitHub token to use to install lekko. Deprecated.

These parameters are derived from action.yml.

Version

If version is unspecified, a default version of lekko is installed:

steps:
  - uses: actions/checkout@v3
  # Installs latest
  - uses: lekkodev/lekko-setup-action@v1
  - run: lekko --version

Use the version parameter to pin to a specific version:

steps:
  - uses: actions/checkout@v3
  # Installs version 0.2.32
  - uses: lekkodev/lekko-setup-action@v1
    with:
      version: 0.2.32
  # Should output v0.2.32
  - run: lekko --version

To resolve the latest release from GitHub, you can specify latest, but this is not recommended:

steps:
  - uses: actions/checkout@v3
  - uses: lekkodev/lekko-setup-action@v1
    with:
      version: latest
  - run: lekko --version

API key

You must supply a apikey input so that the action can access Lekko's private releases page.

steps:
  - uses: lekkodev/lekko-setup-action@v1
    with:
      apikey: ${{ secrets.LEKKO_DEVELOPER_APIKEY }}

This key can be made a repository or organization secret. See Encrypted Secrets for more information.