chore: improve release

[zakir-code]

Summary by CodeRabbit

• Chores
  • Improved release workflow for better efficiency and clarity.
  • Updated release note generation process to include upgrade instructions and highlights.

[coderabbitai]

Walkthrough

The recent updates streamline the release process by refining workflows, enhancing versioning, and improving release note templates. Key changes include renaming jobs, adjusting checkout steps, updating tag fetching, and modifying release note generation. The .goreleaser.yml file now includes better versioning and naming conventions, while the Makefile and contrib/scripts/release-note.sh have been optimized for clarity and functionality.

Changes

Files	Change Summary
.github/workflows/release.yml	Updated tag patterns, renamed jobs, adjusted checkout steps, explicitly fetched tags, modified release note generation, renamed release step, and refined the release environment setup.
.goreleaser.yml	Updated binary paths, added -trimpath flag, modified versioning format in ldflags, adjusted archive and checksum naming templates, introduced a new snapshot section, and enhanced release notes with build and Docker image instructions.
Makefile	Updated PACKAGE_NAME variable, modified release-dry-run and release targets to use --skip=validate and --skip=publish, and updated --release-notes option.
contrib/scripts/release-note.sh	Enhanced release note template with sections for upgrade instructions and highlights, and modified the link to the full changelog.

Poem

In the code where changes flow,
Release notes now clearly show,
With tags fetched and binaries neat,
Versioning feels so complete.
Workflows refined, steps aligned,
A smoother path we now find,
Our project grows, in leaps and bounds,
With every release, new grounds.

---

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

[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 2ffa5e7 and 3caaad9.

Files selected for processing (4)

• .github/workflows/release.yml (1 hunks)
• .goreleaser.yml (7 hunks)
• Makefile (3 hunks)
• contrib/scripts/release-note.sh (1 hunks)

Files skipped from review due to trivial changes (2)

• Makefile
• contrib/scripts/release-note.sh

Additional comments not posted (12)

.github/workflows/release.yml (6)

6-7: Updated tag patterns to include both regular and RC versions. This is a good practice for handling different release stages.

---

14-17: The modification to fetch all tags and history (fetch-depth: 0) is a robust approach for workflows that depend on the entire git history.

---

18-19: Adding a step to forcefully fetch tags enhances the reliability of the workflow by ensuring the latest tags are used.

---

20-23: Improvements to the release note generation step (making the script executable and running it with the correct tag version) enhance the automation and accuracy of the process.

---

24-27: Setting the GITHUB_TOKEN explicitly in the environment configuration enhances security and manageability.

---

28-28: Renaming the step to 'Release publish' improves clarity and maintainability of the workflow.

.goreleaser.yml (6)

8-8: Simplifying the binary path across various build configurations helps avoid path-related errors and makes the build process cleaner.

Also applies to: 24-24, 40-40, 56-56, 72-72

---

19-19: Adding the -trimpath flag enhances the privacy and security of the build by removing all file system paths from the compiled executable.

Also applies to: 35-35, 51-51, 67-67, 83-83

---

21-21: Updating the ldflags to include the version prefix and commit hash ensures that the build metadata is accurate and traceable.

Also applies to: 37-37, 53-53, 69-69, 86-86

---

89-90: Updating the naming templates for archives and checksums to include version and architecture details enhances the organization and retrievability of build artifacts.

Also applies to: 93-94

---

97-97: Adding a specific naming template for snapshots clearly distinguishes them from regular releases, which is useful for testing and development purposes.

---

107-123: Enhancements to the release section, including detailed instructions for building from source and pulling Docker images, provide clear guidance for users on how to use the software.