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 2.0.10 #589

Merged
merged 1 commit into from
Feb 19, 2025
Merged

Release 2.0.10 #589

merged 1 commit into from
Feb 19, 2025

Conversation

ttypic
Copy link
Contributor

@ttypic ttypic commented Feb 17, 2025

Fixed sync version of the library

Summary by CodeRabbit

  • Bug Fixes
    • Resolved an issue affecting synchronous behavior.
  • Chores
    • Upgraded the library version to v2.0.10.
  • Documentation
    • Added release notes for version v2.0.10.

@ttypic ttypic requested a review from VeskeR February 17, 2025 10:23
Copy link

coderabbitai bot commented Feb 17, 2025

Walkthrough

This update bumps the library version from 2.0.9 to 2.0.10. A new section for version v2.0.10 has been added to the changelog, noting that the sync version issue has been fixed. Both the library’s initialization file and the project configuration have been updated to reflect this version change. No modifications to functionality or code logic were made.

Changes

File(s) Change Summary
CHANGELOG.md Added a new section for [v2.0.10] with a note on fixed sync version
ably/init.py, pyproject.toml Updated version numbers from 2.0.9 to 2.0.10

Poem

Hoppy days arrive with each new version,
I'm a rabbit in a code burrow on a revision excursion!
The sync issue is fixed, no bug to confound,
In CHANGELOG and configs, the new version is found.
Leaping with joy as the updates abound!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3b383e4 and b11e7cf.

📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • ably/__init__.py (1 hunks)
  • pyproject.toml (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • ably/init.py
  • pyproject.toml
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: check (3.13)
  • GitHub Check: check (3.12)
  • GitHub Check: check (3.11)
  • GitHub Check: check (3.10)
  • GitHub Check: check (3.9)
  • GitHub Check: check (3.8)
🔇 Additional comments (1)
CHANGELOG.md (1)

3-6: New Version Changelog Section Addition
The new changelog section for version v2.0.10 has been added with a proper link and a concise description ("Fixed sync version of the library"). The formatting is consistent with the existing entries, and the update clearly communicates the version bump and its purpose.


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

I don't think we need separate version update for sync version of the library.
Step 8 of the release process mentions to generate sync library locally before running poetry build && poetry publish from step 9.

@ttypic ttypic changed the title chore: bump version number and update CHANGELOG.md Release 2.0.10 Feb 17, 2025
@ttypic
Copy link
Contributor Author

ttypic commented Feb 17, 2025

@sacOO7 I forgot to run this step, while releasing, so we need new release (that's why I hate manual releases)

@sacOO7
Copy link
Collaborator

sacOO7 commented Feb 17, 2025

@sacOO7 I forgot to run this step, while releasing, so we need new release (that's why I hate manual releases)

Okay, got it. Generally, I always follow Release Process steps for each SDK, since they vary a bit for each SDK.
Seems, you can delete current release as per https://stackoverflow.com/a/43603029/7363205, so you should be able to re-release 2.0.9 with sync code.

PS. I feel 2.0.9 is an incomplete release and we detected it early, so we can safely replace it

@ttypic
Copy link
Contributor Author

ttypic commented Feb 17, 2025

@sacOO7 It’s almost never a good idea to delete a published release unless there are legal or severe security issues

@sacOO7
Copy link
Collaborator

sacOO7 commented Feb 17, 2025

@sacOO7 It’s almost never a good idea to delete a published release unless there are legal or severe security issues

I really understand why it's never a good idea to delete a published release, but in our case we are not deleting it, rather replacing it with a complete release. Also, pypi provides a way to delete the package, meaning it has provided this feature for specific use-cases like ours.

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.

Going forward we should make sure, steps are followed as per standard release process.
Also, one of the reason I was suggesting to have a proper step for pushing tags, because it's easy to mistakenly push different naming convention for a tag.

@ttypic ttypic merged commit b7bd2ca into main Feb 19, 2025
3 of 10 checks passed
@ttypic ttypic deleted the release/2.0.10 branch February 19, 2025 16:01
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.

3 participants