Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yokawasa/action-setup-ecctl

A GitHub action that install a specific version of ecctl (Elastic Cloud control tool) and cache it on the runner. Please [✩Star] if you're using it!
https://github.com/yokawasa/action-setup-ecctl

ecctl elasticcloud elasticsearch github-action github-actions

Last synced: about 2 months ago
JSON representation

A GitHub action that install a specific version of ecctl (Elastic Cloud control tool) and cache it on the runner. Please [✩Star] if you're using it!

Awesome Lists containing this project

README

        


action-setup-ecctl status

# action-setup-ecctl

A GitHub action that install a specific version of [ecctl](https://github.com/elastic/ecctl) (Elastic Cloud control tool) and cache it on the runner

## Usage

### Inputs

|Parameter|Required|Default Value|Description|
|:--:|:--:|:--:|:--|
|`version`|`false`|`latest`|Ecctl tool version such as `v1.3.1`. Ecctl vesion can be found [here](https://github.com/elastic/ecctl/releases).|

> Supported Environments: Linux and macOS

### Outputs

|Parameter|Description|
|:--:|:--|
|`ecctl-path`| ecctl command path |

### Sample Workflow

A specific version of ecctl can be setup by giving an input - `version` like this:
```yaml
- uses: yokawasa/[email protected]
with:
version: 'v1.3.1' # default is 'latest'
id: setup
- run: |
ecctl version
```

The latest version of ecctl will be setup if you don't give an input like this:

```yaml
- uses: yokawasa/[email protected]
id: setup
- run: |
ecctl version
```

## Developing the action

Install the dependencies
```bash
npm install
```

Build the typescript and package it for distribution by running [ncc](https://github.com/vercel/ncc)
```bash
npm run build && npm run format && npm run lint && npm run pack
```

Finally push the resutls
```
git add dist
git commit -a -m "prod dependencies"
git push origin releases/v0.4.1
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yokawasa/action-setup-ecctl

## Changelog

Please see the [list of releases](https://github.com/yokawasa/action-setup-ecctl/releases) for information on changes between releases.