https://github.com/civo/action-civo

GitHub Action for Civo
https://github.com/civo/action-civo

cicd civo civo-cli github-actions

Last synced: about 2 months ago
JSON representation

GitHub Action for Civo

• Host: GitHub
• URL: https://github.com/civo/action-civo
• Owner: civo
• License: mit
• Created: 2020-06-18T12:06:08.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-20T08:33:48.000Z (over 1 year ago)
• Last Synced: 2024-10-12T14:50:05.974Z (2 months ago)
• Topics: cicd, civo, civo-cli, github-actions
• Language: JavaScript
• Homepage: https://www.civo.com/
• Size: 496 KB
• Stars: 6
• Watchers: 2
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Actions for Civo

This action enables you to interact with [Civo](https://www.civo.com/) services by installing [the `civo` command-line client](https://github.com/civo/cli).

## Usage

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

```yaml

    - 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:

```yaml

    - 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`](https://github.com/zeit/ncc#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](LICENSE).