Skip to content

Commit

Permalink
feat: implement setup-hcloud action
Browse files Browse the repository at this point in the history
  • Loading branch information
jooola committed Jan 11, 2024
1 parent 24a0038 commit 7b779d7
Show file tree
Hide file tree
Showing 24 changed files with 43,822 additions and 0 deletions.
83 changes: 83 additions & 0 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
env:
node: true
es6: true
jest: true

globals:
Atomics: readonly
SharedArrayBuffer: readonly

ignorePatterns:
- '!.*'
- '**/node_modules/.*'
- '**/dist/.*'
- '**/coverage/.*'
- '*.json'

parser: '@typescript-eslint/parser'

parserOptions:
ecmaVersion: 2023
sourceType: module
project:
- './tsconfig.eslint.json'
- './tsconfig.json'

plugins:
- jest
- '@typescript-eslint'

extends:
- eslint:recommended
- plugin:@typescript-eslint/eslint-recommended
- plugin:@typescript-eslint/recommended
- plugin:github/recommended
- plugin:jest/recommended

rules:
{
'camelcase': 'off',
'eslint-comments/no-use': 'off',
'eslint-comments/no-unused-disable': 'off',
'i18n-text/no-en': 'off',
'import/no-namespace': 'off',
'no-console': 'off',
'no-unused-vars': 'off',
'prettier/prettier': 'error',
'semi': 'off',
'@typescript-eslint/array-type': 'error',
'@typescript-eslint/await-thenable': 'error',
'@typescript-eslint/ban-ts-comment': 'error',
'@typescript-eslint/consistent-type-assertions': 'error',
'@typescript-eslint/explicit-member-accessibility':
['error', { 'accessibility': 'no-public' }],
'@typescript-eslint/explicit-function-return-type':
['error', { 'allowExpressions': true }],
'@typescript-eslint/func-call-spacing': ['error', 'never'],
'@typescript-eslint/no-array-constructor': 'error',
'@typescript-eslint/no-empty-interface': 'error',
'@typescript-eslint/no-explicit-any': 'error',
'@typescript-eslint/no-extraneous-class': 'error',
'@typescript-eslint/no-for-in-array': 'error',
'@typescript-eslint/no-inferrable-types': 'error',
'@typescript-eslint/no-misused-new': 'error',
'@typescript-eslint/no-namespace': 'error',
'@typescript-eslint/no-non-null-assertion': 'warn',
'@typescript-eslint/no-require-imports': 'error',
'@typescript-eslint/no-unnecessary-qualifier': 'error',
'@typescript-eslint/no-unnecessary-type-assertion': 'error',
'@typescript-eslint/no-unused-vars': 'error',
'@typescript-eslint/no-useless-constructor': 'error',
'@typescript-eslint/no-var-requires': 'error',
'@typescript-eslint/prefer-for-of': 'warn',
'@typescript-eslint/prefer-function-type': 'warn',
'@typescript-eslint/prefer-includes': 'error',
'@typescript-eslint/prefer-string-starts-ends-with': 'error',
'@typescript-eslint/promise-function-async': 'error',
'@typescript-eslint/require-array-sort-compare': 'error',
'@typescript-eslint/restrict-plus-operands': 'error',
'@typescript-eslint/semi': ['error', 'never'],
'@typescript-eslint/space-before-function-paren': 'off',
'@typescript-eslint/type-annotation-spacing': 'error',
'@typescript-eslint/unbound-method': 'error'
}
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* text=auto eol=lf

dist/** -diff linguist-generated=true
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# * @hetznercloud/integrations
62 changes: 62 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: CI

on:
push:
branches:
- main
pull_request:

permissions:
contents: read

jobs:
check-dist:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version-file: .node-version
cache: npm

- run: npm ci

- run: npm run bundle

- name: Check for diff
run: git diff --exit-code --ignore-space-at-eol --text -- dist/

- name: Show warning
if: failure()
run: echo "::error title=Outdated build files::Make sure commit the build output files!"

test:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version-file: .node-version
cache: npm

- run: npm ci

- run: npm run lint

- run: npm run test -- --ci

test-action:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- uses: ./
with:
hcloud-version: v1.41.1

- run: hcloud version
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20.6.0
5 changes: 5 additions & 0 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"semi": false,
"singleQuote": true,
"trailingComma": "none"
}
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# 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)

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.

### 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.

### Examples

**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:
version: v1.41.1

- run: hcloud server-type list
env:
HCLOUD_TOKEN: ${{ secrets.HCLOUD_TOKEN }}
```
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)
30 changes: 30 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Setup the Hetzner Cloud CLI
description: Download the Hetzner Cloud CLI and add it to the PATH.
author: Hetzner Cloud GmbH

branding:
icon: terminal
color: red

inputs:
github-token:
description: >
A Personal Access Token or the Github Token to access the GitHub API. If
none provided it will use the default Github Token.
default: ${{ github.token }}
required: false

hcloud-version:
description: >
Version of Hetzner Cloud CLI to install. Using `latest` will install the
latest version of the tool.
default: latest
required: false

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

runs:
using: node20
main: dist/index.js
Loading

0 comments on commit 7b779d7

Please sign in to comment.