diff --git a/README.md b/README.md index 16360a3..2586fa6 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,59 @@ -# setup-helmfile -This action will setup helmfile with Helm and kubectl. +@mamezou-tech/setup-helmfile +============================ -AWS edition of kubectl will be instaalled. +![CI](https://github.com/mamezou-tech/setup-helmfile/workflows/CI/badge.svg) -## Inputs -### `helmfile-version` -helmfile version. Default `"v0.99.3"`. +Setup [helmfile](https://github.com/roboll/helmfile) with Helm and kubectl in GitHub Actions. -### `helm-version` -Helmfile version. Default `"v3.0.3"` +> - The AWS version of kubectl is installed. +> - This action works on Linux. +> - Helm 2.x is not supported. -### `kubectl-version` -kubectl version. Default `1.14.6` +```yaml +name: CI +on: [push] +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: Setup helmfile + uses: mamezou-tech/setup-helmfile@v0.1.0 + - name: Test + run: | + helmfile --version + helm version + kubectl version --client +``` -### `kubectl-release-date` -kubectl release date. Default `2019-08-22` +## Optional Inputs +- `helmfile-version` : helmfile version. Default `"v0.99.3"`. +- `helm-version` : Helmfile version. Default `"v3.0.3"` +- `kubectl-version` : kubectl version. Default `1.14.6` +- `kubectl-release-date` : kubectl release date. Default `2019-08-22` -## Example usage +Example with optional inputs ```yaml -- name: Setup helmfile - uses: kondoumh/setup-helmfile@master - with: - helmfile-version: 'v0.99.2' -- name: Use helmfile - run: | - helmfile --version +name: CI +on: [push] +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - name: Setup helmfile + uses: mamezou-tech/setup-helmfile@v0.1.0 + with: + helmfile-version: "v0.99.2" + - name: Test + run: | + helmfile --version +``` + +### Build action (for maintainer) +``` +$ npm install +$ npm run package ``` +> `dist/index.js` shoud be included in commit. diff --git a/action.yml b/action.yml index fddf152..1087537 100644 --- a/action.yml +++ b/action.yml @@ -1,22 +1,23 @@ name: helmfile-setup -description: 'Setup helmfile' +description: 'Setup helmfile Action' +author: "mamezou-tech" inputs: kubectl-version: - description: 'kubectl (AWS edition) version' - default: '1.14.6' + description: "kubectl (AWS edition) version" + default: "1.14.6" required: false kubectl-release-date: - description: 'kubectl (AWS edition) release date' - default: '2019-08-22' + description: "kubectl (AWS edition) release date" + default: "2019-08-22" required: false helm-version: - description: 'Helm version' + description: "Helm version" default: "v3.0.3" required: false helmfile-version: - description: 'helmfile version' + description: "helmfile version" default: "v0.98.3" required: false runs: - using: 'node12' - main: 'dist/index.js' + using: "node12" + main: "dist/index.js" diff --git a/package.json b/package.json index 00e12c0..5e96792 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "Action for setup helmfile", "main": "index.js", "scripts": { - "lint": "eslint src/**", + "lint": "eslint src/** --ignore-pattern **/*.test.js", "package": "ncc build src/index.js -o dist", "test": "jest" },