lightbend / setup-kalix-action

Install the Kalix CLI within a GitHub workflow

Kalix CLI for GitHub Actions

This JavaScript action for GitHub workflows installs and configures the Kalix CLI tool. After running this action, the kalix command is available in the workflow.

Usage

The action takes two required parameters to authenticate and set the Kalix project ID:

• token: The Kalix authentication token
• project-id: The Kalix project ID you're using

Example Workflow

The below flow shows how to use this action to list all services in your project

name: kalix

on: 
  push:
    branches: [ main ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Install Kalix CLI
        uses: lightbend/setup-kalix-action@v1
        with:
          token: ${{ secrets.KALIX_TOKEN }}
          project-id: ${{ vars.KALIX_PROJECT_ID }}
      - name: List services
        run: kalix service list

Building and developing

Follow the instructions to build and push the action.

• run npm i --target_arch=x64 --target_platform=linux
• update index.js file with your changes
• run ncc build index.js
• commit sources and dist folder

Contributing

We welcome all contributions! Pull requests are the preferred way to share your contributions. For major changes, please open an issue first to discuss what you would like to change.

Support

This project is an incubator

License

See the LICENSE