add-goreleaser-homebrew

Add GoReleaser Homebrew

Add GoReleaser configuration and a GitHub Actions release workflow to an existing Go CLI project with Homebrew tap publishing.

Workflow

1. Verify the Project

Confirm the current directory is a Go CLI project:

• Check that go.mod exists (required; abort if missing)
• Read go.mod to extract the module path (needed for ldflags and URLs)
• Check for an existing .goreleaser.yml or .goreleaser.yaml; if present, warn and ask whether to overwrite or abort
• Check for an existing .github/workflows/release.yml; if present, warn and ask whether to overwrite or abort

2. Detect User Identity

Detect the user's GitHub username for use in templates:

gh api user -q .login

If the command fails or produces no output, ask the user to provide their GitHub username. Use it wherever templates reference GITHUB-USERNAME.

3. Gather Project Information

Collect the following, inferring from existing files where possible:

• Project name: determine in this precedence order:

  1. If a Makefile defines a binary name (for example via a BINARY/TOOL_BIN variable or the target passed to go build -o), use that name.
  2. Otherwise, use the last segment of the module path in go.mod.
  3. Otherwise, try git remote get-url origin: strip any trailing .git from the URL and take the last path segment. If the command exits non-zero, returns empty output, or the URL cannot be parsed into a repo name, treat this as "no remote" and continue to step 4.
  4. If none of the above yield a name, ask the user for the project name.

  Do not derive the project name from the directory or branch name, which are often misleading.

• Short description: check the README for a one-line description; if not found, ask the user

If the user already provided some or all of these in their initial request, do not re-ask.

4. Detect Project Features

Check for three conditional features. For each, use the detection steps described in ./references/conditional-features.md: