GORELEASER(1)

📦
version 2.17.1 · 2 versions
, in nixpkgs unstable

✨ goreleaser — release engineering, simplified ✨

okay so welcome to goreleaser(1), bestie 💖 this is the manual page for the goreleaser command (that's section 1 of the manuals, iykyk), and honestly? it's a whole vibe. let's get into it.

🌸 NAME 🌸

goreleaser — release engineering, simplified.

🎀 SYNOPSIS 🎀

goreleaser [options...] [argument...]

💜 DESCRIPTION 💜

Release engineering, simplified. that's it, that's the tagline, and it ate 💅

GoReleaser is a release automation tool, built with love and care by @caarlos0 and many contributors. literally a labor of love, no cap 🫶

Complete documentation is available at https://goreleaser.com — go read it, it's giving "everything you ever needed" energy.

⭐ OPTIONS ⭐

  • --verbose — Enable verbose mode. it yells more. that's the whole thing. 🗣️

👑 COMMANDS 👑

🛠 build

Builds the current project. just you, your code, and a dream.

OPTIONS

  • --auto-snapshot — Automatically sets --snapshot if the repository is dirty. messy repo? it handles it bestie 🫧
  • --clean — Removes the 'dist' directory before building. out with the old, periodt.
  • -f, --config — Load configuration from file
  • --deprecated — Force print the deprecation message - tests only. (yes it literally says "tests only", don't come for me 💀)
  • --id — Builds only the specified build ids
  • -o, --output — Copy the binary to the path after the build. Only taken into account when using --single-target and a single id (either with --id or if configuration only has one build) ⚠️ so like, don't expect it to work in every scenario, okay?
  • -p, --parallelism — Number of tasks to run concurrently (default: number of CPUs). multitasking icon ✨
  • --single-target — Builds only for current GOOS and GOARCH, regardless of what's set in the configuration file
  • --skip — Skip the given options (valid options are: before, post-hooks, pre-hooks, validate)
  • --snapshot — Generate an unversioned snapshot build, skipping all validations
  • --timeout — Timeout to the entire build process

✅ check [configuration files]

Checks if configuration is valid. a vibe check for your yaml, literally 🌈

OPTIONS

  • -f, --config — Configuration file(s) to check
  • --deprecated — Force print the deprecation message - tests only
  • -q, --quiet — Quiet mode: no output. shhh 🤫

🐚 completion

Generate the autocompletion script for the specified shell. your shell, but make it psychic 🔮

COMMANDS

🌸 bash

Generate the autocompletion script for bash

OPTIONS

  • --no-descriptions — disable completion descriptions

🦋 fish

Generate the autocompletion script for fish

OPTIONS

  • --no-descriptions — disable completion descriptions

💜 powershell

Generate the autocompletion script for powershell

OPTIONS

  • --no-descriptions — disable completion descriptions

🎀 zsh

Generate the autocompletion script for zsh

OPTIONS

  • --no-descriptions — disable completion descriptions

🩺 healthcheck

Checks if needed tools are installed. doctor's appointment for your toolchain 🫶

OPTIONS

  • -f, --config — Configuration file
  • -q, --quiet — Quiet mode: no output

💬 help [command]

Help about any command. when in doubt, ask for help, it's giving healthy communication 😌

🌱 init

Generates a .goreleaser.yaml file. starter pack energy, main character origin story ✨

OPTIONS

  • -f, --config — Load configuration from file
  • -l, --language — Which language will be used

🧾 jsonschema

Outputs goreleaser's JSON schema. for the schema girlies 💅

OPTIONS

  • -o, --output — Where to save the JSONSchema file

🚀 release

Releases the current project. the big one. the finale. the moment 🔥

OPTIONS

  • --auto-snapshot — Automatically sets --snapshot if the repository is dirty
  • --clean — Removes the 'dist' directory
  • -f, --config — Load configuration from file
  • --deprecated — Force print the deprecation message - tests only
  • --draft — Whether to set the release to draft. Overrides release.draft in the configuration file
  • --fail-fast — Whether to abort the release publishing on the first error
  • -p, --parallelism — Amount tasks to run concurrently (default: number of CPUs)
  • --release-footer — Load custom release notes footer from a markdown file
  • --release-footer-tmpl — Load custom release notes footer from a templated markdown file (overrides --release-footer)
  • --release-header — Load custom release notes header from a markdown file
  • --release-header-tmpl — Load custom release notes header from a templated markdown file (overrides --release-header)
  • --release-notes — Load custom release notes from a markdown file (will skip GoReleaser changelog generation)
  • --release-notes-tmpl — Load custom release notes from a templated markdown file (overrides --release-notes)
  • --skip — Skip the given options (valid options are announce, archive, aur, aur-source, before, chocolatey, docker, flatpak, homebrew, ko, makeself, mcp, nfpm, nix, notarize, publish, sbom, scoop, sign, snapcraft, srpm, validate, winget) — yes that's the whole list, I didn't skip any, I would never 🙈
  • --snapshot — Generate an unversioned snapshot release, skipping all validations and without publishing any artifacts (implies --skip=announce,publish,validate)
  • --timeout — Timeout to the entire release process

🦋 EXAMPLES 🦋

okay so here's the actual group chat of example commands, bestie 🫶

Initialize your project:

goreleaser init

Verify your configuration:

goreleaser check

Verify dependencies:

goreleaser healthcheck

Build the binaries only:

goreleaser build

Run a snapshot release:

goreleaser release --snapshot

Run a complete release:

goreleaser release
ngl the last one is the final boss. do a --snapshot first, okay? it's giving self-care 💖

and that's the page, bestie 🎀 this was goreleaser, the tool, written up for the goreleaser(1) manual, dated 2026-10-29. go forth and release things, you absolute icon 👑✨💜

📦 where this page comes from