diff --git a/README.md b/README.md index 8aa27aa..7de5c37 100644 --- a/README.md +++ b/README.md @@ -1,199 +1,71 @@ -# Create a JavaScript Action Using TypeScript +# setup-vcluster [![GitHub Super-Linter](https://github.com/actions/typescript-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter) ![CI](https://github.com/actions/typescript-action/actions/workflows/ci.yml/badge.svg) -Use this template to bootstrap the creation of a TypeScript action. :rocket: +This is a GitHub Action to install the vcluster CLI. Windows, Mac, and Linux runners are supported. -This template includes compilation support, tests, a validation workflow, -publishing, and versioning guidance. -If you are new, there's also a simpler introduction in the -[Hello world JavaScript action repository](https://github.com/actions/hello-world-javascript-action). - -## Create Your Own Action - -To create your own action, you can use this repository as a template! Just -follow the below instructions: - -1. Click the **Use this template** button at the top of the repository -1. Select **Create a new repository** -1. Select an owner and name for your new repository -1. Click **Create repository** -1. Clone your new repository - -## Initial Setup - -After you've cloned the repository to your local machine or codespace, you'll -need to perform some initial setup steps before you can develop your action. - -> [!NOTE] -> -> You'll need to have a reasonably modern version of -> [Node.js](https://nodejs.org) handy. If you are using a version manager like -> [`nodenv`](https://github.com/nodenv/nodenv) or -> [`nvm`](https://github.com/nvm-sh/nvm), you can run `nodenv install` in the -> root of your repository to install the version specified in -> [`package.json`](./package.json). Otherwise, 20.x or later should work! - -1. :hammer_and_wrench: Install the dependencies - - ```bash - npm install - ``` - -1. :building_construction: Package the TypeScript for distribution - - ```bash - npm run bundle - ``` - -1. :white_check_mark: Run the tests - - ```bash - $ npm test - - PASS ./index.test.js - ✓ throws invalid number (3ms) - ✓ wait 500 ms (504ms) - ✓ test runs (95ms) - - ... - ``` - -## Update the Action Metadata - -The [`action.yml`](action.yml) file defines metadata about your action, such as -input(s) and output(s). For details about this file, see -[Metadata syntax for GitHub Actions](https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions). - -When you copy this repository, update `action.yml` with the name, description, -inputs, and outputs for your action. - -## Update the Action Code - -The [`src/`](./src/) directory is the heart of your action! This contains the -source code that will be run when your action is invoked. You can replace the -contents of this directory with your own code. - -There are a few things to keep in mind when writing your action code: - -- Most GitHub Actions toolkit and CI/CD operations are processed asynchronously. - In `main.ts`, you will see that the action is run in an `async` function. - - ```javascript - import * as core from '@actions/core' - //... - - async function run() { - try { - //... - } catch (error) { - core.setFailed(error.message) - } - } - ``` - - For more information about the GitHub Actions toolkit, see the - [documentation](https://github.com/actions/toolkit/blob/master/README.md). - -So, what are you waiting for? Go ahead and start customizing your action! - -1. Create a new branch - - ```bash - git checkout -b releases/v1 - ``` - -1. Replace the contents of `src/` with your action code -1. Add tests to `__tests__/` for your source code -1. Format, test, and build the action - - ```bash - npm run all - ``` - - > [!WARNING] - > - > This step is important! It will run [`ncc`](https://github.com/vercel/ncc) - > to build the final JavaScript action code with all dependencies included. - > If you do not run this step, your action will not work correctly when it is - > used in a workflow. This step also includes the `--license` option for - > `ncc`, which will create a license file for all of the production node - > modules used in your project. - -1. Commit your changes - - ```bash - git add . - git commit -m "My first action is ready!" - ``` - -1. Push them to your repository - - ```bash - git push -u origin releases/v1 - ``` - -1. Create a pull request and get feedback on your action -1. Merge the pull request into the `main` branch - -Your action is now published! :rocket: - -For information about versioning your action, see -[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) -in the GitHub Actions toolkit. +## Usage -## Validate the Action +This action will install the vCluster CLI for use in job steps. The default behavior installs the latest release from [vCluster Releases](https://github.com/loft-sh/vcluster/releases). Subsequent steps may run any `vcluster` CLI command. -You can now validate the action by referencing it in a workflow file. For -example, [`ci.yml`](./.github/workflows/ci.yml) demonstrates how to reference an -action in the same repository. +To avoid leaking your Loft access key onto GitHub runners, this action will remove the `~/.vcluster` directory at the end of the job. +### Example: Use a specific vCluster version ```yaml -steps: - - name: Checkout - id: checkout - uses: actions/checkout@v3 - - - name: Test Local Action - id: test-action - uses: ./ - with: - milliseconds: 1000 - - - name: Print Output - id: output - run: echo "${{ steps.test-action.outputs.time }}" +name: loft version +on: + push: + branches: + - 'main' +jobs: + whoami: + runs-on: ubuntu-latest + steps: + - name: Install vCluster CLI + uses: loft-sh/setup-vcluster@main + with: + version: v0.16.0 + kubectl-install: false + - name: Show Version + run: vcluster --version ``` -For example workflow runs, check out the -[Actions tab](https://github.com/actions/typescript-action/actions)! :rocket: +## Install `kubectl` -## Usage +Options are provided to install `kubectl`. Many GitHub runners now come with `kubectl` pre-installed, however this allows for controlling the version of `kubectl` if desired. -After testing, you can create version tag(s) that developers can use to -reference different stable versions of your action. For more information, see -[Versioning](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) -in the GitHub Actions toolkit. +### Example: Install the latest vCluster CLI, and install a specific kubectl version +```yaml +name: vcluster version +on: + push: + branches: + - 'main' +jobs: + whoami: + runs-on: ubuntu-latest + steps: + - name: Install vCluster CLI + uses: loft-sh/setup-vcluster@main + with: + kubectl-install: true + kubectl-version: v1.28.2 + - name: Show vCluster Version + run: vcluster --version + - name: Show kubectl Version + run: kubectl --version --client +``` -To include the action in a workflow in another repository, you can use the -`uses` syntax with the `@` symbol to reference a specific branch, tag, or commit -hash. +## Customizing -```yaml -steps: - - name: Checkout - id: checkout - uses: actions/checkout@v3 +### inputs - - name: Test Local Action - id: test-action - uses: actions/typescript-action@v1 # Commit with the `v1` tag - with: - milliseconds: 1000 +The following inputs can be used as `step.with` keys. - - name: Print Output - id: output - run: echo "${{ steps.test-action.outputs.time }}" -``` +| Name | Type | Description | +|-----------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| `version` | String | The version of vcluster CLI to install. See [Loft Releases](https://github.com/loft-sh/vcluster/releases) for available versions. Defaults to latest. | +| `kubectl-install` | Boolean | Install kubectl if not already installed. Defaults to true. | +| `kubectl-version` | String | The version of the kubectl to install. Defaults to latest stable version. |