Windows Actions CI - use $ErrorActionPreference for bundler install step #1531

MSP-Greg · 2020-01-30T15:45:16Z

At present, all Actions Windows Rubies have Bundler installed. If an update is needed, doing so with gem update --system is probably a better idea.

slonopotamus · 2020-01-30T15:59:59Z

.github/workflows/ci.yml

+          bundle config --local path .bundle/gems
+          bundle config --local without docs lint coverage
+          # warning output can confuse Powershell in CI, (multi-line scripts & exit codes)
+          $env:RUBYOPT = '-W0'


What if bundler call is split into a separate step? Does it also fail to print warnings?

@mojavelinux and what's the point storing gems in .bundle/gems? Ain't everything supposed to work regardles of gems location? Whole CI VM will be dropped anyway after build is finished.

@slonopotamus

What if bundler call is split into a separate step? Does it also fail to print warnings

It's not about it failing to print warnings. It's about warnings causing the step to fail when they shouldn't.

There's been discussion in RubyGems about this, in that warnings are printed when a user has no control over the gem in question. The idea was to change the warnings to only show when the gem is built, not when it is installed.

The use of path is no about caching. It's about testing the installation of the CLI correctly and in isolation. Without specifying a path, the CLI location test has to be partially faked.

slonopotamus · 2020-01-30T16:20:31Z

Oh, you mean it exits with 1 on warnings? That's weird.

MSP-Greg · 2020-01-30T16:20:40Z

@slonopotamus

Re gem location (.bundle/gems), that can be cached in Actions so they aren't downloaded all the time. But, I think the caches empty after seven days, so if there aren't a lot of commits/PR's...

I didn't set up caching. Using .bundle/gems can be helpful for people working locally.

MSP-Greg · 2020-01-30T16:26:02Z

@slonopotamus

Oh, you mean it exits with 1 on warnings? That's weird.

Yes, see some of the previous actions jobs.

Quite the PITA. I've had the issue before (and also on Appveyor). As I mentioned in ruby/setup-ruby#13, I do not have the issue running the commands locally. Someday I have to track the issue down re PowerShell configuration...

slonopotamus · 2020-01-30T16:28:07Z

I would avoid caching unless there's a strong need to improve build times, because it can hide bugs when gems are available because they were cached and not because there's a dependency on them.

mojavelinux · 2020-01-30T21:37:34Z

all Actions Windows Rubies have Bundler installed.

Oh, I didn't realize that. Then no need for this step. I was just following the README https://github.com/eregon/use-ruby-action#caching-bundle-install (which I now see says that Bundler is already there).

mojavelinux · 2020-01-30T21:39:09Z

Using .bundle/gems can be helpful for people working locally.

It also forces Bundler to install the CLI (the bin scripts) for the current gem, which then allows me to test the CLI properly.

mojavelinux · 2020-01-30T21:40:06Z

But why do we get warnings when bundle config is used and not when the CLI flags like --path are used? I don't get it.

mojavelinux · 2020-01-30T21:40:34Z

.github/workflows/ci.yml

+          bundle config --local path .bundle/gems
+          bundle config --local without docs lint coverage
+          # warning output can confuse Powershell in CI, (multi-line scripts & exit codes)
+          $env:RUBYOPT = '-W0'


Sweet trick!

Except don't we need to unset it afterwards so it doesn't remain set while running tests?

Except don't we need to unset it afterwards so it doesn't remain set while running tests?

No. Big difference between Azure Pipelines / GitHub Actions and Travis / AppVeyor. In Actions, changes to the environment do not affect subsequent steps, unless one uses something like:

echo '::set-env name=JOBS::'-j$((1 + $(nproc --all)))

Sometimes it's helpful, often not...

Thanks for the info!

mojavelinux · 2020-01-30T21:52:00Z

So my question still stands, what is the warning? And how is this different from the warning when --path is used?

[DEPRECATED] The `--path` flag is deprecated because it relies on being remembered across bundler invocations, which bundler will no longer do in future versions. Instead please use `bundle config set path '.bundle/gems'`, and stop using this flag

slonopotamus · 2020-01-30T21:53:08Z

But why do we get warnings when bundle config is used and not when the CLI flags like --path are used? I don't get it.

Could you once again give a link to workflow run with warnings? AFAIR, there was something about prawn-tables, but not about config options you use.

mojavelinux · 2020-01-30T22:00:59Z

there was something about prawn-tables

That was just the last message logged. It has nothing to do with this situation.

But why do we get warnings when bundle config is used and not when the CLI flags like --path are used?

Here's an example:

https://github.com/asciidoctor/asciidoctor-pdf/runs/416845301

(view the raw log)

slonopotamus · 2020-01-30T22:03:20Z

@mojavelinux have you tried splitting that in separate steps so it becomes clear which exact comand returns 1?

mojavelinux · 2020-01-30T22:03:21Z

Here's what I'm saying. If I run this it works fine:

bundle --jobs 3 --retry 3 --path .bundle/gems --without docs lint coverage

If I run this, it fails:

bundle config --local path .bundle/gems
bundle config --local without docs lint coverage
bundle --jobs 3 --retry 3

Why does it die in one case and not in the other? It's exactly the same set of instructions. The only difference is that there are 3 commands instead of 1.

Btw, the same thing happens if I write directly to .bundle/config instead of using bundle config.

I get that using -W0 is the fix. I just want to know why it is needed in the second case.

mojavelinux · 2020-01-30T22:05:55Z

The command that fails is bundle --retry 3 --jobs 3. If we split in separate steps, maybe that also solves it. I guess we could try.

MSP-Greg · 2020-01-30T22:32:13Z

Have at it. As I've mentioned, I could not repo this locally. See
ruby/setup-ruby#13 (comment)

mojavelinux · 2020-01-30T23:13:16Z

I've been able to confirm that using separate steps also solves the problem. I'm going to go with that approach instead. Thanks for helping us troubleshoot this, @MSP-Greg! Much appreciated!

MSP-Greg · 2020-01-30T23:20:32Z

Give me a second, running CI now...

mojavelinux · 2020-01-30T23:30:06Z

Sure thing, take your time.

MSP-Greg · 2020-01-30T23:46:21Z

Thanks. I changed it to use $ErrorActionPreference. I'll write some code to locally see if I can determine what's going on. Don't know what you'd prefer...

mojavelinux · 2020-01-30T23:57:15Z

But you didn't remove $env:RUBYOPT = '-W0', which we already determined fixes the issue. Did you mean to leave that in?

MSP-Greg · 2020-01-31T00:01:54Z

Did you mean to leave that in?

I knew that. No, I did not. Sorry, fixed.

mojavelinux · 2020-01-31T00:14:06Z

Yeah, that worked. Wow, now we have like 3 different ways of solving this issue.

I'll quickly summarize:

Run $env:RUBYOPT = '-W0' before calling bundle install if bundle config is used in same step
Run $ErrorActionPreference = 'Continue' before calling bundle install if bundle config is used in same step
Move bundle config to separate step

Does that look right?

MSP-Greg · 2020-01-31T00:30:51Z

Yes. I still can't repo this locally. Every command seems to exiting with zero. I hate this.

I think $ErrorActionPreference = 'Continue' is probably the best, as it shows what seems to be the problem...

mojavelinux · 2020-01-31T00:34:45Z

Thanks again! I'll stick with the final result then. Cheers!

slonopotamus · 2020-01-31T05:57:22Z

I'll stick with the final result then.

Splitting steps would keep build script cross-platform. You don't need that right now, though.

mojavelinux · 2020-01-31T06:32:42Z

I went ahead and did both. That way we can monitor output in the interim, but disable the setting when it comes time to go cross platform.

MSP-Greg mentioned this pull request Jan 30, 2020

bundle install fails on windows-latest after using bundle config ruby/setup-ruby#13

Closed

slonopotamus reviewed Jan 30, 2020

View reviewed changes

mojavelinux reviewed Jan 30, 2020

View reviewed changes

MSP-Greg force-pushed the windows-actions branch 2 times, most recently from a558830 to 88d47a9 Compare January 30, 2020 23:26

MSP-Greg changed the title ~~Windows Actions CI - warnings to 0 for bundle install~~ Windows Actions CI - use $ErrorActionPreference for bundler install step Jan 30, 2020

Windows Actions CI - use $ErrorActionPreference for bundler install step

68bece6

MSP-Greg force-pushed the windows-actions branch from 88d47a9 to 68bece6 Compare January 31, 2020 00:01

mojavelinux merged commit 847765a into asciidoctor:master Jan 31, 2020

MSP-Greg deleted the windows-actions branch January 31, 2020 00:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Windows Actions CI - use $ErrorActionPreference for bundler install step #1531

Windows Actions CI - use $ErrorActionPreference for bundler install step #1531

MSP-Greg commented Jan 30, 2020

slonopotamus Jan 30, 2020 •

edited

Loading

slonopotamus Jan 30, 2020

MSP-Greg Jan 30, 2020

mojavelinux Jan 30, 2020

slonopotamus commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020

slonopotamus commented Jan 30, 2020

mojavelinux commented Jan 30, 2020

mojavelinux commented Jan 30, 2020 •

edited

Loading

mojavelinux commented Jan 30, 2020

mojavelinux Jan 30, 2020

mojavelinux Jan 30, 2020

MSP-Greg Jan 30, 2020

mojavelinux Jan 30, 2020

mojavelinux commented Jan 30, 2020

slonopotamus commented Jan 30, 2020

mojavelinux commented Jan 30, 2020 •

edited

Loading

slonopotamus commented Jan 30, 2020 •

edited

Loading

mojavelinux commented Jan 30, 2020 •

edited

Loading

mojavelinux commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020

mojavelinux commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020

mojavelinux commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020 •

edited

Loading

mojavelinux commented Jan 30, 2020

MSP-Greg commented Jan 31, 2020

mojavelinux commented Jan 31, 2020

MSP-Greg commented Jan 31, 2020

mojavelinux commented Jan 31, 2020

slonopotamus commented Jan 31, 2020

mojavelinux commented Jan 31, 2020

Windows Actions CI - use $ErrorActionPreference for bundler install step #1531

Windows Actions CI - use $ErrorActionPreference for bundler install step #1531

Conversation

MSP-Greg commented Jan 30, 2020

slonopotamus Jan 30, 2020 • edited Loading

Choose a reason for hiding this comment

slonopotamus Jan 30, 2020

Choose a reason for hiding this comment

MSP-Greg Jan 30, 2020

Choose a reason for hiding this comment

mojavelinux Jan 30, 2020

Choose a reason for hiding this comment

slonopotamus commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020

slonopotamus commented Jan 30, 2020

mojavelinux commented Jan 30, 2020

mojavelinux commented Jan 30, 2020 • edited Loading

mojavelinux commented Jan 30, 2020

mojavelinux Jan 30, 2020

Choose a reason for hiding this comment

mojavelinux Jan 30, 2020

Choose a reason for hiding this comment

MSP-Greg Jan 30, 2020

Choose a reason for hiding this comment

mojavelinux Jan 30, 2020

Choose a reason for hiding this comment

mojavelinux commented Jan 30, 2020

slonopotamus commented Jan 30, 2020

mojavelinux commented Jan 30, 2020 • edited Loading

slonopotamus commented Jan 30, 2020 • edited Loading

mojavelinux commented Jan 30, 2020 • edited Loading

mojavelinux commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020

mojavelinux commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020

mojavelinux commented Jan 30, 2020

MSP-Greg commented Jan 30, 2020 • edited Loading

mojavelinux commented Jan 30, 2020

MSP-Greg commented Jan 31, 2020

mojavelinux commented Jan 31, 2020

MSP-Greg commented Jan 31, 2020

mojavelinux commented Jan 31, 2020

slonopotamus commented Jan 31, 2020

mojavelinux commented Jan 31, 2020

slonopotamus Jan 30, 2020 •

edited

Loading

mojavelinux commented Jan 30, 2020 •

edited

Loading

mojavelinux commented Jan 30, 2020 •

edited

Loading

slonopotamus commented Jan 30, 2020 •

edited

Loading

mojavelinux commented Jan 30, 2020 •

edited

Loading

MSP-Greg commented Jan 30, 2020 •

edited

Loading