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

Prepare for a new release [4.4.2] #172

Merged
merged 1 commit into from
May 29, 2024
Merged

Prepare for a new release [4.4.2] #172

merged 1 commit into from
May 29, 2024

Conversation

vipulnsward
Copy link
Collaborator

@vipulnsward vipulnsward commented May 28, 2024

Description

  • Prepare for a new release [4.4.2]. Changes as below:

Fixed

  • Fixed the Uploadcare::File.remote_copy method which raised an ApiStruct::EntityError: {url} must be Hash. Now returns a string instead of a File entity instance.

Added

  • Document Info API added in DocumentConverter.

Checklist

Summary by CodeRabbit

  • New Features

    • Added a Document Info API to the DocumentConverter.
  • Bug Fixes

    • Fixed the Uploadcare::File.remote_copy method to return a string instead of a File entity instance.
  • Chores

    • Updated the software version to 4.4.2.

Copy link
Contributor

coderabbitai bot commented May 28, 2024

Walkthrough

In version 4.4.2, the Uploadcare::File.remote_copy method was updated to return a string instead of a File entity instance, enhancing its functionality. Additionally, a new Document Info API was introduced to the DocumentConverter, providing more comprehensive document management capabilities. The version number was incremented from 4.4.1 to 4.4.2 to reflect these changes.

Changes

File(s) Change Summary
CHANGELOG.md Documented the update to Uploadcare::File.remote_copy method and the addition of Document Info API.
lib/uploadcare/ruby/version.rb Updated the version number from 4.4.1 to 4.4.2.

In fields of code where changes flow,
A rabbit hops, with joy to show.
New features bloom, bugs take flight,
Version 4.4.2, shining bright.
With strings and docs, we now delight. 🐇✨


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.
    • @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 as 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 full the 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.

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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 61f3ce3 and b2b761e.
Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • lib/uploadcare/ruby/version.rb (1 hunks)
Files skipped from review due to trivial changes (1)
  • lib/uploadcare/ruby/version.rb
Additional Context Used
LanguageTool (8)
CHANGELOG.md (8)

Near line 5: Possible typo: you repeated a word
Context: ...# Changelog ## 4.4.2 — 2024-05-29 ### Fixed * Fixed the Uploadcare::File.remote_copy meth...
Rule ID: ENGLISH_WORD_REPEAT_RULE


Near line 6: Possible missing comma found.
Context: ...ixed the Uploadcare::File.remote_copy method which raised an `ApiStruct::EntityError...
Rule ID: AI_HYDRA_LEO_MISSING_COMMA


Near line 13: Possible typo: you repeated a word
Context: ...Converter. ## 4.4.1 — 2024-04-27 ### Added * Added AWS Rekognition Moderation` Add-On. * ...
Rule ID: ENGLISH_WORD_REPEAT_RULE


