ci: add release automation

[jamestelfer]

Enables the use of GoReleaser to create binaries when a v* tag is created.

Summary by CodeRabbit

• New Features

  • Introduced an automated release workflow for the Go application, streamlining the release process.
  • Added configuration for GoReleaser to enhance binary building and release management for multiple platforms.

• Chores

  • Updated .gitignore to exclude the dist/ directory from version control.

[coderabbitai]

Walkthrough

This update introduces significant enhancements to the Go application release process. A new GitHub Actions workflow automates the release procedure, ensuring the correct environment is set for builds. Additionally, the .gitignore file now excludes the dist/ directory to streamline version control. A comprehensive configuration for GoReleaser has also been added, optimising builds for multiple platforms and establishing a robust framework for packaging and releasing the application efficiently.

Changes

File(s)	Summary
.github/workflows/release.yaml	New GitHub Actions workflow for automating Go app releases, including checkout and Go setup.
.gitignore	Added entry to ignore dist/ directory to keep version control tidy.
.goreleaser.yaml	New config for GoReleaser, defining builds and releases for multiple OS and architectures.

Poem

🐇 In the burrow of code, changes arise,
With workflows that dance and builds that surprise.
Ignoring the clutter, our project takes flight,
GoReleaser’s magic makes every release bright.
So hop along, friends, let’s celebrate cheer,
For smoother deployments are finally here! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[codecov]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0fbd623 and 83f7b2c.

Files selected for processing (3)

• .github/workflows/release.yaml (1 hunks)
• .gitignore (1 hunks)
• .goreleaser.yaml (1 hunks)

Files skipped from review due to trivial changes (1)

• .gitignore

Additional comments not posted (9)

.github/workflows/release.yaml (4)

1-7: Workflow name and trigger configuration look good.

The workflow is correctly named "Release" and is appropriately triggered by push events with tags matching the pattern v*.

---

9-10: Permissions configuration is appropriate.

The contents permission is set to write, which is necessary for creating releases and uploading assets.

---

12-17: Job configuration is appropriate.

The job goreleaser is defined with an environment Publish and runs on ubuntu-latest, which is a standard practice.

---

18-38: Job steps are well-defined.

The steps for checking out the code, configuring Go, and running GoReleaser are necessary for the release process.

.goreleaser.yaml (5)

1-2: Schema version is correctly set.

The schema version is set to 2, ensuring compatibility with the latest features and improvements in GoReleaser.

---

4-20: Builds configuration looks good.

The builds section defines a build with id release, binary name docker-credential-env, and various settings for environment, flags, ldflags, OS, and architecture. These configurations are appropriate for building the binary for multiple platforms.

---

21-22: Checksum configuration is appropriate.

The checksum section defines a name template for the checksum file, which is necessary for verifying the integrity of the released binaries.

---

24-26: Archives configuration is appropriate.

The archives section defines the format as tar.gz and a name template for the archives, which is standard for packaging binaries for multiple platforms.

---

28-39: Changelog and release configuration look good.

The changelog section uses GitHub-native changelog and sorts entries in ascending order. The release section defines a prerelease setting and a header with instructions for using the binary. These configurations are appropriate for generating a changelog and providing release instructions.