Add workflow for releasing npm package

[kotAPI]

Summary by CodeRabbit

• New Features
  • Introduced an automated release process: when changes are merged with a valid version tag, the package is automatically built and published to npm using secure authentication.
  • This enhancement streamlines deployments, ensuring consistent and efficient updates for end-users.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new GitHub Actions workflow file, release.yml, has been introduced to automate npm releases. The workflow is triggered when pull requests to the main branch are merged. It checks out the repository, verifies the presence of a version tag in the format vX.Y.Z, and conditionally performs the release steps. If a valid tag is found, it sets up Node.js, installs dependencies, builds the package, and publishes it to npm using a secure authentication token.

Changes

File Path	Change Summary
.github/workflows/release.yml	New GitHub Actions workflow to automate npm releases. It triggers on merged PRs to main, checks for a version tag (vX.Y.Z), sets up Node.js, installs, builds, and publishes the package.

Sequence Diagram(s)

sequenceDiagram
    actor PR as "Pull Request"
    participant GH as "GitHub Actions"
    participant Repo as "Repository"
    participant npm as "npm Registry"
    
    PR->>GH: PR merged to main branch
    GH->>Repo: Checkout full repository
    GH->>Repo: Check for version tag "vX.Y.Z"
    alt Version tag exists
        GH->>GH: Set up Node.js environment
        GH->>Repo: Install dependencies (npm ci)
        GH->>Repo: Build package (npm run build)
        GH->>npm: Publish package using auth token
    else
        GH->>GH: No valid tag found, skip release steps
    end

Loading

Poem

Hoppin' through the code with glee,
I found a tag, oh joy, you see!
A workflow born to npm fly,
With Node and build, it reaches high.
A merry release in every byte,
CodeRabbit cheers deep into the night!
🐇✨

---

📜 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 148a1d7 and 02738ac.

📒 Files selected for processing (1)

• .github/workflows/release.yml (1 hunks)

---

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