Skip to content
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

fix: don't pin peer dep to exact version #1108

Merged
merged 2 commits into from
Dec 30, 2024
Merged

Conversation

juliusmarminge
Copy link
Member

@juliusmarminge juliusmarminge commented Dec 30, 2024

Summary by CodeRabbit

  • Chores
    • Enhanced dependency management scripts for release and workspace protocol handling
    • Improved version tracking for dependencies and peer dependencies
    • Added more robust checks when updating package configurations

Copy link

changeset-bot bot commented Dec 30, 2024

🦋 Changeset detected

Latest commit: 8490391

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages
Name Type
@uploadthing/expo Patch
@uploadthing/mime-types Patch
@uploadthing/nuxt Patch
@uploadthing/react Patch
@uploadthing/shared Patch
@uploadthing/solid Patch
@uploadthing/svelte Patch
uploadthing Patch
@uploadthing/vue Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Dec 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-uploadthing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 30, 2024 0:46am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
legacy-docs-uploadthing ⬜️ Ignored (Inspect) Visit Preview Dec 30, 2024 0:46am

Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

Warning

Rate limit exceeded

@juliusmarminge has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 34 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 c65fde9 and 8490391.

📒 Files selected for processing (1)
  • .changeset/large-dryers-worry.md (1 hunks)

Walkthrough

The pull request introduces modifications to two GitHub workflow scripts: release-canary.js and replace-workspace-protocol.ts. The changes focus on enhancing dependency management during the release process, specifically improving how workspace-linked dependencies are handled. Both scripts now include additional logic to process and update peerDependencies alongside dependencies, ensuring consistent versioning and replacement of workspace protocol dependencies.

Changes

File Change Summary
.github/release-canary.js Added a new loop to update peerDependencies with conditions similar to dependencies update logic, checking for workspace-linked dependencies
.github/replace-workspace-protocol.ts Enhanced dependency update logic to include conditions for checking "workspace:" prefix before replacing dependency values in both dependencies and peerDependencies

Sequence Diagram

sequenceDiagram
    participant Script as Release Script
    participant Dependencies as Package Dependencies
    participant Versions as Version Mapping

    Script->>Dependencies: Check Dependencies
    alt Is Workspace Dependency
        Dependencies->>Versions: Fetch Corresponding Version
        Versions-->>Dependencies: Replace Dependency Version
    end

    Script->>Dependencies: Check Peer Dependencies
    alt Is Workspace Dependency
        Dependencies->>Versions: Fetch Corresponding Version
        Versions-->>Dependencies: Replace Peer Dependency Version
    end
Loading

🪧 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. (Beta)
  • @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.

Copy link
Contributor

github-actions bot commented Dec 30, 2024

📦 Bundle size comparison

Bundle Size (gzip) Visualization
Main 29.30KB See Treemap 📊
PR (54c6e65) 29.30KB See Treemap 📊
Diff No change

Copy link
Contributor

A new canary is available for testing. You can install this latest build in your project with:

pnpm add @uploadthing/[email protected]
pnpm add @uploadthing/[email protected]
pnpm add @uploadthing/[email protected]
pnpm add @uploadthing/[email protected]
pnpm add @uploadthing/[email protected]
pnpm add @uploadthing/[email protected]
pnpm add @uploadthing/[email protected]
pnpm add [email protected]
pnpm add @uploadthing/[email protected]

@github-actions github-actions bot removed the release canary Trigger a canary release to npm label Dec 30, 2024
Copy link
Contributor

@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 (2)
.github/release-canary.js (1)

48-52: Consider consolidating the logic for updating dependencies and peerDependencies.

The logic for checking and updating peerDependencies is nearly identical to the one for dependencies. As a good-to-have refactoring, you could reduce duplication by extracting the common functionality into a helper function that handles both.

.github/replace-workspace-protocol.ts (1)

37-39: Consider extracting the common logic for dependencies and peerDependencies.

Currently, the code checks for workspace:... in dependencies and then replaces it with the appropriate version. This same pattern appears again for peer dependencies. Moving this logic into a small helper function could eliminate duplication and make the code more maintainable.

Would you like me to propose a refactor snippet that factors out this repeated logic?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c557f44 and c65fde9.

📒 Files selected for processing (2)
  • .github/release-canary.js (1 hunks)
  • .github/replace-workspace-protocol.ts (1 hunks)
🔇 Additional comments (2)
.github/release-canary.js (1)

44-44: Logic for replacing workspace dependencies looks good.

This condition ensures that the script updates only those dependencies that are declared via the workspace protocol and have a matching version in the versions object. It effectively prevents accidentally overwriting semver-based dependencies.

.github/replace-workspace-protocol.ts (1)

43-46: Validate fallback behavior when a workspace reference is not found.

If dep in packageVersions is satisfied but the entry in peerDependencies doesn't start with "workspace:", the code does nothing. This might be acceptable, but consider whether you need special handling in situations where the local package might not be strictly pinned with a workspace: prefix. This can help avoid accidental version mismatches.

Please confirm that you intentionally preserve any non-"workspace:" peer dependencies without modification.

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.

1 participant