UpCloud CLI for GitHub Actions

A GitHub Action that installs and configures the UpCloud CLI (upctl) for managing UpCloud infrastructure in your GitHub Actions workflows.

Features

• Automatically installs the UpCloud CLI tool
• Configures authentication with your UpCloud API credentials
• Supports specific version installation or latest version
• Works across different operating systems (Linux, macOS, Windows)

Usage

Basic Example

name: Deploy to UpCloud

on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Setup UpCloud CLI
        uses: upcloudltd/upcloud-cli-action@main
        with:
          token: ${{ secrets.UPCLOUD_TOKEN }}
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: List UpCloud servers
        run: upctl server list

Inputs

Input	Description	Required	Default
username	UpCloud API Username	No	-
password	UpCloud API Password	No	-
token	UpCloud API Token	No	-
version	UpCloud CLI version to install	No	latest

Define either token or username and password to configure authentication.

Environment

If the GH_TOKEN environment variable is set to a non-empty value, downloads are verified against their artifact attestations using the gh tool.

Authentication

Store your UpCloud API credentials as GitHub secrets:

1. Go to your GitHub repository → Settings → Secrets and variables → Actions
2. Create secrets for UPCLOUD_USERNAME and UPCLOUD_PASSWORD
3. Use these secrets in your workflow as shown in the example above

Examples

Deploy to Kubernetes with Helm

steps:
  - name: Setup UpCloud CLI
    uses: upcloudltd/upcloud-cli-action@main
    with:
      username: ${{ secrets.UPCLOUD_USERNAME }}
      password: ${{ secrets.UPCLOUD_PASSWORD }}

  - name: Setup Helm
    uses: azure/setup-helm@v3

  - name: Generate kubeconfig
    run: |
      upctl kubernetes config my-cluster --write kubeconfig.yaml
      echo "KUBECONFIG=kubeconfig.yaml" >> $GITHUB_ENV

  - name: Deploy with Helm
    run: |
      helm repo add bitnami https://charts.bitnami.com/bitnami
      helm upgrade --install my-app bitnami/nginx --namespace my-namespace --create-namespace

Use a Specific upctl Version

steps:
  - name: Setup UpCloud CLI
    uses: upcloudltd/upcloud-cli-action@main
    with:
      username: ${{ secrets.UPCLOUD_USERNAME }}
      password: ${{ secrets.UPCLOUD_PASSWORD }}
      version: "3.19.0" # Specify a version

License

This project is licensed under the MIT License.