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 version 1.2.39 #2032

Merged
merged 1 commit into from
Feb 18, 2025
Merged

Release version 1.2.39 #2032

merged 1 commit into from
Feb 18, 2025

Conversation

lawrence-forooghian
Copy link
Collaborator

@lawrence-forooghian lawrence-forooghian commented Feb 18, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Resolved an issue where fallback hosts in custom environments now work as expected.
  • Documentation
    • Updated installation instructions and documentation to reference version 1.2.39.
  • Chores
    • Upgraded the package version from 1.2.38 to 1.2.39 for consistent versioning.

Copy link

coderabbitai bot commented Feb 18, 2025

Walkthrough

This pull request updates the version of the project from 1.2.38 to 1.2.39. The changes span documentation updates in the changelog, README, and configuration files, as well as version bumps in source code and test assertions. Bug fixes and improvements are briefly outlined in the changelog, and the expected version strings in various tests have been updated to ensure consistency with the new release.

Changes

Files Group Change Summary
CHANGELOG.md Added new version entry 1.2.39 with sections for bug fixes (fallback hosts issue) and other changes (API improvements), plus a link to the full changelog comparison.
README.md Updated the package version from 1.2.38 to 1.2.39 in installation instructions for Swift Package Manager and manual installations.
Scripts/jazzy.sh, Version.xcconfig Bumped module version in the Jazzy documentation script and updated the project version in configuration from 1.2.38 to 1.2.39.
Source/ARTClientInformation.m Updated the constant ARTClientInformation_libraryVersion from "1.2.38" to "1.2.39".
Test files:
ARTDefaultTests.swift
ClientInformationTests.swift
RealtimeClientConnectionTests.swift
RestClientTests.swift
WrapperSDKProxyTests.swift
Revised expected version strings in tests from "1.2.38" to "1.2.39" across various assertions and header validations.

Possibly related PRs

  • Release 1.2.35. #2001: Involved version number updates and corresponding test modifications, similar to the changes here.
  • Release/1.2.34 #1996: Addressed version updates in several key files including CHANGELOG.md, README.md, and source files, aligning with the current modifications.

Suggested reviewers

  • umair-ably

Poem

I'm a little rabbit, twitching my nose,
Hopping through the changes, where the new version grows.
From 1.2.38 to 1.2.39, our updates shine so bright,
Bugs fixed and docs updated, all set just right.
Carrots and code, together we thrive—happy coding, day and night!


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

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

🧹 Nitpick comments (1)
CHANGELOG.md (1)

15-16: Full Changelog URL Presentation
The final entry, "Full Changelog: 1.2.38...1.2.39", correctly provides a link comparing the previous version with the current release.
Note:
Static analysis (MD034) flags the use of a bare URL. While it is common in changelogs to display URLs in this manner, you might consider wrapping the URL in angle brackets (i.e. <https://...>) to satisfy markdownlint rules if needed.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

15-15: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 035a574 and e3734ad.

📒 Files selected for processing (10)
  • CHANGELOG.md (1 hunks)
  • README.md (2 hunks)
  • Scripts/jazzy.sh (1 hunks)
  • Source/ARTClientInformation.m (1 hunks)
  • Test/Tests/ARTDefaultTests.swift (1 hunks)
  • Test/Tests/ClientInformationTests.swift (3 hunks)
  • Test/Tests/RealtimeClientConnectionTests.swift (1 hunks)
  • Test/Tests/RestClientTests.swift (1 hunks)
  • Test/Tests/WrapperSDKProxyTests.swift (3 hunks)
  • Version.xcconfig (1 hunks)
✅ Files skipped from review due to trivial changes (7)
  • Version.xcconfig
  • Scripts/jazzy.sh
  • Test/Tests/ARTDefaultTests.swift
  • Source/ARTClientInformation.m
  • Test/Tests/WrapperSDKProxyTests.swift
  • README.md
  • Test/Tests/RealtimeClientConnectionTests.swift
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md

9-9: Bare URL used
null

(MD034, no-bare-urls)


13-13: Bare URL used
null

(MD034, no-bare-urls)


15-15: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: check (macOS, test_macOS)
  • GitHub Check: check (tvOS, test_tvOS17_2)
  • GitHub Check: check
  • GitHub Check: build
  • GitHub Check: check
  • GitHub Check: check (iOS, test_iOS17_2)
🔇 Additional comments (6)
Test/Tests/ClientInformationTests.swift (1)

12-12: LGTM! Version updates are consistent.

The version string updates from "1.2.38" to "1.2.39" in test assertions are consistent with the PR objectives.

Also applies to: 30-30, 45-45

Test/Tests/RestClientTests.swift (1)

1739-1739: LGTM! Version update is consistent.

The version string update from "1.2.38" to "1.2.39" in the test assertion is consistent with the PR objectives.

CHANGELOG.md (4)

3-4: New Version Entry Added
The changelog entry for version 1.2.39 is clearly introduced with a hyperlink to the corresponding branch in the repository. Please double-check that the link is correct and reflects the intended release branch.


5-6: Section Title for Changes Overview
The "### What's Changed" header is correctly placed and clearly signals the start of the changes for this release. No further modifications are needed here.


7-10: Bug Fixes Entry Clarity
Under the "#### Bug fixes" subsection, the bullet point reads:
"* Fix bug where fallback hosts were not working correctly in custom environments (#2017)".
This entry is concise and includes a reference to the responsible pull request. The description is clear.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

9-9: Bare URL used
null

(MD034, no-bare-urls)


11-14: Other Changes Entry Documentation
The "#### Other changes" section includes the bullet:
"* Improvements to the Ably-internal API introduced in v1.2.38 (#2031)".
This is well-documented and links to further details. If additional context becomes necessary later, consider elaborating; otherwise, the current level of detail is sufficient.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

13-13: Bare URL used
null

(MD034, no-bare-urls)

@lawrence-forooghian
Copy link
Collaborator Author

Test failures unrelated to these changes, merging.

@lawrence-forooghian lawrence-forooghian merged commit 6239f6d into main Feb 18, 2025
6 of 8 checks passed
@lawrence-forooghian lawrence-forooghian deleted the release/1.2.39 branch February 18, 2025 13: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.

2 participants