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

https://github.com/gacts/install-hurl

🚀 Installs hurl binary file into your actions workflow
https://github.com/gacts/install-hurl

actions github-actions hurl

Last synced: 10 months ago
JSON representation

🚀 Installs hurl binary file into your actions workflow

Awesome Lists containing this project

README

          


Logo

# Install [hurl][hurl] action

![Release version][badge_release_version]
[![Build Status][badge_build]][link_build]
[![License][badge_license]][link_license]

This action installs [hurl][hurl] as a binary file into your workflow. It can be run on **Linux** (`ubuntu-latest`),
**macOS** (`macos-latest`), or **Windows** (`windows-latest`).

- 🚀 Hurl releases page:

Additionally, this action uses the GitHub **caching mechanism** to speed up your workflow execution time!

## Usage

```yaml
jobs:
install-hurl:
runs-on: ubuntu-latest
steps:
- uses: gacts/install-hurl@v1
#with:
# disable-cache: true # disable cache usage
# version: 1.2.0 # `latest` by default, but you can set a specific version to install

- run: hurl version # any hurl command can be executed
```

## Customizing

### Inputs

The following inputs can be used as `step.with` keys:

| Name | Type | Default | Required | Description |
|-----------------|:---------:|:---------------------:|:--------:|------------------------------------------------------------|
| `version` | `string` | `latest` | no | Hurl version to install |
| `disable-cache` | `boolean` | `false` | no | Disable cache usage |
| `github-token` | `string` | `${{ github.token }}` | no | GitHub token (for requesting the latest hurl version info) |

### Outputs

| Name | Type | Description |
|------------|:--------:|------------------------------|
| `hurl-bin` | `string` | Path to the hurl binary file |

## Releasing

To release a new version:

- Build the action distribution (`make build` or `npm run build`).
- Commit and push changes (including `dist` directory changes - this is important) to the `master|main` branch.
- Publish the new release using the repo releases page (the git tag should follow the `vX.Y.Z` format).

Major and minor git tags (`v1` and `v1.2` if you publish a `v1.2.Z` release) will be updated automatically.

> [!TIP]
> Use [Dependabot](https://bit.ly/45zwLL1) to keep this action updated in your repository.

## Support

[![Issues][badge_issues]][link_issues]
[![Pull Requests][badge_pulls]][link_pulls]

If you find any errors in the action, please [create an issue][link_create_issue] in this repository.

## License

This is open-source software licensed under the [MIT License][link_license].

[badge_build]:https://img.shields.io/github/actions/workflow/status/gacts/install-hurl/tests.yml?branch=master&maxAge=30
[badge_release_version]:https://img.shields.io/github/release/gacts/install-hurl.svg?maxAge=30
[badge_license]:https://img.shields.io/github/license/gacts/install-hurl.svg?longCache=true
[badge_release_date]:https://img.shields.io/github/release-date/gacts/install-hurl.svg?maxAge=180
[badge_commits_since_release]:https://img.shields.io/github/commits-since/gacts/install-hurl/latest.svg?maxAge=45
[badge_issues]:https://img.shields.io/github/issues/gacts/install-hurl.svg?maxAge=45
[badge_pulls]:https://img.shields.io/github/issues-pr/gacts/install-hurl.svg?maxAge=45

[link_build]:https://github.com/gacts/install-hurl/actions
[link_license]:https://github.com/gacts/install-hurl/blob/master/LICENSE
[link_issues]:https://github.com/gacts/install-hurl/issues
[link_create_issue]:https://github.com/gacts/install-hurl/issues/new
[link_pulls]:https://github.com/gacts/install-hurl/pulls

[hurl]:https://hurl.dev/