Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
copy

GitHub Action

Install YQ

v1

Install YQ

copy

Install YQ

Installs a version of YQ into the job tool cache using simple shell scripts

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Install YQ

              
  uses: dcarbone/install-yq-action@v1
Learn more about this action in dcarbone/install-yq-action

Choose a version

install-yq-action

Cross-platform yq installer composite action

Tests - Setup YQ Action

Index

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

Examples

Action Inputs

version

  version:
    required: false
    description: "Version of YQ to install"
    default: "v4.44.3"

This must be a version with a corresponding release.

download-compressed

  download-compressed:
    required: false
    description: "If 'true', downloads .tar.gz of binary rather than raw binary.  Save the tubes."
    default: 'true'

force

  force:
    required: false
    description: "If 'true', does not check for existing yq installation before continuing."
    default: 'false'

GitHub's own hosted runners come with a version of yq 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', yq was already found on this runner"

installed

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