Feat/integrate changesets

[MarcelOlsen]

Summary by CodeRabbit

• New Features
  • Integrated Changesets tool for automated versioning and publishing.
  • Added configuration and documentation for Changesets, including a dedicated guide and README.
• Chores
  • Updated project dependencies to include the Changesets CLI.
  • Simplified and automated the release workflow using Changesets in the CI/CD pipeline.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Alright, chat, here’s the rundown: this PR brings in the Changesets tool for automated versioning and publishing. It drops a bunch of config and docs, wires up the Changesets CLI, and totally rewrites the GitHub Actions workflow to use Changesets instead of that gnarly manual NPM publish logic. Documentation galore, config files, and a new workflow—let’s go!

Changes

File(s)	Summary
.changeset/README.md, CHANGESETS.md	Added documentation explaining Changesets usage, setup, and workflow.
.changeset/config.json	Added Changesets configuration specifying versioning, publishing, and changelog generation rules.
.changeset/integrate-changesets.md	Introduced a changeset for a minor update, describing integration and automation details.
.github/workflows/publish.yml	Replaced manual NPM publish workflow with Changesets-based automation using changesets/action.
package.json	Added @changesets/cli as a devDependency.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Changesets CLI
    participant NPM Registry

    Developer->>GitHub Actions: Push to master
    GitHub Actions->>Changesets CLI: Run version & publish commands
    Changesets CLI->>NPM Registry: Publish package (if version changed)
    Changesets CLI->>GitHub Actions: Create release PR / update changelog
    GitHub Actions->>Developer: Notify on release completion

Loading

Possibly related PRs

• Chore/clean git history #19: Both PRs modify the .github/workflows/publish.yml file, but this one replaces manual NPM publishing with Changesets automation.
• 🔧 Fix GitHub Actions permissions and NPM publish workflow #20: Also updates the publish workflow, focusing on permissions and conditional logic, while this PR fully switches to Changesets.

Poem

🚀
Oh, Changesets, you glorious beast,
Automating versions, our toil has ceased.
No more manual bumps or publish dread,
CI/CD now surges ahead!
With docs and config, the workflow’s tight—
Ship it, chat, we’re doing it right!

---

📜 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 c295041 and 1a95a8c.

⛔ Files ignored due to path filters (1)

• bun.lock is excluded by !**/*.lock

📒 Files selected for processing (6)

• .changeset/README.md (1 hunks)
• .changeset/config.json (1 hunks)
• .changeset/integrate-changesets.md (1 hunks)
• .github/workflows/publish.yml (2 hunks)
• CHANGESETS.md (1 hunks)
• package.json (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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in 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.