Skip to content

Update dependencies #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2025
Merged

Update dependencies #78

merged 1 commit into from
Apr 15, 2025

Conversation

scottrepreneur
Copy link
Contributor

@scottrepreneur scottrepreneur commented Apr 11, 2025

Closes BUILD-236

  • update viem
  • use pnpm instead of yarn

Summary by CodeRabbit

  • Chores

    • Migrated to a new package management system and upgraded the Node.js environment for improved build and test reliability.
    • Updated testing commands and several dependency versions to ensure enhanced compatibility and performance.
    • Excluded pnpm-lock.yaml from Prettier processing.
  • New Features

    • Introduced an optimized configuration to streamline dependency bundling during the build process.

@scottrepreneur scottrepreneur requested a review from a team as a code owner April 11, 2025 20:03
Copy link

coderabbitai bot commented Apr 11, 2025

Warning

Rate limit exceeded

@scottrepreneur has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 8 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 2b449c7 and 587cd69.

⛔ Files ignored due to path filters (2)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (5)
  • .github/workflows/bundle.yml (1 hunks)
  • .github/workflows/test.yml (2 hunks)
  • .prettierignore (1 hunks)
  • package.json (2 hunks)
  • pnpm-workspace.yaml (1 hunks)

Walkthrough

The changes update the repository's continuous integration workflows and dependency management. The Node.js version in the CI workflows has been increased from 18.16.1 to 20, and commands previously executed with Yarn are now executed with pnpm. The workflows now include a step to install pnpm (version 10) with the installation flag disabled. Additionally, the project's testing script in package.json has been updated to use pnpm, and several dependency versions have been bumped. A new configuration option in the pnpm-workspace.yaml file now specifies built dependencies.

Changes

Files Change Summary
.github/.../bundle.yml
.github/.../test.yml
Updated Node.js version to 20; replaced Yarn commands with pnpm for install, test, bundle, and format steps; added a step to install pnpm (v10, run_install false).
package.json Updated test script to use pnpm jest test.ts -i; bumped dependency versions for @hatsprotocol/modules-sdk (1.0.0 → 1.5.0), @viem/anvil (0.0.5 → 0.0.10), and viem (1.16.5 → 2.26.3).
pnpm-workspace.yaml Added new configuration option onlyBuiltDependencies with esbuild specified as the only dependency to build.
.prettierignore Added new entry pnpm-lock.yaml to exclude from Prettier processing.

Sequence Diagram(s)

sequenceDiagram
    participant CI as GitHub Actions
    participant Node as Node Environment (v20)
    participant PNPM as PNPM Installer (v10)
    participant Cmd as Workflow Commands

    CI->>Node: Setup Node environment (v20)
    Node->>PNPM: Run pnpm installation step
    PNPM->>Cmd: Execute install, bundle, test, and formatting commands via pnpm
    Cmd->>CI: Return execution status
Loading

Poem

I'm a rabbit in the code burrow,
Hopping through updates with a merry glow.
Yarn has hopped away for pnpm's delight,
Node leaps ahead to version twenty, bright.
With dependencies upgraded, my path is clear,
I waddle on in CI cheer! 🐰✨


🪧 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@scottrepreneur scottrepreneur force-pushed the chore/update-deps branch 2 times, most recently from e48fac0 to ad4eb4a Compare April 11, 2025 20:09
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
pnpm-workspace.yaml (1)

1-2: New Configuration Option: onlyBuiltDependencies

The new configuration option specifying that only esbuild should be built is clear and concise. Consider adding an inline comment to explain its purpose or usage context for future maintainers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1f63d3a and e48fac0.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (4)
  • .github/workflows/bundle.yml (1 hunks)
  • .github/workflows/test.yml (2 hunks)
  • package.json (2 hunks)
  • pnpm-workspace.yaml (1 hunks)
🔇 Additional comments (16)
.github/workflows/bundle.yml (4)

23-24: Updated Node.js Version

The setup step now specifies node-version: 20, which aligns with the project’s updated requirements. Please verify that all related tooling is compatible with Node.js 20.


25-28: PNPM Installation Step

The workflow now installs PNPM using pnpm/action-setup@v4 with version 10 and run_install set to false. This configuration looks correct; just ensure that downstream steps do not expect an automatic install.


32-32: Installation Command Updated

The command to install dependencies has been updated to use PNPM (pnpm install --frozen-lockfile). This change is in line with the overall transition from Yarn to PNPM.


35-36: Bundling Commands Updated

The bundling commands now use PNPM (pnpm bundle and pnpm format-bundle). Verify that these commands produce the intended output equivalent to the previous Yarn commands.

package.json (4)

8-8: Test Script Migration to PNPM

The test script has been updated to run with PNPM (pnpm jest test.ts -i), which is consistent with the project's shift in package management.


