Skip to content
hashicorp

GitHub Action

setup-copywrite

v1.1.3 Latest version

setup-copywrite

hashicorp

setup-copywrite

setup-copywrite downloads, installs, and configures the copywrite CLI tool

Installation

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

 
              
- name: setup-copywrite

              
  uses: hashicorp/[email protected]
Learn more about this action in hashicorp/setup-copywrite

Choose a version

setup-copywrite

Download and configure the copywrite CLI tool.

Originally based off of setup-signore.

Usage

Note: see action.yml for detailed information about configuration and defaults.

Install the latest copywrite client release and validate headers

- name: Checkout Repo
  uses: actions/checkout@v4

- name: Install copywrite
  uses: hashicorp/[email protected]
  
- name: Validate Header Compliance
  run: copywrite headers --plan

Install a specific copywrite client release

- name: Install copywrite v0.18.0
  uses: hashicorp/[email protected]
  with:
    version: v0.18.0

Install a specific copywrite client release, verifying its archive checksum

- name: Install copywrite v0.18.0 and verify checksum
  uses: hashicorp/[email protected]
  with:
    version: v0.18.0
    # https://github.com/hashicorp/copywrite/releases/download/v0.18.0/copywrite_0.18.0_darwin_x86_64.tar.gz sha256 hash
    archive-checksum: 88f135d752782447fcb34efee1c3bef64096cd8e1d26c921b0a54cf5ab13d573

FAQ

  • What checksum are we verifying?
    • After downloading the OS/arch specific tar or zip archive that contains the copywrite binary, we compare its SHA256 hash against the user supplied archive-checksum