📣 Plan for Ruby 3.0 support (Released!) #17931

ainame · 2021-01-09T04:59:26Z

👋 Hello, fastlane community!

Ruby 3.0 support was released at v2.183.0. Please give it a try and give us feedback on this issue.
https://github.com/fastlane/fastlane/releases/tag/2.183.0

The plan is now hidden under "Details".

Please react with 👍 emoji on this issue if you are waiting for Ruby 3.0 support!

This is @ainame who recently became a core contributor 🚀 I'm pleased to announce that I will be working on getting Ruby 3.0 support in fastlane. So this ticket is to track the progress and let fastlane users be aware of the work being addressed.

TL; DR

Use Ruby 2.4-2.7 until 3.0 migration is done
Don't send us a bug report about installation failure with Ruby 3.0 as it will cause duplication a lot
Help us if we need to test any for the migration in future 🙏

Ruby 3.0 and currently supported versions

Ruby 3.0 was released on 25th December 2020. It's a major version update but its source code compatibility with 2.x should be good. There are performance improvements and interesting new features implemented.

However, fastlane hasn't officially supported Ruby 3.0 yet. Please read the below section for details. The currently supported versions are Ruby 2.4-2.7. I highly recommend that you upgrade Ruby version to 2.6 or 2.7. Ruby 2.4 is now in EOL period, which means there will be no security fix for it. Ruby 2.5 will be the same soon.

https://www.ruby-lang.org/en/downloads/branches/

If you try to install fastlane against Ruby 3.0, it actually succeeds with the version "2.54.1" BUT it is too old and deliver won't work for the latest App Store Connect APIs. Please don't use it.

How far is fastlane away from Ruby 3.0?

Ruby 2.7's warnings

Before going to Ruby 3.0, we should make sure the last version in 2.x series "2.7" is supported correctly. It's very important because 2.7 warns us if there are chances of breaking with some deprecation messages to prepare Ruby 3.0 migration. #15856

It's been recognised, in fact, fastlane can run on Ruby 2.7, which is the latest version in 2.x series. However, despite the fact, fastlane project hasn't guaranteed that all the testing specs pass with Ruby 2.7 on CI yet. This will be resolved on #17861

Blocker to install fastlane to Ruby 3.0

Right now, we have the dependency google-api-client that we have a strict limit in the flexibility of version resolving.

spec.add_dependency('google-api-client', '>= 0.37.0', '< 0.39.0') # Google API Client to access Play Publishing API

However, within those versions, none of them allows us to install it to Ruby 3.0 env. We need to adopt 0.44.2 or later googleapis/google-api-ruby-client#900.

Replace unmaintained gem

There is also slack-notifier gem which was popular to send messages to Slack but however, it doesn't seem to be actively maintained. So we might need to replace that gem with other or one made by ourselves.

To run unit tests

rspec/spec-mocks rspec/rspec-mocks#1394 also still has some issues for Ruby 3.0. We need to wait for it to be fixed.

Drop Ruby 2.4 support

We'd like to drop 2.4 support when we officially release "Ruby 3.0" support. It's mainly because rubygems we are using also did the same. So the more rubygems do that the harder we keep supporting old versions; e.g. #18339. Essentially the Ruby core team has ended security support for 2.4 last year. So it's good to update your Ruby version to keep your environment secure.

googleapis/google-api-ruby-client#2841
googleapis/signet#178

Todo

This is a rough plan to work on the migration.

