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

Release/1.2.36 #555

Merged
merged 2 commits into from
Oct 14, 2024
Merged

Release/1.2.36 #555

merged 2 commits into from
Oct 14, 2024

Conversation

ttypic
Copy link
Contributor

@ttypic ttypic commented Oct 11, 2024

Summary by CodeRabbit

  • New Features

    • Updated version of the Ably Flutter Plugin to 1.2.36, indicating potential new features and improvements.
  • Bug Fixes

    • Resolved an error occurring during the Android build (issue Error on Android Build #551).
    • Addressed compilation issues on fresh Android projects and errors in Realtime client subscriptions after hot restart in previous versions.
  • Documentation

    • Changelog updated to reflect the new version and associated fixes.
    • README updated to indicate the new dependency version.

Copy link

coderabbitai bot commented Oct 11, 2024

Walkthrough

The changes in this pull request involve updates to the CHANGELOG.md, README.md, and pubspec.yaml files for the Ably Flutter Plugin. A new version entry for 1.2.36 has been added to the changelog, documenting a bug fix related to an Android build issue. The README file reflects an updated dependency version from 1.2.35 to 1.2.36, and the version in the pubspec.yaml file has also been incremented accordingly.

Changes

File Change Summary
CHANGELOG.md Added new version entry for 1.2.36, including bug fix for Android build error (#551).
README.md Updated ably_flutter dependency version from ^1.2.35 to ^1.2.36.
pubspec.yaml Incremented version number from 1.2.35 to 1.2.36.

Possibly related PRs

  • [ECO-5020] fix: update AGP plugin #552: This PR updates the Android Gradle Plugin and addresses compilation issues, which are directly related to the bug fix noted in the main PR regarding errors during the Android build.
  • Release/1.2.35 #553: This PR includes a version update in the changelog and documentation for version 1.2.35, which is relevant as the main PR updates the changelog for version 1.2.36, indicating a continuous progression in versioning and bug fixes.

Suggested reviewers

  • umair-ably
  • sacOO7

Poem

In the garden where code does bloom,
A version hops, dispelling gloom.
From thirty-five to thirty-six,
Fixes and updates, a clever mix.
With every change, we leap and play,
In the world of Flutter, hip-hip-hooray! 🐇✨


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

@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 (1)
CHANGELOG.md (1)

1-10: Consider adding a brief summary of major changes at the top of the changelog.

The changelog is well-structured and informative. To further improve its usefulness, consider adding a brief summary of major changes or highlights at the top of the file. This would give readers a quick overview of the most important updates without having to scroll through the entire document.

For example:

# Changelog

## Highlights
- v1.2.36: Fixed Android build error (latest release)
- v1.2.0: Added support for message extras and its extensions
- v1.2.0-preview.1: Major version alignment with other Ably client libraries

[Detailed changelog entries follow]

This addition would make it easier for users to quickly identify significant changes across versions.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ec88c86 and b3891a1.

⛔ Files ignored due to path filters (4)
  • example/ios/Podfile.lock is excluded by !**/*.lock
  • example/pubspec.lock is excluded by !**/*.lock
  • test_integration/ios/Podfile.lock is excluded by !**/*.lock
  • test_integration/pubspec.lock is excluded by !**/*.lock
📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • README.md (1 hunks)
  • pubspec.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • pubspec.yaml
🧰 Additional context used
🔇 Additional comments (1)
CHANGELOG.md (1)

3-9: LGTM: New version entry is well-formatted and informative.

The new version entry for 1.2.36 is correctly formatted and includes all necessary information:

  • Version number with link to the corresponding tree
  • Full changelog link
  • Clear description of the bug fix with a link to the related issue

This addition maintains consistency with the rest of the changelog.

README.md Show resolved Hide resolved
Copy link
Collaborator

@sacOO7 sacOO7 left a comment

Choose a reason for hiding this comment

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

LGTM

@ttypic ttypic merged commit ccdd598 into main Oct 14, 2024
9 checks passed
@ttypic ttypic deleted the release/1.2.36 branch October 14, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants