README.md

install-jq-action

Multiplatform jq installer action

This action is tested against the following versions of JQ:

• 1.7
• 1.6
• 1.5

Index

1. Examples
2. Action Source
3. Action Inputs
4. Action Outputs

Examples

• linux
• macos
• windows

Action Inputs

version

  version:
    required: false
    description: "Version of jq to install"
    default: "1.7"

This must be a version with a corresponding release.

force

  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.

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

  found:
    description: "If 'true', jq was already found on this runner"

installed

  installed:
    description: "If 'true', jq was installed by this action"