~~Enable CI for Ruby 2.7~~ [CI] support Ruby 2.7 on Circle CI #17861~
~~Prepare ~~Danger~~ a CI check to prevent master/main branch to cause regressions of 2.7 warnings before enabling Ruby 3.0 on CircleCI [Ruby 3.0] Fix Ruby 2.7's deprecation warnings #18021~~
Fix deprecation warnings with Ruby 2.7 if there are any to improve the source code compatibility with 3.0
- ~~Fix warnings in the codebase [Ruby 3.0] Fix Ruby 2.7's deprecation warnings #18021~~
- ~~Replace slack-notifier with something else or implement a basic Slack integration by ourselves~~ [Ruby 3.0] improve specs for Slack action #18512 [Ruby 3.0] replace slack-notifier gem with internal library #18537
- ~~Wait for rspec-mocks to release a version that supports Ruby 3.0 or fix existing specs that crashes due to Ruby 3.0 syntax~~ Apparently, we fixed this issue before I know it
Work on other migrations
- ~~Update rubocop version to the latest~~ [Ruby 3.0] Bump rubocop version #18564
- ~~Update dependencies that have deprecation warnings; highline, etc...~~ [Ruby 3.0] Switch back to the original commander gem and update dependencies #18599
- ~~Bump google-api-client version to unblock Ruby 3.0 installation~~ [Ruby 3.0] Migrate google-api-client gem and drop Ruby 2.4 #18656
- ~~Fix failing specs due to rspec's syntax unless rspec team releases a new version that supports Ruby 3.0~~
- ~~Enable CI for Ruby 3.0~~ [Ruby 3.0] Migrate google-api-client gem and drop Ruby 2.4 #18656
~~Release the version that supports Ruby 3.0 officially~~

For 3-5, depending on how big impact changes will have, we might cut a work branch to stack up changes and release RC branch. If it will not be too big, changes will be merged into master gradually.

The text was updated successfully, but these errors were encountered:

ainame · 2021-01-12T03:44:57Z

% rbenv local 2.7.2
% bundle install
% RUBYOPT="-W:deprecated" bundle exec rspec --pattern */**/*_spec.rb 2> stderr.txt
% cat stderr.txt | grep warning: > warnings.txt

With those commands, I got some warnings that need to be fixed for Ruby 3.0 (including other normal warnings).

https://gist.github.com/ainame/d7f1c4d2fb07f139d3a0f064d4cbda75

I'll be fixing them and sending PRs once #17861 gets merged. Maybe I should create a Danger lint rule to check if there are such warnings appearing on rspec output.

ainame · 2021-01-17T04:14:57Z

I'm accumulating fixes onto this branch.
https://github.com/ainame/fastlane/commits/fix-ruby2.7-warnings

mikehardy · 2021-01-17T13:20:25Z

I recognize this is off-topic but it doesn't appear there are too many subscribers - just wanted to say thanks! open source maintenance is usually a thankless job but shouldn't be, and fastlane in particular is so useful to me, thanks for helping. Cheers @ainame

ainame · 2021-01-21T02:26:20Z

#17861 and #17892 got merged! We'll be able to test fastlane with Ruby 2.7 finally!!

ainame · 2021-01-21T05:34:11Z

This PR will be the one to 🔪 deprecated warnings as much as I found in fastlane itself and I could fix.
#18021

~~However, I left this method due to the difficulty to fix. I guess this may involve a refactoring on call sites.~~

fastlane/fastlane_core/lib/fastlane_core/project.rb

Line 80 in 633860a

    
           def initialize(options, xcodebuild_list_silent: false, xcodebuild_suppress_stderr: false)

I identified that xcodebuild_list_silent and xcodebuild_suppress_stderr were introduced #5491 in order to make logs better for Crashlytics integrations, however, that was removed in
#11601 so now nothing uses that option (at least) within fastlane project. So I will remove the options, too.

It's an off topic but I realised FastlaneCore::CommandExecutor never deal with stdout and stderr separately. So that it can't provide a universal option just to suppress stderr which is equivalent of 2> /dev/null. Maybe we can provide something like a global option to deal with stderr somehow to keep logging nicer. I will open a ticket about it at some point.

ainame · 2021-01-23T07:30:00Z

I realised that without keeping monitoring warnings, there may be regressions of my fixes for warnings. So I will work on Danger checks for it. Added this to the TODO list.

Prepare Danger to prevent master branch to cause regressions of 2.7 warnings before enabling Ruby 3.0 on CircleCI

ainame · 2021-02-02T03:39:55Z

~~I've also started working on document pages to clarify the currently supported Ruby versions.~~
fastlane/docs#1018
#18189

This is done.

RamblinWreck77 · 2021-02-23T14:43:27Z

Just here to cheer everyone on! Looking forward to a 3.0-compatible release. :)

ainame · 2021-02-24T05:24:40Z

This PR is now ready to review! 🚀
#18021