Near line 124: In American English, abbreviations like “etc.” require a period.
Context: ...s mime-type, image (dimensions, format, etc), video information (duration, format, ...
Rule ID: ETC_PERIOD


Near line 124: In American English, abbreviations like “etc.” require a period.
Context: ...information (duration, format, bitrate, etc), audio information, etc - Field `met...
Rule ID: ETC_PERIOD


Near line 124: In American English, abbreviations like “etc.” require a period.
Context: ...rmat, bitrate, etc), audio information, etc - Field metadata that includes arbi...
Rule ID: ETC_PERIOD


Near line 130: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ...plications ### Added - Add Uploadcare API interface: - Uploadcare::FileMetadata -...
Rule ID: ACRONYM_TAUTOLOGY


Near line 156: Possible typo: you repeated a word
Context: ...tureVerifier ## 3.1.1 — 2021-10-13 - FixedUploadcare::File#store- FixedUploadcare::File#delete` ## 3.1.0 — 2...
Rule ID: ENGLISH_WORD_REPEAT_RULE

Markdownlint (70)
CHANGELOG.md (70)

83: Expected: asterisk; Actual: dash
Unordered list style


84: Expected: asterisk; Actual: dash
Unordered list style


92: Expected: asterisk; Actual: dash
Unordered list style


93: Expected: asterisk; Actual: dash
Unordered list style


97: Expected: asterisk; Actual: dash
Unordered list style


110: Expected: asterisk; Actual: dash
Unordered list style


111: Expected: asterisk; Actual: dash
Unordered list style


112: Expected: asterisk; Actual: dash
Unordered list style


113: Expected: asterisk; Actual: dash
Unordered list style


114: Expected: asterisk; Actual: dash
Unordered list style


115: Expected: asterisk; Actual: dash
Unordered list style


116: Expected: asterisk; Actual: dash
Unordered list style


117: Expected: asterisk; Actual: dash
Unordered list style


118: Expected: asterisk; Actual: dash
Unordered list style


119: Expected: asterisk; Actual: dash
Unordered list style


123: Expected: asterisk; Actual: dash
Unordered list style


124: Expected: asterisk; Actual: dash
Unordered list style


125: Expected: asterisk; Actual: dash
Unordered list style


126: Expected: asterisk; Actual: dash
Unordered list style


130: Expected: asterisk; Actual: dash
Unordered list style


131: Expected: asterisk; Actual: dash
Unordered list style


132: Expected: asterisk; Actual: dash
Unordered list style


133: Expected: asterisk; Actual: dash
Unordered list style


134: Expected: asterisk; Actual: dash
Unordered list style


138: Expected: asterisk; Actual: dash
Unordered list style


142: Expected: asterisk; Actual: dash
Unordered list style


143: Expected: asterisk; Actual: dash
Unordered list style


147: Expected: asterisk; Actual: dash
Unordered list style


151: Expected: asterisk; Actual: dash
Unordered list style


152: Expected: asterisk; Actual: dash
Unordered list style


156: Expected: asterisk; Actual: dash
Unordered list style


157: Expected: asterisk; Actual: dash
Unordered list style


161: Expected: asterisk; Actual: dash
Unordered list style


162: Expected: asterisk; Actual: dash
Unordered list style


163: Expected: asterisk; Actual: dash
Unordered list style


167: Expected: asterisk; Actual: dash
Unordered list style


168: Expected: asterisk; Actual: dash
Unordered list style


172: Expected: asterisk; Actual: dash
Unordered list style


173: Expected: asterisk; Actual: dash
Unordered list style


174: Expected: asterisk; Actual: dash
Unordered list style


178: Expected: asterisk; Actual: dash
Unordered list style


182: Expected: asterisk; Actual: dash
Unordered list style


183: Expected: asterisk; Actual: dash
Unordered list style


187: Expected: asterisk; Actual: dash
Unordered list style


188: Expected: asterisk; Actual: dash
Unordered list style


189: Expected: asterisk; Actual: dash
Unordered list style


190: Expected: asterisk; Actual: dash
Unordered list style


191: Expected: asterisk; Actual: dash
Unordered list style


197: Expected: asterisk; Actual: dash
Unordered list style


201: Expected: asterisk; Actual: dash
Unordered list style


202: Expected: asterisk; Actual: dash
Unordered list style


203: Expected: asterisk; Actual: dash
Unordered list style


204: Expected: asterisk; Actual: dash
Unordered list style


205: Expected: asterisk; Actual: dash
Unordered list style


131: Expected: 2; Actual: 4
Unordered list indentation


132: Expected: 2; Actual: 4
Unordered list indentation


42: Expected: 1; Actual: 2
Multiple consecutive blank lines


55: Expected: 1; Actual: 2
Multiple consecutive blank lines


62: Expected: 1; Actual: 2
Multiple consecutive blank lines


5: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


8: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


13: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


6: null
Lists should be surrounded by blank lines


9: null
Lists should be surrounded by blank lines


14: null
Lists should be surrounded by blank lines


18: null
Lists should be surrounded by blank lines


40: null
Lists should be surrounded by blank lines


102: null
Lists should be surrounded by blank lines

Additional comments not posted (2)
CHANGELOG.md (2)

3-7: The changelog entry for the fix in Uploadcare::File.remote_copy is clear and accurately reflects the changes made in the PR.


7-10: The changelog entry for the addition of the Document Info API in DocumentConverter is well-documented and aligns with the PR's objectives.

@vipulnsward vipulnsward requested a review from rsedykh May 29, 2024 10:12
Copy link
Member

@rsedykh rsedykh left a comment

Choose a reason for hiding this comment

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

Please check out why checks fail.

@vipulnsward
Copy link
Collaborator Author

Please check out why checks fail.

They seem to be from a cached dependency issue, new push, rebuilds fixed it.

@vipulnsward vipulnsward merged commit df19608 into main May 29, 2024
15 checks passed
@vipulnsward vipulnsward deleted the prep-4.4.2 branch November 7, 2024 17:14
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.

2 participants