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

GitHub Action

Setup SOPS

v1.0

Setup SOPS

lock

Setup SOPS

Setup SOPS in GitHub Actions

Installation

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

              

- name: Setup SOPS

uses: nhedger/[email protected]

Learn more about this action in nhedger/setup-sops

Choose a version

Banner

GitHub release (latest SemVer) Test Integrate

Setup SOPS in GitHub Actions

Setup SOPS is a GitHub action that provides a cross-platform interface for setting up SOPS in GitHub Actions runners.

Inputs

The following inputs are supported.

- name: Setup SOPS
  uses: nhedger/setup-sops@v1
  with:

    # The version of SOPS to install.
    # This input is optional and defaults to "latest".
    # Example values: "3.7.3", "latest"
    version: "latest"

Examples

Basic example

Setup the latest version of SOPS.

- name: Setup SOPS
  uses: nhedger/setup-sops@v1

- name: Run SOPS
  run: sops --version

Specific version

Install version 3.7.3 of SOPS.

- name: Setup SOPS
  uses: nhedger/setup-sops@v1
  with:
    version: 3.7.3

- name: Run SOPS
  run: sops --version

Caveats

This action makes HTTP requests to the GitHub REST API to determine the URL of the assets to download. By default, these requests are made anonymously, which means that they are subject to harsher rate limits.

GitHub-hosted macOS runners are typically subject to this issue, because most of them share a common IP address, which increases the likelihood of hitting the rate limit.

If you encounter rate limiting issues, try setting the GITHUB_TOKEN environment variable to authenticate the requests and increase the rate limit.

- name: Setup SOPS
  uses: nhedger/setup-sops@v1
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

License

The scripts and documentation in this project are licensed under the MIT License.