Skip to content

Conversation

@rodrigopavezi
Copy link
Member

@rodrigopavezi rodrigopavezi commented Dec 3, 2024

Motivation

I would like to have an easy way to version the packages.

Changes

Add turbobuild recommend tool for doing monorepo packages versioning which is changeset

Reference: https://turbo.build/repo/docs/guides/publishing-libraries

Summary by CodeRabbit

Release Notes

  • New Features

    • Added a new README section for managing package versions using Changesets.
    • Integrated Lit Protocol Encryption into the invoice creation and dashboard packages for enhanced security.
  • Updates

    • Updated version numbers for the @requestnetwork/create-invoice-form and @requestnetwork/invoice-dashboard packages to 0.12.0.
    • Introduced a new configuration file for managing changesets.
  • Documentation

    • Added a README file in the .changeset directory with an introduction to the Changesets tool.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 3, 2024

Warning

Rate limit exceeded

@rodrigopavezi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 37 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 ae4301e and 623a305.

Walkthrough

This pull request introduces several changes related to the management of changesets for versioning and publishing within the project. A new README file and configuration file are added to the .changeset directory. The README provides an introduction to the Changesets tool, while the configuration file specifies settings for managing changesets. Additionally, updates are made to the package.json files for both the create-invoice-form and invoice-dashboard packages, including version increments and the addition of a new dependency. Changelog entries are also created for the updated packages.

Changes

File Path Change Summary
.changeset/README.md New file added with an introduction to the Changesets tool and links to documentation.
.changeset/config.json New configuration file added with settings for managing changesets.
README.md New section titled "Release" added, detailing package version management using changesets.
package.json (for @requestnetwork/web-components) New dependency added: "@changesets/cli": "^2.27.10" in the dependencies section.
packages/create-invoice-form/CHANGELOG.md New version entry 0.12.0 added, with a description of Lit Protocol Encryption integration.
packages/create-invoice-form/package.json Version updated from 0.11.3 to 0.12.0.
packages/invoice-dashboard/CHANGELOG.md New version entry 0.12.0 added, noting the integration of Lit Protocol Encryption.
packages/invoice-dashboard/package.json Version updated from 0.11.1 to 0.12.0.

Possibly related PRs

Suggested reviewers

  • MantisClone
  • aimensahnoun
  • sstefdev

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

@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: 1

🧹 Outside diff range and nitpick comments (3)
package.json (2)

31-31: Consider pinning the exact version of @changesets/cli

While using ^2.27.10 allows for minor version updates, it's recommended to pin the exact version to ensure consistent behavior across all environments and prevent unexpected issues during automated releases.

-    "@changesets/cli": "^2.27.10",
+    "@changesets/cli": "2.27.10",

Line range hint 10-20: Add changeset-related npm scripts for better developer experience

Consider adding dedicated scripts for common changeset operations to standardize the release workflow.

   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "clean": "find . -path './node_modules' -prune -o -name 'dist' -type d -exec rm -rf '{}' \\; -printf '%p deleted\\n' 2>/dev/null",
     "deep-clean": "find . -name 'node_modules' -type d -prune -print -exec rm -rf '{}' \\;",
     "build": "turbo run build",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "changeset publish",
     "build:form": "turbo run build --filter=@requestnetwork/create-invoice-form",
README.md (1)

78-78: Fix grammar: Add missing article

Add "the" before "changeset command" for better readability.

-Run changeset command to create a changeset file.
+Run the changeset command to create a changeset file.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~78-~78: You might be missing the article “the” here.
Context: ... --workspace=other ``` ## Release Run changeset command to create a changeset file. ``...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cb88792 and ae4301e.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (8)
  • .changeset/README.md (1 hunks)
  • .changeset/config.json (1 hunks)
  • README.md (1 hunks)
  • package.json (1 hunks)
  • packages/create-invoice-form/CHANGELOG.md (1 hunks)
  • packages/create-invoice-form/package.json (1 hunks)
  • packages/invoice-dashboard/CHANGELOG.md (1 hunks)
  • packages/invoice-dashboard/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (6)
  • packages/invoice-dashboard/CHANGELOG.md
  • packages/create-invoice-form/CHANGELOG.md
  • .changeset/README.md
  • .changeset/config.json
  • packages/invoice-dashboard/package.json
  • packages/create-invoice-form/package.json
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~78-~78: You might be missing the article “the” here.
Context: ... --workspace=other ``` ## Release Run changeset command to create a changeset file. ``...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

@rodrigopavezi rodrigopavezi merged commit 7933499 into main Dec 3, 2024
1 check passed
@rodrigopavezi rodrigopavezi deleted the chore/enhance-versioning branch December 3, 2024 12:19
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