The goreleaser-action from haya14busa

haya14busa / goreleaser-action Goto Github PK

View Code? Open in Web Editor NEW

:octocat: GitHub Action for GoReleaser

License: MIT License

Go 1.25% TypeScript 93.41% JavaScript 5.34%

goreleaser-action's Introduction

GoReleaser Action

GitHub Action for GoReleaser

Usage

Below is a simple snippet to use this action. A live example is also available for this repository.

name: goreleaser

on:
  pull_request:
  push:

jobs:
  goreleaser:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v2
      -
        name: Unshallow
        run: git fetch --prune --unshallow
      -
        name: Set up Go
        uses: actions/setup-go@v1
        with:
          go-version: 1.13.x
      -
        name: Run GoReleaser
        uses: goreleaser/goreleaser-action@v1
        with:
          version: latest
          args: release --rm-dist
          key: ${{ secrets.YOUR_PRIVATE_KEY }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

IMPORTANT: note the Unshallow step. It is required for the changelog to work correctly.

If you want to run GoReleaser only on new tag, check this comment.

Customizing

Inputs

Following inputs can be used as step.with keys

Name	Type	Default	Description
`version`	String	`latest`	GoReleaser version. Example: `v0.117.0`
`args`	String		Arguments to pass to GoReleaser
`key`	String		Private key to import
`workdir`	String	`.`	Working directory (below repository root)

Signing

If signing is enabled in your GoReleaser configuration, populate the key input with your private key and reference the key in your signing configuration, e.g.

signs:
  - artifacts: checksum
    args: ["--batch", "-u", "<key id, fingerprint, email, ...>", "--output", "${signature}", "--detach-sign", "${artifact}"]

This feature is currently only compatible when using the default gpg command and a private key without a passphrase.