docs: document release verification with Cosign

[jamestelfer]

Summary by CodeRabbit

• New Features
  • Introduced a new document outlining the process for verifying software releases using cosign.
• Documentation
  • Expanded the Docker image description to clarify multi-platform support and included Mac binaries.
  • Removed the "Required functionality" section from the README for conciseness.
  • Added a note on the importance of verifying releases with cosign and provided detailed instructions.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve updates to the .goreleaser.yaml file to enhance the release section with clearer descriptions regarding multi-platform Docker images and the inclusion of Mac binaries. A new document, verifying-releases.md, has been introduced to guide users on verifying software releases using cosign. Additionally, the README.md file has had the "Required functionality" section removed for conciseness.

Changes

File	Change Summary
.goreleaser.yaml	Updated release section to clarify multi-platform support, include Mac binaries, and emphasize release verification with cosign.
README.md	Removed the "Required functionality" section for a more concise document.
docs/verifying-releases.md	Added a new document detailing the process for verifying software releases using cosign.

Possibly related PRs

• feat: sign released binaries and images with cosign #60: The changes in this PR involve the implementation of cosign for signing released binaries and images, which directly relates to the updates in the main PR regarding the emphasis on verifying releases using cosign.
• ci: fix errors in release process #61: This PR modifies the .goreleaser.yaml file to ensure that the signature file is generated during the signing process, which is relevant to the main PR's updates on the release section and the signing of artifacts.

Poem

In the meadow where code does play,
Changes bloom like flowers in May.
With cosign to guard our release,
And README trimmed for sweet peace.
A hop, a skip, let's verify,
With joy in our hearts, we'll fly high! 🐇✨

---

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>, 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 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.40%. Comparing base (b8d7da1) to head (6bbb904).
Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #65   +/-   ##
=======================================
  Coverage   90.40%   90.40%           
=======================================
  Files          13       13           
  Lines         521      521           
=======================================
  Hits          471      471           
  Misses         34       34           
  Partials       16       16           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.