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

Supported ruby versions conflict #1304

Closed
jedeleh opened this issue Aug 13, 2021 · 3 comments · Fixed by #1305
Closed

Supported ruby versions conflict #1304

jedeleh opened this issue Aug 13, 2021 · 3 comments · Fixed by #1305

Comments

@jedeleh
Copy link

jedeleh commented Aug 13, 2021

Basic Info

The Faraday README.md states: "Currently that means we support Ruby 2.6+"

Rubygems.org states that the required ruby version is >= 2.4

This seems contradictory.

  • Faraday Version: 1.7.0
  • Ruby Version: 2.5.3

Issue description

I need to use the most recent version of Faraday that supports 2.5.3. There's likely no code change for this--just documentation to explain why, and then how to find the the actual version that supported a specific ruby version.

Steps to reproduce

Read the README, visit Rubygems.org and check the required ruby version information on the right side of the view when you select a specific Faraday version.

@olleolleolle
Copy link
Member

The code is linted with Ruby 2.4 rules, so that we can still install and use on that, but we are not extending the promise longer than that. Our support window is "the same as Ruby's", but we didn't see a reason to cut off earlier versions before we had a reason to.

https://github.com/lostisland/faraday/blob/main/.rubocop.yml#L11

@iMacTia
Copy link
Member

iMacTia commented Aug 13, 2021

Hi @jedeleh, thanks for raising this and apologies for the confusion.
The main branch represents our upcoming 2.0 release, which will track Ruby's support window, however v 1.x of Faraday (based off the 1.x branch) still supports Ruby 2.4+ and is tested and linted against that.

Based on your feedback I suspect we should add a clear message in the README to explain that the main branch does not represent the latest Rubygems release, so I'll be doing that as soon as possible

@jedeleh
Copy link
Author

jedeleh commented Aug 13, 2021

Perfect! Thanks for the information, and for considering the issue.

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 a pull request may close this issue.

3 participants