mirror of
https://github.com/earthly/actions-setup.git
synced 2025-01-14 19:40:50 +08:00
74 lines
1.8 KiB
Markdown
74 lines
1.8 KiB
Markdown
# Setup Earthly - GitHub Action
|
|
|
|
This repository contains an action for use with GitHub Actions, which installs [earthly](https://github.com/earthly/earthly) with a semver-compatible version.
|
|
|
|
The package is installed into `/home/runner/.earthly` (or equivalent on Windows) and the `bin` subdirectory is added to the PATH.
|
|
|
|
## Usage
|
|
|
|
Full example:
|
|
|
|
```yml
|
|
name: GitHub Actions CI
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
jobs:
|
|
tests:
|
|
name: example earthly test
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: earthly/actions-setup@v1
|
|
with:
|
|
version: "latest" # or pin to an specific version, e.g. "v0.6.10"
|
|
- uses: actions/checkout@v2
|
|
- name: Docker login # to avoid dockerhub rate-limiting
|
|
run: docker login --username "${{ secrets.DOCKERHUB_USERNAME }}" --password "${{ secrets.DOCKERHUB_PASSWORD }}"
|
|
- name: what version is installed?
|
|
run: earthly --version
|
|
- name: run the earthly hello world
|
|
run: earthly github.com/earthly/hello-world:main+hello
|
|
```
|
|
|
|
Install the latest version of earthly:
|
|
|
|
```yaml
|
|
- name: Install earthly
|
|
uses: earthly/setup-earthly@v1
|
|
```
|
|
|
|
Install a specific version of earthly:
|
|
|
|
```yaml
|
|
- name: Install earthly
|
|
uses: earthly/setup-earthly@v1
|
|
with:
|
|
version: 0.6.1
|
|
```
|
|
|
|
Install a version that adheres to a semver range
|
|
|
|
```yaml
|
|
- name: Install earthly
|
|
uses: earthly/setup-earthly@v1
|
|
with:
|
|
version: ^0.6.0
|
|
```
|
|
|
|
### Testing
|
|
|
|
You can perform a local test by running `earthly +all`.
|
|
|
|
It is also possible to use [act](https://github.com/nektos/act) to test the contents of the github actions config.
|
|
|
|
## Configuration
|
|
|
|
The action can be configured with the following arguments:
|
|
|
|
- `version` - The version of earthly to install. Default is `latest`. Accepts semver style values.
|
|
- `github-token` (optional) - Token used to query earthly versions.
|