Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dcarbone/install-jq-action
Multiplatform jq installer action
https://github.com/dcarbone/install-jq-action
action actions cicd deploy github-action github-actions jq
Last synced: 7 days ago
JSON representation
Multiplatform jq installer action
- Host: GitHub
- URL: https://github.com/dcarbone/install-jq-action
- Owner: dcarbone
- License: apache-2.0
- Created: 2022-10-18T13:02:55.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-08T02:18:10.000Z (10 months ago)
- Last Synced: 2024-10-05T15:16:50.465Z (about 1 month ago)
- Topics: action, actions, cicd, deploy, github-action, github-actions, jq
- Language: Shell
- Homepage:
- Size: 40 KB
- Stars: 8
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# install-jq-action
Multiplatform [jq](https://github.com/stedolan/jq) installer action
[](https://github.com/dcarbone/install-jq-action/actions/workflows/tests.yaml)
This action is tested against the following versions of JQ:
- [1.7](https://github.com/jqlang/jq/releases/tag/jq-1.7)
- [1.6](https://github.com/jqlang/jq/releases/tag/jq-1.6)
- [1.5](https://github.com/jqlang/jq/releases/tag/jq-1.5)
# Index
1. [Examples](#examples)
2. [Action Source](action.yaml)
3. [Action Inputs](#action-inputs)
4. [Action Outputs](#action-outputs)
## Examples
* [linux](./.github/workflows/example-linux.yaml)
* [macos](./.github/workflows/example-macos.yaml)
* [windows](./.github/workflows/example-windows.yaml)
## Action Inputs
#### version
```yaml
version:
required: false
description: "Version of jq to install"
default: "1.7"
```
This must be a version with a [corresponding release](https://github.com/stedolan/jq/releases).
#### force
```yaml
force:
required: false
description: "If 'true', does not check for existing jq installation before continuing."
default: 'false'
```
GitHub's own hosted runners come with a version of
[jq pre-installed](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software).
Setting this to `true` will install the version you specify into the tool cache, superseding the preinstalled version.
Setting this to true can also help ensure the same version is used across both self-hosted and remote runners.
## Action Outputs
#### found
```yaml
found:
description: "If 'true', jq was already found on this runner"
```
#### installed
```yaml
installed:
description: "If 'true', jq was installed by this action"
```