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

Added info about related to the silent release of NIM #16364

Merged
merged 1 commit into from
May 16, 2024

Conversation

Reinmar
Copy link
Member

@Reinmar Reinmar commented May 15, 2024

Suggested merge commit message (convention)

Docs: Added info about related to the silent release of NIM.


Additional information

See: #16360 (comment)

Copy link
Contributor

coderabbitai bot commented May 15, 2024

Warning

Rate Limit Exceeded

@Reinmar has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 47 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 Files that changed from the base of the PR and between df3fd55a882b3bc03bbf0619827c03b52ba33d62 and 62a4823.

Walkthrough

The ckeditor5 package now includes all official @ckeditor/ckeditor5-* packages as dependencies, simplifying installations and module imports for developers within the CKEditor 5 ecosystem.

Changes

File Change Summary
CHANGELOG.md Updated to reflect the inclusion of all official @ckeditor/ckeditor5-* packages as dependencies.

This update consolidates the ckeditor5 package, serving as a comprehensive hub for CKEditor 5 modules.


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>.
    • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

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

Out of diff range and nitpick comments (2)
CHANGELOG.md (2)

Line range hint 180-180: Remove consecutive blank lines for better readability.

- 

Line range hint 177-177: Surround lists with blank lines for better readability.

+ 
* The `ckeditor5` package now lists all other official `@ckeditor/ckeditor5-*` packages as dependencies. This is a preparatory step for the upcoming [new installation methods](https://github.com/ckeditor/ckeditor5/issues/15502). These changes will transform the ckeditor5 package into an aggregate for all official packages, simplifying module imports.
+ 

CHANGELOG.md Outdated
@@ -12,6 +12,7 @@ We have also added [menu bar](https://ckeditor.com/docs/ckeditor5/latest/feature
### MINOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)

* **[ui](https://www.npmjs.com/package/@ckeditor/ckeditor5-ui)**: The region name argument of the `AriaLiveAnnouncer#announce()` method has been dropped. Please check out the latest API documentation for more information.
* The `ckeditor5` package now lists all other official `@ckeditor/ckeditor5-*` packages as dependencies. This is a preparatory step for the upcoming [new installation methods](https://github.com/ckeditor/ckeditor5/issues/15502). These changes will transform the ckeditor5 package into an aggregate for all official packages, simplifying module imports.
Copy link
Contributor

Choose a reason for hiding this comment

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

Use setext heading style for consistency.

- ### MINOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)
+ MINOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)
+ ---------------------------------------------------------------------------------------------------------------------------------

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
* The `ckeditor5` package now lists all other official `@ckeditor/ckeditor5-*` packages as dependencies. This is a preparatory step for the upcoming [new installation methods](https://github.com/ckeditor/ckeditor5/issues/15502). These changes will transform the ckeditor5 package into an aggregate for all official packages, simplifying module imports.
MINOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)
---------------------------------------------------------------------------------------------------------------------------------
* The `ckeditor5` package now lists all other official `@ckeditor/ckeditor5-*` packages as dependencies. This is a preparatory step for the upcoming [new installation methods](https://github.com/ckeditor/ckeditor5/issues/15502). These changes will transform the ckeditor5 package into an aggregate for all official packages, simplifying module imports.

@Reinmar Reinmar force-pushed the changelog-suggestion branch from ebea867 to df3fd55 Compare May 15, 2024 21:15
@Reinmar Reinmar force-pushed the changelog-suggestion branch from df3fd55 to 62a4823 Compare May 15, 2024 21:15
Copy link
Member

@Witoso Witoso left a comment

Choose a reason for hiding this comment

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

LGTM

@Witoso Witoso merged commit e646739 into release May 16, 2024
7 checks passed
@Witoso Witoso deleted the changelog-suggestion branch May 16, 2024 07:22
@@ -12,6 +12,7 @@ We have also added [menu bar](https://ckeditor.com/docs/ckeditor5/latest/feature
### MINOR BREAKING CHANGES [ℹ️](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html#major-and-minor-breaking-changes)

* **[ui](https://www.npmjs.com/package/@ckeditor/ckeditor5-ui)**: The region name argument of the `AriaLiveAnnouncer#announce()` method has been dropped. Please check out the latest API documentation for more information.
* The `ckeditor5` package now lists all other official `@ckeditor/ckeditor5-*` packages as dependencies. This is a preparatory step for the upcoming [new installation methods](https://github.com/ckeditor/ckeditor5/issues/15502). These changes will transform the `ckeditor5` package into an aggregate for all official packages, simplifying module imports.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* The `ckeditor5` package now lists all other official `@ckeditor/ckeditor5-*` packages as dependencies. This is a preparatory step for the upcoming [new installation methods](https://github.com/ckeditor/ckeditor5/issues/15502). These changes will transform the `ckeditor5` package into an aggregate for all official packages, simplifying module imports.
* The `ckeditor5` package now lists all other official open-source `@ckeditor/ckeditor5-*` packages as dependencies. This is a preparatory step for the upcoming [new installation methods](https://github.com/ckeditor/ckeditor5/issues/15502). These changes will transform the `ckeditor5` package into an aggregate for all official packages, simplifying module imports.

@bnf
Copy link

bnf commented May 16, 2024

As asked in #16360 – will your refactor the codebase to make the ckeditor5 package optional, importing from @ckeditor/ckeditor5-* directly instead of ckeditor5/src/?

With this change ckeditor5 package got two roles:

  • central package for all packages for engine/library methods
  • bundle for all open-source packages

That means every @ckeditor/ckeditor5-* that depends on ckeditor5 will pull in every other open-source @ckeditor/ckeditor5-* package via the transitive dependency through ckeditor5.

@Witoso
Copy link
Member

Witoso commented May 16, 2024

As far as I know, this cannot happen yet, as we will continue to support old installation methods for a while. This refactor will occur once the deprecation timeline for old methods is complete.

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.

4 participants