Support .ruby-version #31

scottohara · 2019-09-28T14:35:17Z

Many ruby projects include a .ruby-version file in the root directory, containing the version of Ruby needed.

Tools such as rvm, rbenv and chruby all recognise and use this file.

This is not unlike the .nvmrc file often used in Node projects, and the setup-node action has a discussion on potentially using the contents of that file as the node version if no with: argument is specified. (actions/setup-node#32)

I would suggest that setup-ruby might consider a similar approach, where if no explicit ruby version is given, look for a .ruby-version file and use the version contained within.

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

tisba · 2019-11-28T09:13:44Z

I was wondering if there is a workaround available, like

- name: Set up Ruby
  uses: actions/setup-ruby@v1
  with:
    ruby-version: "{{ cat('.ruby-version') }}"

However I was not able to figure out how to do that yet :(

sobstel · 2019-12-03T12:23:45Z

I found a workaround in actions/setup-node repo.

- run: echo "::set-output name=RUBY_VERSION::$(cat .ruby-version)"
  id: rbenv

- uses: actions/setup-ruby@v1
  with:
   ruby-version: "${{ steps.rbenv.outputs.RUBY_VERSION }}"

bryanmacfarlane · 2020-01-07T19:15:55Z

happy to see the workaround ☝️ - leaving as an enhancement for consideration

vvo · 2020-01-10T08:52:42Z

@bryanmacfarlane To be honest, and without any anger or nothing, I want to point out that supporting .ruby-version should not be seen as an "enhancement" but as a requirement for the ruby community. When any company starts a Ruby project they will first choose between rvm or rbenv, most of them. And the next step will be to create a .ruby-version file to easily create a reproducible environment for devs and continuous integration, which is supported by both rbenv and rvm.

Thus I think we should consider supporting the .ruby-version really as a requirement to consider "setup-ruby" good enough for any Ruby project. Right now a lot of people are just not using it and instead using https://github.com/eregon/use-ruby-action or https://github.com/masa-iwasaki/setup-rbenv.

I think it's fine and great that people are creating actions on the marketplace but for some very popular actions, the ones from GitHub should really cover most use cases otherwise we'll endup with a marketplace like the npm registry where you spend half a day trying to find the "right" ruby action that works well..

Thanks for consideration!

PS: Maybe @eregon, creator of use-ruby-action you have some thoughts about this too? Thanks!

eregon · 2020-01-10T11:31:53Z

I implemented it in use-ruby-action (issue: ruby/setup-ruby#4).
It's really trivial.

I think longer term we'll want most (all maybe) features of use-ruby-action in this repo: #44

There a GitHub issue open for the setup-ruby action in which they are considering making this happen automatically, but somebody gave this way of implementing it for now: actions/setup-ruby#31 (comment)

actions/setup-ruby#31 (comment)

* Try installing a few deps * Install Node, Ruby, and attach a Postgres instance * Match the installed version of ruby with the one in ruby-version * Use a clever method for finding the current ruby version actions/setup-ruby#31 (comment) * Oops, gotta checkout the code before reading the version * Bump to the latest patch version of Ruby * Bump the Gemfile too * Health check the Postgres instance and split out the bundle step * use the latest Postgres, reformat the heallth check * Point Rails at the service container * Switch back to port mapping postgres to the local machine * Manually set up the postgres instance and use DATABASE_URL for telling Rails where to look * Deploy using GitHub workflows * Use secrets store * Setup both api. and git. for Heroku * Specify the Heroku app to deploy to * Double check current config * debug heroku auth * Work that netrc * try and preserve newlines when writing netrc * Be extra specific with the GH branch we want to push * Only deploy on master * I read the docs * Install specific node versions * Cache Node Modules runs * Cache Ruby dependencies * Ditch Travis

* Try installing a few deps * Install Node, Ruby, and attach a Postgres instance * Match the installed version of ruby with the one in ruby-version * Use a clever method for finding the current ruby version actions/setup-ruby#31 (comment) * Oops, gotta checkout the code before reading the version * Bump to the latest patch version of Ruby * Bump the Gemfile too * Health check the Postgres instance and split out the bundle step * use the latest Postgres, reformat the heallth check * Point Rails at the service container * Switch back to port mapping postgres to the local machine * Manually set up the postgres instance and use DATABASE_URL for telling Rails where to look * Deploy using GitHub workflows * Use secrets store * Setup both api. and git. for Heroku * Specify the Heroku app to deploy to * Double check current config * debug heroku auth * Work that netrc * try and preserve newlines when writing netrc * Be extra specific with the GH branch we want to push * Only deploy on master * I read the docs * Install specific node versions * Cache Node Modules runs * Cache Ruby dependencies * Ditch Travis Switch the build badge from Travis to GH Actions ayy wow

* Try installing a few deps * Install Node, Ruby, and attach a Postgres instance * Match the installed version of ruby with the one in ruby-version * Use a clever method for finding the current ruby version actions/setup-ruby#31 (comment) * Oops, gotta checkout the code before reading the version * Bump to the latest patch version of Ruby * Bump the Gemfile too * Health check the Postgres instance and split out the bundle step * use the latest Postgres, reformat the heallth check * Point Rails at the service container * Switch back to port mapping postgres to the local machine * Manually set up the postgres instance and use DATABASE_URL for telling Rails where to look * Deploy using GitHub workflows * Use secrets store * Setup both api. and git. for Heroku * Specify the Heroku app to deploy to * Double check current config * debug heroku auth * Work that netrc * try and preserve newlines when writing netrc * Be extra specific with the GH branch we want to push * Only deploy on master * I read the docs * Install specific node versions * Cache Node Modules runs * Cache Ruby dependencies * Ditch Travis Switch the build badge from Travis to GH Actions ayy wow Clobber the remote ref Fix a Gemfile Ruby version issue Fetch the whole repository because Heroku wants it Keep the Heroku app names secret and Deploy to Production

This is GitHub’s default template, plus an extra step to respect `.ruby-version`, which is taken from actions/setup-ruby#31 (comment).

The step to respect `.ruby-version` is taken from actions/setup-ruby#31 (comment).

mo-rubikal · 2020-04-06T01:06:08Z

I saw the same concept works for user-ruby-action as following: (tested and working)


      - name: Install Ruby version from .ruby-version
        uses: eregon/use-ruby-action@master

It would be nice if that supported the same way here.

MSP-Greg · 2020-04-06T01:37:39Z

Given that someone may be AFK...

eregon/use-ruby-action@master has moved to ruby/setup-ruby.

For info specific to .ruby_version, see supported-version-syntax.

ruby/setup-ruby supports almost all Ruby versions since 2.2, fully tested head/master builds, and all platforms are supported. Understandably, GitHub prefers not to host EOL software, but others can, as does ruby/setup-ruby. I'm not recommending using it.

Also, most actions that are past development stage are not using master. Or, master may be dangerous, as new features may be developed there. So, use

uses: ruby/setup-ruby@v1

instead of

uses: ruby/setup-ruby@master

mo-rubikal · 2020-04-06T01:51:46Z

That got me confused as I was trying to install my ruby version which I can't give as an argument for setup-ruby, and the only way mentioned as in the example:

    - uses: ruby/setup-ruby@v1
      with:
        ruby-version: 2.6

Until I landed in an example that does so as my last comment, I wonder why that not specified in the docs here, if that is the official one!

MSP-Greg · 2020-04-06T02:08:04Z

Forgive me, I'm confused.

why that not specified in the docs here

here is actions/setup-ruby, which is the action supported by GitHub.

My post was mostly referring to ruby/setup-ruby (which is where eregon/use-ruby-action moved to) which is within the Ruby organization, and is not supported by GitHub.

If, using ruby/setup-ruby, you want to read Ruby version info from the .ruby-version file, use:

- uses: ruby/setup-ruby@v1
  with:
    ruby-version: .ruby-version

You can also not include the ruby-version: input, but specifying .ruby-version makes it very clear where the info is retrieved from.

mo-rubikal · 2020-04-06T02:15:14Z

Thanks, @MSP-Greg for clarification, both have the same name really confused me, between Ruby and Actions, and BTW when I used:

uses: ruby/setup-ruby@v1

without with clause it worked as well

eregon · 2020-04-06T09:31:00Z

@mo-rubikal Glad you found how to use it.
Do you think the docs at https://github.com/ruby/setup-ruby#usage are clear enough about this?
If not, please file an issue and I'll try to improve them.

This was referenced Nov 4, 2019

Support .ruby-version masa-iwasaki/setup-ruby#1

Closed

Support .ruby_version #37

Closed

bryanmacfarlane added the enhancement New feature or request label Jan 7, 2020

eregon mentioned this issue Jan 12, 2020

Update/Add RVM actions/runner-images#5

Closed

5 tasks

waltz added a commit to waltz/imploder that referenced this issue Feb 28, 2020

Use a clever method for finding the current ruby version

b1d5d43

actions/setup-ruby#31 (comment)

waltz mentioned this issue Mar 1, 2020

Switch from Travis CI to GitHub Actions (#27) waltz/imploder#29

Merged

lawrence-forooghian added a commit to lawrence-forooghian/git-update-messages that referenced this issue Mar 26, 2020

Set up GitHub Actions for testing

3b48772

The step to respect `.ruby-version` is taken from actions/setup-ruby#31 (comment).

lawrence-forooghian added a commit to lawrence-forooghian/git-update-messages that referenced this issue Mar 26, 2020

Set up GitHub Actions for testing

9e25c19

The step to respect `.ruby-version` is taken from actions/setup-ruby#31 (comment).

waltz mentioned this issue Jan 24, 2021

Switch from Travis CI to GitHub Actions (#27) (#29) waltz/imploder#30

Closed

ncooke3 mentioned this issue Jun 17, 2022

[Infra] Add .ruby-version file for GHA firebase/firebase-ios-sdk#9921

Merged

maeda-seina mentioned this issue Aug 21, 2022

CI環境構築 maeda-seina/piyochan-bot#67

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support .ruby-version #31

Support .ruby-version #31

scottohara commented Sep 28, 2019 •

edited

Loading

tisba commented Nov 28, 2019

sobstel commented Dec 3, 2019 •

edited

Loading

bryanmacfarlane commented Jan 7, 2020

vvo commented Jan 10, 2020 •

edited

Loading

eregon commented Jan 10, 2020 •

edited

Loading

mo-rubikal commented Apr 6, 2020

MSP-Greg commented Apr 6, 2020

mo-rubikal commented Apr 6, 2020

MSP-Greg commented Apr 6, 2020

mo-rubikal commented Apr 6, 2020 •

edited

Loading

eregon commented Apr 6, 2020

Support .ruby-version #31

Support .ruby-version #31

Comments

scottohara commented Sep 28, 2019 • edited Loading

tisba commented Nov 28, 2019

sobstel commented Dec 3, 2019 • edited Loading

bryanmacfarlane commented Jan 7, 2020

vvo commented Jan 10, 2020 • edited Loading

eregon commented Jan 10, 2020 • edited Loading

mo-rubikal commented Apr 6, 2020

MSP-Greg commented Apr 6, 2020

mo-rubikal commented Apr 6, 2020

MSP-Greg commented Apr 6, 2020

mo-rubikal commented Apr 6, 2020 • edited Loading

eregon commented Apr 6, 2020

scottohara commented Sep 28, 2019 •

edited

Loading

sobstel commented Dec 3, 2019 •

edited

Loading

vvo commented Jan 10, 2020 •

edited

Loading

eregon commented Jan 10, 2020 •

edited

Loading

mo-rubikal commented Apr 6, 2020 •

edited

Loading