Skip to content

(Yet Another) Setup jq

Actions
Installs the jq command-line JSON parser/processor on Linux, macOS and Windows runners
1.0.0
Latest
Star (2)

gha-setup-jq

Build License Contributor Covenant

Feedback and high-quality pull requests are highly welcome!

  1. What is it?
  2. Usage
  3. License

What is it?

gha-setup-jq is a GitHub action to install the jq command-line JSON parser/processor.

Usage

In your GitHub actions workflow specify:

Installing the latest version:

name: Build
on: [ push, pull_request ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Setup jq
      uses: vegardit/gha-setup-jq@v1

    - name: Use jq
      run: |
        jq --version
        echo '{ "greeting": "Hello World!" }' | jq .greeting

Installing a specific version:

name: Build
on: [ push, pull_request ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Setup jq
      uses: vegardit/gha-setup-jq@v1
      with:
        use-cache: true
        version: 4.30.6

    - name: Use jq
      run: |
        jq --version
        echo '{ "greeting": "Hello World!" }' | jq .greeting

Configuration parameters and default values

with:
  version: any    # jq version to install, possible values:
                  # - "any" -> meaning if jq is installed already or found in cache, then just use that version
                  # - "latest" ->
                  # - a version number, e.g. '1.5'
  use-cache: true # if the downloaded jq binary should be cached using the GHA caching service

License

All files are released under the Apache License 2.0.

Individual files contain the following tag instead of the full license text:

SPDX-License-Identifier: Apache-2.0

This enables machine processing of license information based on the SPDX License Identifiers that are available here: https://spdx.org/licenses/.

(Yet Another) Setup jq is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Installs the jq command-line JSON parser/processor on Linux, macOS and Windows runners
1.0.0
Latest

(Yet Another) Setup jq is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.