14-14: Dependency Update: @hatsprotocol/modules-sdk

The version bump to 1.5.0 might introduce breaking changes. Please verify that any API changes from this upgrade are fully addressed in the project documentation and tests.


16-16: Dependency Update: @viem/anvil

Upgrading to version 0.0.10 appears straightforward. Ensure that this dependency is compatible with your codebase and that its new version has been validated.


27-27: Major Version Update: viem

The update of viem to 2.26.3 is a significant change. Please double-check that any breaking changes associated with this major version bump have been handled.

.github/workflows/test.yml (8)

32-32: Test-Fork Job: Installation Command

The installation command in the test-fork job is updated to use PNPM. This change is consistent with the overall migration.


34-34: Test-Fork Job: Format Check Command

The format check command now uses PNPM (pnpm prettier . --check), which aligns with the new dependency management strategy.


40-40: Test-Fork Job: Test Command Updated

Switching to pnpm test for running tests in the test-fork job is appropriate. Please ensure that this change does not affect the test output format or expectations.


61-62: Test-Branch Job: Node.js Version Update

The test-branch job now explicitly uses Node.js version 20. This matches the Node.js upgrade in other workflows; however, consider whether the test-fork job should also be aligned if uniformity is desired.


63-66: Test-Branch Job: PNPM Setup

The PNPM setup step is correctly configured with pnpm/action-setup@v4 at version 10 and run_install set to false. This is consistent with the bundle workflow.


70-70: Test-Branch Job: Install Command

The installation command in the test-branch job has been updated to use PNPM, matching the new workflow requirements.


72-72: Test-Branch Job: Format Check Command

Updating the format check command to PNPM (pnpm prettier . --check) is correctly applied.


78-78: Test-Branch Job: Test Command

The test command now calls pnpm test, which aligns with the changes in the workflow and package scripts.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
.github/workflows/test.yml (1)

26-29: Node.js Version Inconsistency in test-fork Job
While the test-branch job has been updated to use Node.js version 20, the test-fork job still specifies Node.js version 18.16.1. For consistency across CI jobs, consider updating the node-version in test-fork as well, assuming there are no compatibility issues with forks.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Lite

📥 Commits

Reviewing files that changed from the base of the PR and between e48fac0 and 2b449c7.

⛔ Files ignored due to path filters (2)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (5)
  • .github/workflows/bundle.yml (1 hunks)
  • .github/workflows/test.yml (2 hunks)
  • .prettierignore (1 hunks)
  • package.json (2 hunks)
  • pnpm-workspace.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .prettierignore
🚧 Files skipped from review as they are similar to previous changes (2)
  • pnpm-workspace.yaml
  • package.json
🔇 Additional comments (8)
.github/workflows/bundle.yml (4)

23-24: Node.js Version Update to 20
The Node.js version has been updated from a previous lower version to 20. This ensures that the workflow uses a more recent runtime with potential performance and feature improvements. Please confirm that all dependent tasks and modules are compatible with Node 20.


25-28: Introduction of pnpm Installation Step
The workflow now installs pnpm (version 10) using pnpm/action-setup@v4 with run_install set to false. This change correctly transitions the dependency management from Yarn to pnpm as intended.


32-32: Updated Install Command
The installation command has been changed to pnpm install --frozen-lockfile, which aligns with the new package manager configuration. This update is consistent and clear.


35-36: Updated Bundling Commands
The bundling steps now use pnpm bundle and pnpm format-bundle instead of the Yarn commands. This update is well-aligned with the overall migration to pnpm.

.github/workflows/test.yml (4)

32-34: Transition to pnpm in test-fork Job
The installation (pnpm install --frozen-lockfile) and formatting check (pnpm prettier . --check) commands in the test-fork job have been correctly updated from Yarn to pnpm. This aligns with the project's overall dependency management strategy.


40-40: Updated Test Command in test-fork Job
The test command has been modified to use pnpm test. This update is consistent with the other changes in the workflow.


61-66: Node.js Version and pnpm Setup in test-branch Job
In the test-branch job, the node-version has been updated to 20, and a new step to install pnpm (version 10 with run_install: false) has been added. These changes correctly reflect the overall update from Yarn to pnpm and the upgraded Node.js environment.


70-78: Updated Commands in test-branch Job
The installation, format check, and test commands in test-branch have been updated to use pnpm commands (pnpm install --frozen-lockfile, pnpm prettier . --check, and pnpm test). These changes are implemented consistently and should work seamlessly with the rest of the CI setup.

Copy link
Member

@spengrah spengrah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link

@YamineRL YamineRL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@scottrepreneur scottrepreneur merged commit 703c26a into submissions Apr 15, 2025
3 checks passed
@scottrepreneur scottrepreneur deleted the chore/update-deps branch April 15, 2025 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants