Example values to run

[Reedyuk]

Hi, I dont think its very obvious on how to use this item.
Both the gemfile content and the ruby script are mandatory, what should i put where?

for example, i was to install jazzy.
gem install jazzy

what values should i use?

[viktorbenei]

Hi,

You should specify jazzy for the Gemfile input just like you would in your Gemfile.

https://rubygems.org/gems/jazzy - right side: GEMFILE option : gem 'jazzy', '~> 0.6.3'

Exactly the same as if you'd have a Gemfile, so a full example would be:

source 'https://rubygems.org'

gem 'jazzy', '~> 0.6.3'

[Reedyuk]

Like this?

[viktorbenei]

No,

The whole Gemfile content should be in the Gemfile's content input ;)

source 'https://rubygems.org'

gem 'jazzy', '~> 0.6.3'

In the The Ruby Script input you write your Ruby script.

What exactly do you want to do?

[Reedyuk]

So like this?

I think it should be named differently from Ruby script, because the gemfile is effectively the ruby script. I would say this is the execute command.

[viktorbenei]

Still no :)

This is a Ruby script step. If you want to use a generic command executor, where you execute bundle install, you should use thescript step.

Here, the content should be a ruby script, eg:

puts "Hello world!" 

[viktorbenei]

And the Gemfile you specify will be bundle installed automatically, you just specify the Gemfile content and the Ruby script (content)

[Reedyuk]

ok, then as a feature request can you make it so that the Ruby Script field is optional, currently if you dont put anything in, it fails the step.

[viktorbenei]

What would be the use case for that? If you just want to install a Ruby gem you can use the Script step instead. This step is meant to run Ruby scripts, scripts which are written in Ruby ;)

[Reedyuk]

Because it looks nicer to have a formatted step for Ruby with the icon etc.
Also if that was the case, then why even have Gemfile's content as a parameter.

[viktorbenei]

Well, how else would you specify a required 3rd party gem for a Ruby script? You could of course use multiple script steps, installing the gems and then running a ruby script, but with this step you don't have to. You just specify the required gems for your Ruby script and write the Ruby script, using only one step.

[Reedyuk]

Simply put, instead of failing if a value doesnt exist for the ruby script field, could you change it so that it fails if a value doesnt exist for either ruby script field or gem files content field.
That way it keeps all parties happy 👍

[viktorbenei]

Simply put, instead of failing if a value doesnt exist for the ruby script field

What would be the use-case for this? Gemfile gems are (can be) installed in a different way as system gems, so if you want to install system gems you should rather use the script step and run gem install ... as you would in your Terminal/Command Line.

That said, after reviewing this discussion we found that the defaults of this step could be improved, so this is what we did:

We provide a sensible Gemfile and Ruby script content default. Both are basically no-op, the Gemfile does not install any gem and the script is a simple puts "Hello World", so if you don't care about the script then it'll simply print "Hello World" by default.

These defaults will hopefully demonstrate the usage of this step in a more obvious way, making it easier to see what each input is meant to do.

We did a couple of other minor revisions too (this step was last updated about 9 months ago, since that we developed a couple of new best-practices which this step did not follow), but nothing earth shattering, no breaking changes.

The new version (2.1.0) was just released, should make it easier for you to use the step the next time (because of the "no-op" default values).

I'll close this ticket as I believe this change addressed the concerns you raised, but feel free to comment and I'll reopen it.

Thank you for your contribution! 🚀