https://github.com/hetznercloud/setup-hcloud

GitHub action to install the Hetzner Cloud CLI.
https://github.com/hetznercloud/setup-hcloud

actions hcloud hetzner hetzner-cloud setup-actions

Last synced: about 1 month ago
JSON representation

GitHub action to install the Hetzner Cloud CLI.

• Host: GitHub
• URL: https://github.com/hetznercloud/setup-hcloud
• Owner: hetznercloud
• License: mit
• Created: 2024-01-11T16:43:28.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-11T18:47:43.000Z (about 1 month ago)
• Last Synced: 2024-11-11T19:38:27.869Z (about 1 month ago)
• Topics: actions, hcloud, hetzner, hetzner-cloud, setup-actions
• Language: TypeScript
• Homepage:
• Size: 1.5 MB
• Stars: 18
• Watchers: 6
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-hcloud - setup-hcloud

README

        
# setup-hcloud

[![CI](https://github.com/hetznercloud/setup-hcloud/actions/workflows/ci.yml/badge.svg)](https://github.com/hetznercloud/setup-hcloud/actions/workflows/ci.yml)

[![Codecov](https://codecov.io/gh/hetznercloud/setup-hcloud/graph/badge.svg?token=R4YEGxLNvM)](https://codecov.io/gh/hetznercloud/setup-hcloud/tree/main)

This action installs the [Hetzner Cloud CLI](https://github.com/hetznercloud/cli) in your `PATH`.

# Usage

The environment variable `HCLOUD_TOKEN` is required for hcloud to work properly. See the [hcloud getting started docs](https://github.com/hetznercloud/cli#getting-started) for details.

**Setup the latest version:**

```yaml

steps:

  - uses: hetznercloud/setup-hcloud@v1

  - run: hcloud server-type list

    env:

      HCLOUD_TOKEN: ${{ secrets.HCLOUD_TOKEN }}

```

**Setup a specific version:**

```yaml

steps:

  - uses: hetznercloud/setup-hcloud@v1

    with:

      hcloud-version: v1.41.1

  - run: hcloud server-type list

    env:

      HCLOUD_TOKEN: ${{ secrets.HCLOUD_TOKEN }}

```

### Inputs

- `hcloud-version` (Optional): Version of Hetzner Cloud CLI to install. Using `latest` will install the

  [latest version of hcloud](https://github.com/hetznercloud/cli/releases/latest).

- `github-token` (Optional): A Personal Access Token or the Github Token to access the GitHub API. If

  none provided it will use the default Github Token.

### Outputs

- `hcloud-version`: Version of the Hetzner Cloud CLI that was installed.

# License

The scripts and documentation in this project are released under the [MIT License](LICENSE)