CI/CD Integration

We also provide some mechanisms to support the usage of the CLI in your pipelines.

GitHub Action

You can use this action to easily have the cli available in your github runner.

Usage

To use it, just add this step to your job in your workflow:

- name: Setup vvctl
  uses: ververica/vvctl@main

By default, this step will install the latest stable version available in the path /usr/local/bin.

Options

Sometimes, you might need a different version or a different installation directory. If this is your case, Ververica provides the following parameters you can use as inputs in your step.

Input	Description	Default
version	Specific version to install (e.g. v1.2.3)	latest stable
prerelease	Install latest prerelease	false
install-dir	Installation directory	/usr/local/bin

Examples

Below, you will find examples for various installation scenarios, from installing the latest version to using a custom directory and installing pre-releases.

# Latest stable
- uses: ververica/vvctl@main

# Specific version and custom installation folder
- uses: ververica/vvctl@main
  with:
    version: "v1.2.3"
    install-dir: ~/bin

# Latest prerelease
- uses: ververica/vvctl@main
  with:
    prerelease: true