Feat/release update

[MartianGreed]

Closes #

Introduced changes

Checklist

• Linked relevant issue
• Updated relevant documentation
• Added relevant tests
• Add a dedicated CI job for new examples
• Performed self-review of the code

Summary by CodeRabbit

• New Features
  • Introduced a "dry run" mode that lets users preview the release process without performing actual publishing or commits.
  • Enhanced the release workflow to streamline version updates, package building, conditional publishing, and release note generation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The GitHub Actions release workflow has been restructured to include a new dry_run input parameter, which allows simulating the release process without making actual changes. The workflow now sets up Node.js using actions/setup-node@v4 (with caching for pnpm), performs a version bump for packages, builds the packages, and conditionally publishes to npm and handles commits/tags based on whether dry_run is enabled. The release notes generation and GitHub release creation steps have been adjusted to either execute or merely output the intended actions when in dry run mode.

Changes

File(s)	Change Summary
.github/workflows/release.yaml	- Added a new dry_run boolean input parameter (default: false) with a description for a non-destructive release process. - Integrated a new Node.js setup step using actions/setup-node@v4 (Node.js version set to lts/*, with pnpm caching). - Revised steps for version bump, building, publishing, and release notes generation with conditional logic based on dry_run.

Sequence Diagram(s)

sequenceDiagram
    participant User as "Repository Trigger"
    participant Workflow as "Release Workflow"
    participant Node as "Node.js Setup"
    participant Version as "Version Packages"
    participant Build as "Build Packages"
    participant Publish as "Publish & Commit"
    participant DryRun as "Dry Run Output"

    User->>Workflow: Initiate release process
    Workflow->>Node: Setup Node.js environment (lts/*, pnpm cache)
    Workflow->>Version: Execute version bump (revert if dry_run)
    alt Dry Run is false
        Workflow->>Build: Build packages
        Workflow->>Publish: Publish to npm, handle commits & tags, generate release notes, create GitHub release
    else Dry Run is true
        Workflow->>DryRun: Output intended publishing actions without execution
    end

Loading

Poem

I’m a rabbit with code so neat,
Hopping through steps on this workflow street.
With a dry run to preview, oh so sly,
Node and versioning make my spirits fly.
Cheers to changes that keep our releases spry!
🐰✨

---

📜 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 6e90099 and a2411fd.

📒 Files selected for processing (1)

• .github/workflows/release.yaml (3 hunks)

---

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 generate docstrings to generate docstrings for 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.