It took me a while to implement a CI check that prevents regressions without using Danger. It turned out we won't be able to enable Danger for forked repositories as it can leak GitHub's access token.

ainame · 2021-03-10T14:45:12Z

#18021 has got merged. From now on no new code that is not ready for Ruby 3.0 in terms of "Separation of positional and keyword arguments" can be merged. It will be prevented by CI as far as it's covered by unit tests.

And also @joshdholtz the lead maintainer and I discussed dropping Ruby 2.4 support. We'd like to drop 2.4 support when we officially release "Ruby 3.0" support. It's mainly because rubygems we are using also did the same. So the more rubygems do that the harder we keep supporting old versions; e.g. #18339. Essentially the Ruby core team has ended security support for 2.4 last year. It's good to update your Ruby version to keep your environment secure.

googleapis/google-api-ruby-client#2841
googleapis/signet#178

ainame · 2021-03-14T18:31:34Z

While working on this improvement #18278 in order to find undiscovered issues as my side project, I could find another issue in the codebase for Ruby 3.0🙂
#18395

ainame · 2021-04-10T06:38:53Z

Replacement of slack-notifier is ready🚀 #18537

~~I'll submit the PR shortly.~~
~~ainame/fastlane@30555fc...replace-slack-notifier~~

ainame · 2021-04-16T14:28:27Z

Bumping rubocop version to the latest is on the way...
#18564

ainame · 2021-04-23T13:00:51Z

highline 1.7.x is not compatible with Ruby 3.0. I'll be migrating it to 2.x.
JEG2/highline#248

ainame · 2021-04-27T09:48:42Z

In order to update highline gem, we first need to bump commander by stopping using the forked one https://github.com/fastlane/commander.
I will submit a couple of PRs for it one by one.

#18599

mikehardy · 2021-04-27T13:22:14Z

You are on the ultimate yak shave @ainame :-), thanks so much for your work here

ainame · 2021-04-27T15:20:21Z

@mikehardy It's my pleasure. Yeah, it is yak shaving but that's the only way to get things done right here😂
I will keep things up-to-date or resolve tech-debt stuff for the next major change from time to time as long as I maintain fastlane😅

ainame · 2021-05-01T17:15:04Z

I will work on google-api-client migration that's been blocking us to use Ruby 3.0 finally. It seems like it's not only about version bumping but also we need to adopt the new way of distribution of the gem split by its service. I'll first investigate what Google services are used in fastlane.

https://github.com/googleapis/google-api-ruby-client/blob/master/google-api-client/OVERVIEW.md

ainame · 2021-05-08T06:46:28Z

#18646 was needed to remove really old deprecation😄

And finally, it's getting really close to the goal🏃 #18656

ainame · 2021-05-08T15:53:34Z

This PR is ready to review and test! I appreciate it if anyone can volunteer to test the below branch as it updates google-api-client gem. It shouldn't have any breaking changes but want to ensure that 🙇

gem 'fastlane', git: 'https://github.com/fastlane/fastlane.git', branch: 'ai/migrate-google-api-client'

#18656

mikehardy · 2021-05-09T16:53:39Z

On a different machine a brew update today gave me a new gcc/llvm/etc (which was hinted at as a resolution for my issue in the comment I hid, above) and I was able to successfully create a Gemfile with your git source above and run bundle update

I ran bundle exec fastlane <etc> with your git source and it appeared to execute as before to build an iOS app and push it to the TestFlight servers.

I suspect that with the google-apis being the thing you really want to test, someone that uses Fastlane to interact with the Play Store would be your ideal test scenario yes? Hopefully someone else can give that a test, but I can verify at least for a typical TestFlight / iOS build scenario, there is no regression

Thanks for your continued effort in this area, looking forward to ruby 3 support when it's ready 😃

ainame · 2021-05-10T08:54:24Z

@mikehardy Thank you for giving it a try. Your feedback using my branch with real-world Fastfile is very important to me. Glad to hear it worked😄

ainame · 2021-05-14T05:05:56Z

Hello, there👋 It's going to be released tommorrow!
Thank you for waiting for Ruby 3.0 patiently.
https://twitter.com/joshdholtz/status/1393019142119231494?s=21

ainame · 2021-05-14T16:23:49Z

It's released! 🎉 I'll leave this issue open for a while to gather further feedback regarding Ruby 3.0.
https://github.com/fastlane/fastlane/releases/tag/2.183.0

Note that there is a known issue where rdoc v6.3.1 causes fastlane's installation failure. You can work around it by either using bundler + Gemfile or --no-doc flag.
#18642

ainame · 2021-05-17T13:41:32Z

~~This issue might be related to the last change~~
#18698

Issues in supply were resolved now

ainame · 2021-06-05T15:16:40Z

There will be a breaking change in Ruby 3.1.0 due to psych bumped to v4.0.0, which has a breaking change for fastlane.
https://github.com/ruby/ruby/blob/3208a5df2dfb429752a130a36274464e9924cf44/ext/psych/lib/psych/versions.rb#L5

It's reported here #18768

psych is a default gem bundled in Ruby itself. You can update the version if you want. The latest release was a major version bump and included the breaking change that affects http-cookie gem that fastlane depends on internally.

I'll submit a PR to http-cookie repo to resolve the actual cause of the issue.

ainame · 2021-06-05T16:48:51Z

This will also be broken with psych v4.0. We need to use keyword arguments for YAML.safe_load

fastlane/spaceship/lib/spaceship/spaceauth_runner.rb

Lines 42 to 47 in 27dfa59

    
           cookies = YAML.safe_load( 
        
             itc_cookie_content, 
        
             [HTTP::Cookie, Time], # classes allowlist 
        
             [],                   # symbols allowlist 
        
             true                  # allow YAML aliases 
        
           )

ainame · 2021-06-08T14:34:28Z

It's been a while since released. I'm going to close this ticket.
Going forward, I'm planning to add CI checks against Ruby head in order to find issues like the above ahead.

ainame self-assigned this Jan 9, 2021

ainame added the topic: ruby 3.0 label Jan 9, 2021

ainame pinned this issue Jan 9, 2021

This comment has been minimized.

Sign in to view

ainame mentioned this issue Jan 19, 2021

[deliver] When there is at least 1 framed screenshot, all non-framed screenshot files are skipped, even for devices that have no framed screenshots #15366

Closed

4 tasks

ainame mentioned this issue Jan 23, 2021

[Ruby 3.0] Fix Ruby 2.7's deprecation warnings #18021

Merged

4 tasks

max-ott mentioned this issue Jan 30, 2021

Suddenly getting error: muninitialized constant Fastlane::Actions::SharedValues::KEYCHAIN_PATH #18063

Closed

4 tasks

tripplilley mentioned this issue Jan 31, 2021

Clarify supported Ruby versions fastlane/docs#1018

Closed

maierj mentioned this issue Feb 5, 2021

[Update docs] bundler: failed to load command: fastlane (/opt/hostedtoolcache/Ruby/3.0.0/x64/bin/fastlane) maierj/fastlane-action#64

Closed

ainame mentioned this issue Feb 8, 2021

Add supported Ruby versions and deprecate "sudo gem install" to system Ruby fastlane/docs#1022

Merged

mikehardy mentioned this issue Feb 13, 2021

Road to v0.64 Discussion react-native-community/releases#214

Closed

36 tasks

ainame mentioned this issue Feb 23, 2021

[docs] Remove "sudo" from instructions in code #18189

Merged

4 tasks

SplittyDev mentioned this issue Mar 13, 2021

Update dependency ruby to v3 siteline/swiftui-introspect#67

Closed

1 task

ainame mentioned this issue Mar 14, 2021

[Ruby 3.0] Replace Kernel.open overridden by open-uri with URI.open #18395

Merged

4 tasks

ainame mentioned this issue Mar 17, 2021

[Ruby 3.0] fix failing CI checks by supporting open-uri on Ruby 2.4 #18405

Merged

4 tasks

ainame mentioned this issue Mar 24, 2021

[Windows] Bundle fastlane cannot load such pty #18447

Closed

4 tasks

morpheby added a commit to morpheby/fastlane that referenced this issue Mar 25, 2021

Updated deps before fastlane#17931 done

6a23f01

henteko mentioned this issue Apr 2, 2021

Support ruby-3.0.0 DeployGate/deploygate-cli#292

Closed

ainame mentioned this issue Apr 7, 2021

[Ruby 3.0] improve specs for Slack action #18512

Merged

4 tasks

ainame mentioned this issue Apr 10, 2021

[Ruby 3.0] replace slack-notifier gem with internal library #18537

Merged

4 tasks

This was referenced Apr 21, 2021

[Ruby 3.0] Bump rubocop version #18564

Merged

Avoid using the last argument as keyword parameter JEG2/highline#248

Closed

ainame mentioned this issue Apr 27, 2021

[Ruby 3.0] Switch back to the original commander gem and update dependencies #18599

Merged

4 tasks

ainame mentioned this issue May 5, 2021

[Ruby 3.0] Replace obsolete URI.escape with alternatives #18646

Merged

4 tasks

ainame mentioned this issue May 8, 2021

[Ruby 3.0] Migrate google-api-client gem and drop Ruby 2.4 #18656

Merged

4 tasks

This comment has been minimized.

Sign in to view

ainame changed the title ~~📣 Plan for Ruby 3.0 support~~ 📣 Plan for Ruby 3.0 support (Released!) May 14, 2021

ainame mentioned this issue Jun 5, 2021

psych v4.0 to break FASTLANE_SESSION functionality #18768

Closed

4 tasks

joshdholtz unpinned this issue Jun 8, 2021

ainame mentioned this issue Jun 8, 2021

[spaceship] migrate YAML.safe_load to support psych v4.0 #18825

Merged

4 tasks

ainame closed this as completed Jun 8, 2021

fastlane locked and limited conversation to collaborators Aug 8, 2021

📣 Plan for Ruby 3.0 support (Released!) #17931

📣 Plan for Ruby 3.0 support (Released!) #17931

Comments

ainame commented Jan 9, 2021 • edited

TL; DR

Ruby 3.0 and currently supported versions

How far is fastlane away from Ruby 3.0?

Ruby 2.7's warnings

Blocker to install fastlane to Ruby 3.0

Replace unmaintained gem

To run unit tests

Drop Ruby 2.4 support

Todo

This comment has been minimized.

ainame commented Jan 12, 2021 • edited

ainame commented Jan 17, 2021 • edited

mikehardy commented Jan 17, 2021

ainame commented Jan 21, 2021

ainame commented Jan 21, 2021 • edited

ainame commented Jan 23, 2021 • edited

ainame commented Feb 2, 2021 • edited

RamblinWreck77 commented Feb 23, 2021

ainame commented Feb 24, 2021

ainame commented Mar 10, 2021 • edited

ainame commented Mar 14, 2021 • edited

ainame commented Apr 10, 2021 • edited

ainame commented Apr 16, 2021 • edited

ainame commented Apr 23, 2021

ainame commented Apr 27, 2021 • edited

mikehardy commented Apr 27, 2021

ainame commented Apr 27, 2021 • edited

ainame commented May 1, 2021 • edited

ainame commented May 8, 2021 • edited

ainame commented May 8, 2021

This comment has been minimized.

mikehardy commented May 9, 2021

ainame commented May 10, 2021

ainame commented May 14, 2021

ainame commented May 14, 2021 • edited

ainame commented May 17, 2021 • edited

ainame commented Jun 5, 2021 • edited

ainame commented Jun 5, 2021

ainame commented Jun 8, 2021

ainame commented Jan 9, 2021 •

edited

ainame commented Jan 12, 2021 •

edited

ainame commented Jan 17, 2021 •

edited

ainame commented Jan 21, 2021 •

edited

ainame commented Jan 23, 2021 •

edited

ainame commented Feb 2, 2021 •

edited

ainame commented Mar 10, 2021 •

edited

ainame commented Mar 14, 2021 •

edited

ainame commented Apr 10, 2021 •

edited

ainame commented Apr 16, 2021 •

edited

ainame commented Apr 27, 2021 •

edited

ainame commented Apr 27, 2021 •

edited

ainame commented May 1, 2021 •

edited

ainame commented May 8, 2021 •

edited

ainame commented May 14, 2021 •

edited

ainame commented May 17, 2021 •

edited

ainame commented Jun 5, 2021 •

edited