https://github.com/lightbend/setup-kalix-action
Install the Kalix CLI within a GitHub workflow
https://github.com/lightbend/setup-kalix-action
Last synced: 12 months ago
JSON representation
Install the Kalix CLI within a GitHub workflow
- Host: GitHub
- URL: https://github.com/lightbend/setup-kalix-action
- Owner: lightbend
- License: apache-2.0
- Created: 2024-01-25T08:29:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T07:03:47.000Z (about 2 years ago)
- Last Synced: 2025-01-11T19:36:05.780Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://docs.kalix.io/operations/integrate-cicd-github-actions.html
- Size: 270 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kalix CLI for GitHub Actions
This [JavaScript action](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action) for GitHub workflows installs and configures the [Kalix CLI](https://docs.kalix.io/kalix/index.html) 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
```yaml
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](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#commit-tag-and-push-your-action-to-github) 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](https://github.com/lightbend/setup-kalix-action/pulls) are the preferred way to share your contributions. For major changes, please open [an issue](https://github.com/lightbend/setup-kalix-action/issues) first to discuss what you would like to change.
## Support
This project is an [incubator](https://doc.akka.io/docs/akka-dependencies/current/support-terminology.html#incubating)
## License
See the [LICENSE](./LICENSE)