Goreleaser

[chronark]

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

• Test A
• Test B

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

• Chores
  • Introduced automated release workflow using GoReleaser for streamlined releases.
  • Added GoReleaser configuration to support multi-platform builds, Docker image creation, and changelog generation.
  • Updated .gitignore to exclude build artifacts.
  • Added a Dockerfile for building minimal container images.
• Style
  • Removed autogenerated timestamp comments from generated files for cleaner code.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 5fb7bb5

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
dashboard	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	Apr 24, 2025 6:21am
engineering	🔄 Building (Inspect)	Visit Preview	💬 Add feedback	Apr 24, 2025 6:21am

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This update introduces automated release tooling and configuration for a Go project. It adds a GitHub Actions workflow to run GoReleaser on tag pushes and pull requests, a GoReleaser configuration file specifying build, archive, Docker, and changelog settings, and a Dockerfile for producing minimal container images. The .gitignore is updated to exclude the GoReleaser output directory. Additionally, the Go code generator is modified to remove timestamp comments from generated files by deleting related code and imports.

Changes

File(s)	Change Summary
.github/workflows/release.yaml	Added a GitHub Actions workflow to automate releases with GoReleaser, triggered on PRs and tag pushes.
go/.goreleaser.yaml	Added GoReleaser v2 configuration: build matrix, pre-build hooks, Docker, archive, changelog, and release setup.
go/goreleaser.Dockerfile	Added minimal Dockerfile copying the unkey binary and setting entrypoint for containerized execution.
go/.gitignore	Appended dist/ directory to ignore list, with a comment noting GoReleaser initialization.
go/pkg/codes/constants_gen.go go/pkg/codes/generate.go	Removed timestamp comment and associated code/imports from generated Go constants file.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub
    participant GitHub Actions
    participant GoReleaser
    participant Docker

    Developer->>GitHub: Push tag or open PR
    GitHub->>GitHub Actions: Trigger release workflow
    GitHub Actions->>GoReleaser: Run GoReleaser in ./go directory
    GoReleaser->>GoReleaser: Run pre-build hooks (tidy, generate, fmt)
    GoReleaser->>GoReleaser: Build binaries (Linux, Windows, Darwin)
    GoReleaser->>Docker: Build container image with unkey binary
    GoReleaser->>GoReleaser: Create archives and changelog
    GoReleaser->>GitHub Actions: Complete release steps (skip publish)

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06e80a4 and 5fb7bb5.

⛔ Files ignored due to path filters (1)

• go/go.sum is excluded by !**/*.sum

📒 Files selected for processing (6)

• .github/workflows/release.yaml (1 hunks)
• go/.gitignore (1 hunks)
• go/.goreleaser.yaml (1 hunks)
• go/goreleaser.Dockerfile (1 hunks)
• go/pkg/codes/constants_gen.go (0 hunks)
• go/pkg/codes/generate.go (0 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.
Here is an example:

<type>[optional scope]: <description>
fix: I fixed something for Unkey

Details:

No release type found in pull request title "Goreleaser". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit