Use `ruby file: ".ruby-version"` for new apps #49360

skipkayhil · 2023-09-23T20:06:37Z

Motivation / Background

Previously, new apps would have a Ruby version set in both the Gemfile and the .ruby-version file. This duplication makes it more difficult to quickly change an application's ruby version as users must remember to update multiple files.

Detail

This commit updates the app generator's Gemfile to read the Ruby version from the .ruby-version file. Since this feature was introduced in the latest version of Bundler, it will only be enabled if a supported version of Bundler is used.

Additional information

Alternatively, another solution mentioned on the original PR adding .ruby-version was that the .ruby-version file could be removed once rvm/rbenv support reading the Ruby version from the Gemfile. This has a downside that many other tools like chruby do not have plans to support reading a Ruby version from the Gemfile, and so users of those tools would have a worse experience if the .ruby-version file is removed.

Checklist

Before submitting the PR make sure the following are checked:

This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
Tests are added or updated if you fix a bug or add a feature.
CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

skipkayhil · 2023-09-23T20:07:21Z

Drafted because rubygems/rubygems#6985 hasn't quite been released yet

sinsoku · 2023-09-24T07:25:46Z

@skipkayhil
bundle install requires .ruby-version, so you should modify the Dockerfile as well.
I think you should modify the following parts.

rails/railties/lib/rails/generators/rails/app/templates/Dockerfile.tt

Lines 42 to 46 in d99e355

    
           # Install application gems 
        
           COPY Gemfile Gemfile.lock ./ 
        
           RUN bundle install && \ 
        
               rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git<% if depend_on_bootsnap? -%> && \ 
        
               bundle exec bootsnap precompile --gemfile<% end %>

simi · 2023-09-24T07:34:16Z

@skipkayhil bundle install requires .ruby-version, so you should modify the Dockerfile as well. I think you should modify the following parts.

rails/railties/lib/rails/generators/rails/app/templates/Dockerfile.tt

Lines 42 to 46 in d99e355

# Install application gems

COPY Gemfile Gemfile.lock ./

RUN bundle install && \

rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git<% if depend_on_bootsnap? -%> && \

bundle exec bootsnap precompile --gemfile<% end %>

Indeed this is one of the caveats of .ruby-version support in Bundler. It should be copied next to Gemfile to production container even it's original purpose is mostly for development. 🤷

dhh · 2024-01-01T18:18:25Z

Did you find a way to address the Dockerfile as well?

skipkayhil · 2024-01-01T18:19:05Z

Yes I was wrapping it up yesterday, let me push it up

Edit: unless you mean can the Dockerfile also read the .ruby-version for the image version, in which case I have not addressed that

dhh · 2024-01-01T18:19:08Z

Also, do we need the version split if Ruby 3.1+ is now required?

skipkayhil · 2024-01-01T18:25:28Z

Also, do we need the version split if Ruby 3.1+ is now required?

We do definitely need the split on using file: since it was added in Bundler 2.4.20 and Ruby 3.1 ships with Bundler 2.3.3

dhh · 2024-01-01T18:40:30Z

Although I wonder if we couldn't just force Bundler 2.4+ with the install of Rails?

dhh · 2024-01-01T19:08:49Z

Also, shouldn't "ruby file: ".ruby-version"" just be the default in bundler?

Previously, new apps would have a Ruby version set in both the Gemfile and the .ruby-version file. This duplication makes it more difficult to quickly change an application's ruby version as users must remember to update multiple files. This commit updates the app generator's Gemfile to read the Ruby version from the .ruby-version file. Since this feature was introduced in the latest version of Bundler, it will only be enabled if a supported version of Bundler is used. Alternatively, another solution mentioned on the original PR adding .ruby-version was that the .ruby-version file could be removed once rvm/rbenv support reading the Ruby version from the Gemfile. This has a downside that many other tools like chruby do not have plans to support reading a Ruby version from the Gemfile, and so users of those tools would have a worse experience if the .ruby-version file is removed. Co-authored-by: Takumi Shotoku <sinsoku.listy@gmail.com>

skipkayhil · 2024-02-14T17:30:16Z

@dhh this should be ready to go 👍

This reverts commit 6985c3b, reversing changes made to 3163bb7. Reason: While we want to apply this change, it make bundle being more strict about the ruby version. This is particularly problematic for the devcontainer images that don't support defining which patch version of ruby to install. Right now, you can only say you want Ruby 3.2, which could mean 3.2.3 or 3.2.0. If for some reason the devcontainer image doesn't match the patch version on `.ruby-version` it will fail to install. We are planning to solve this problem by publishing our own ruby images that allow defining the patch level, but until that we can't apply this change.

…y-file" This reverts commit 6985c3b, reversing changes made to 3163bb7. Reason: While we want to apply this change, it make bundle being more strict about the ruby version. This is particularly problematic for the devcontainer images that don't support defining which patch version of ruby to install. Right now, you can only say you want Ruby 3.2, which could mean 3.2.3 or 3.2.0. If for some reason the devcontainer image doesn't match the patch version on `.ruby-version` it will fail to install. We are planning to solve this problem by publishing our own ruby images that allow defining the patch level, but until that we can't apply this change.

rails-bot bot added the railties label Sep 23, 2023

skipkayhil force-pushed the hm-gemfile-ruby-file branch from 198fcb1 to 66c79c4 Compare December 31, 2023 22:01

skipkayhil mentioned this pull request Jan 1, 2024

Ruby Versions are in multiple locations, making it difficult to upgrade #50504

Closed

jonathanhefner mentioned this pull request Jan 1, 2024

Stop repeating the Ruby version #50521

Closed

skipkayhil force-pushed the hm-gemfile-ruby-file branch from 535d876 to 6cbdc3f Compare January 1, 2024 18:22

skipkayhil force-pushed the hm-gemfile-ruby-file branch from 6cbdc3f to bfeb8e3 Compare January 1, 2024 18:40

skipkayhil force-pushed the hm-gemfile-ruby-file branch from bfeb8e3 to 8bc27bc Compare February 8, 2024 15:54

skipkayhil marked this pull request as ready for review February 8, 2024 15:54

skipkayhil mentioned this pull request Feb 8, 2024

Use file option to determine Ruby version in Gemfile #51013

Closed

4 tasks

robzolkos mentioned this pull request Feb 9, 2024

Copy over .ruby-version prior to initial bundle in generated Dockerfile #51031

Closed

4 tasks

skipkayhil force-pushed the hm-gemfile-ruby-file branch from 8bc27bc to a1c6e27 Compare February 14, 2024 17:29

rafaelfranca merged commit 6985c3b into rails:main Feb 14, 2024

skipkayhil deleted the hm-gemfile-ruby-file branch February 14, 2024 18:01

dentarg mentioned this pull request Feb 14, 2024

Support Bundler 2.4.20+ to enable ruby file: '.ruby-version' in Gemfile heroku/heroku-buildpack-ruby#1408

Closed

mattbrictson mentioned this pull request Aug 7, 2024

Add ruby back into generated Gemfile #52539

Closed

4 tasks

inscapist mentioned this pull request Aug 27, 2024

Gemfile ruby: file unsupported inscapist/ruby-nix#44

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use `ruby file: ".ruby-version"` for new apps #49360

Use `ruby file: ".ruby-version"` for new apps #49360

Uh oh!

skipkayhil commented Sep 23, 2023 •

edited

Loading

Uh oh!

skipkayhil commented Sep 23, 2023

Uh oh!

sinsoku commented Sep 24, 2023 •

edited

Loading

Uh oh!

simi commented Sep 24, 2023

Uh oh!

dhh commented Jan 1, 2024

Uh oh!

skipkayhil commented Jan 1, 2024 •

edited

Loading

Uh oh!

dhh commented Jan 1, 2024

Uh oh!

skipkayhil commented Jan 1, 2024

Uh oh!

dhh commented Jan 1, 2024

Uh oh!

dhh commented Jan 1, 2024

Uh oh!

skipkayhil commented Feb 14, 2024

Uh oh!

Uh oh!

Use ruby file: ".ruby-version" for new apps #49360

Use ruby file: ".ruby-version" for new apps #49360

Uh oh!

Conversation

skipkayhil commented Sep 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation / Background

Detail

Additional information

Checklist

Uh oh!

skipkayhil commented Sep 23, 2023

Uh oh!

sinsoku commented Sep 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simi commented Sep 24, 2023

Uh oh!

dhh commented Jan 1, 2024

Uh oh!

skipkayhil commented Jan 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dhh commented Jan 1, 2024

Uh oh!

skipkayhil commented Jan 1, 2024

Uh oh!

dhh commented Jan 1, 2024

Uh oh!

dhh commented Jan 1, 2024

Uh oh!

skipkayhil commented Feb 14, 2024

Uh oh!

Uh oh!

Use `ruby file: ".ruby-version"` for new apps #49360

Use `ruby file: ".ruby-version"` for new apps #49360

skipkayhil commented Sep 23, 2023 •

edited

Loading

sinsoku commented Sep 24, 2023 •

edited

Loading

skipkayhil commented Jan 1, 2024 •

edited

Loading