Upgrade Release flow

[kamiazya]

Summary by CodeRabbit

• New Features

  • Integrated changeset tool to streamline release flow and versioning processes.
  • Added GitHub Action for Node.js and yarn setup, improving dependency management.

• Enhancements

  • Updated workflow to include improved steps for linting, testing, and building.
  • Introduced a versioning job for handling versioning tasks.

• Dependencies

  • Added @actions/exec, @changesets/changelog-github, and @changesets/cli as dependencies.
  • Updated Node.js version to 20.

[coderabbitai]

Walkthrough

The changes introduce a comprehensive setup for managing changesets, automating workflows, and versioning. This includes new configurations for the changeset tool, a streamlined GitHub Actions workflow, setup scripts for Node.js and yarn, and updates to dependencies. The project's package.json and .node-version files have been revised to align with these enhancements, ensuring a more efficient release process and improved dependency management.

Changes

File Path	Change Summary
.changeset/README.md	New README providing information on the purpose of the folder and using @changesets/cli.
.changeset/config.json	New configuration settings for managing changesets, specifying schema, changelog, repository details, etc.
.changeset/tasty-rats-cough.md	Introduces an upgrade to the Release flow incorporating changeset and a "setup-graphviz" patch.
.github/actions/setup/action.yaml	Introduces a setup action for Node.js and yarn within GitHub Actions.
.github/workflows/workflow.yaml	Significant workflow updates: new versioning job, reorganized steps, custom setup action for Node.js.
.node-version	Updated Node.js version to 20.
package.json	Added new dependencies and updated packageManager version.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Changesets CLI
    participant Repository

    Developer->>Repository: Commit changes
    GitHub Actions-->>Repository: Detect commit
    GitHub Actions->>GitHub Actions: Trigger workflow
    GitHub Actions->>Changesets CLI: Run changesets action
    Changesets CLI->>Repository: Update version and changelog
    GitHub Actions->>GitHub Actions: Setup Node.js and yarn
    GitHub Actions-->>GitHub Actions: Lint, test, build
    GitHub Actions-->>Developer: Notify success/failure

Loading

Poem

In code we trust, with yarn and Node,
Our changes flow, a cleaner load.
With actions set and versions new,
We weave the path for code to strew.
🌟 Merry commits, we build anew! 🌟

---

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 895205c and 90adfa9.

Files ignored due to path filters (1)

• yarn.lock is excluded by !**/yarn.lock, !**/*.lock

Files selected for processing (7)

• .changeset/README.md (1 hunks)
• .changeset/config.json (1 hunks)
• .changeset/tasty-rats-cough.md (1 hunks)
• .github/actions/setup/action.yaml (1 hunks)
• .github/workflows/workflow.yaml (3 hunks)
• .node-version (1 hunks)
• package.json (1 hunks)

Files skipped from review due to trivial changes (5)

• .changeset/README.md
• .changeset/config.json
• .changeset/tasty-rats-cough.md
• .github/actions/setup/action.yaml
• .node-version

Additional comments not posted (9)

package.json (4)

22-22: Approved addition of @actions/exec.
This dependency is essential for executing commands in GitHub Actions scripts, aligning well with the workflow enhancements.

---

27-27: Approved addition of @changesets/changelog-github.
This package facilitates automated changelog generation, which is crucial for maintaining clear project history and documentation.

---

28-28: Approved addition of @changesets/cli.
This tool is critical for managing versions and publishing, directly supporting the PR's objectives to upgrade release flows.

---

33-33: Approved updated package manager configuration.
Locking the yarn version enhances consistency and reproducibility across different development environments.

.github/workflows/workflow.yaml (5)

9-9: Approved updated actions/checkout action.
Updating to a newer version ensures access to recent fixes and features, improving reliability and performance of the checkout process.

Also applies to: 23-23, 37-37, 60-60, 81-81

---

11-11: Approved use of custom Setup action.
Utilizing a custom setup action centralizes configuration and ensures consistency across all workflow jobs.

Also applies to: 25-25, 39-39, 62-62, 83-83

---

27-27: Approved addition of Test step in unit-test job.
Separating the test step ensures that unit tests are run in an isolated and controlled environment, which is crucial for reliable CI/CD pipelines.

---

62-62: Approved addition of Download Artifact step in integration-test job.
This step is crucial for ensuring that necessary artifacts are available for integration tests, supporting the overall integrity of the testing process.

---

70-87: Approved addition of versioning job.
The new versioning job, utilizing changesets/action, strategically enhances the release management process, aligning with the PR's objectives to upgrade the release flow.