Skip to content

Conversation

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Nov 4, 2024

Resolve #178

  • It makes the --next release similar to how the SDK monorepo does it.

Example:
If we merge to main the new CI does the following:

  • Check type of release needed:
    • "stable" if we increased the package number in the package.json
    • "next" if we did not increase but there is a difference in the git history for that package specifically, 0.2.0 becomes 0.2.1-next.1
    • "none" if no change is done

Summary by CodeRabbit

  • New Features
    • Introduced a new script for determining the release type (check-release-type.sh).
    • Added a script to automate the preparation and publishing of the next release version (publish-next-release.sh).
  • Improvements
    • Streamlined the release process by distinguishing between stable and next version releases.
    • Enhanced job structure in the release workflow for better handling of multiple packages.
  • Removals
    • Deprecated the previous script for checking if a release was needed (is-release-needed.sh).

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request primarily involve the .github/workflows/npm-publish.yaml workflow file, which has been restructured to support both stable and next releases of npm packages. A new script, check-release-type.sh, has been added to determine the release type based on version checks and code changes. Additionally, the previous script is-release-needed.sh has been removed. A new script, publish-next-release.sh, has also been introduced to automate the publishing of the next version. These modifications streamline the release process by clearly defining the conditions for different types of releases.

Changes

File Path Change Summary
.github/workflows/npm-publish.yaml Updated job structure to include matrix strategy, removed old steps, added Check release type, and conditional publishing steps for stable and next versions.
scripts/check-release-type.sh New script added to determine release type (stable or next) based on version and code changes.
scripts/is-release-needed.sh Deleted script that checked if the current version was already published on npm.
scripts/publish-next-release.sh New script added to automate the preparation and publishing of the next release version.

Assessment against linked issues

Objective Addressed Explanation
Update the npm package release to make --next releases (#178)

Possibly related PRs

  • feat: updated the workflow and if release needed #65: The changes in the npm-publish.yaml workflow are directly related to the modifications made in the main PR, particularly in how the release process is structured and the handling of version checks.
  • chore: increase package size for release #125: While this PR focuses on version increments for multiple packages, it is indirectly related as it aligns with the overall theme of managing package releases, which is a key aspect of the main PR's changes.

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
Member

@rodrigopavezi rodrigopavezi left a comment

Choose a reason for hiding this comment

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

looks good 👍

@aimensahnoun aimensahnoun merged commit c235bff into main Nov 4, 2024
1 check was pending
@aimensahnoun aimensahnoun deleted the 178-update-the-npm-package-release-to-make---next-releases branch November 4, 2024 12:16
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.

Update the npm package release to make --next releases

3 participants