Skip to content

civo/action-civo

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

GitHub Actions for Civo

This action enables you to interact with Civo services by installing the civo command-line client.

Usage

To install the latest version of civo and use it in GitHub Actions workflows, add the following step:

    - name: Install civo
      uses: civo/action-civo
      with:
        token: ${{ secrets.CIVO_TOKEN }}

civo will now be available in the virtual environment and can be used directly in following steps. As an example, one common use case is retrieving the credentials for a Kubernetes cluster hosted on Civo for use in a deployment workflow:

    - name: Save Civo kubeconfig
      run: civo kubernetes config CLUSTER_NAME

Arguments

  • token – (Required) A Civo personal access token.
  • version – (Optional) The version of civo to install. If excluded, the latest release will be used.

Contributing

To install the needed dependencies, run npm install. The resulting node_modules/ directory is not checked in to Git.

Before submitting a pull request, run npm run package to package the code using ncc. Packaging assembles the code including dependencies into one file in the dist/ directory that is checked in to Git.

License

This GitHub Action and associated scripts and documentation in this project are released under the MIT License.