pin ruby version - Githubissues

lsf37 commented 6 months ago

pin the ruby version to 3.3.1 (most recent stable)
update Gemfile for 3.3.1 warnings
update Gemfile.lock to be compatible
use the setup-ruby GitHub action to get the correct ruby version in CI, including caching of dependencies.

We could actually do the pinning of ruby version in the main Gemfile here as well now, but it would still produce an error to run it with anything else, which is possibly a bit too strict. Happy for input on that one.

github-actions[bot] commented 6 months ago

Preview your changes here

The link checker found some issues!

bundler: failed to load command: htmlproofer (/home/runner/work/website/website/vendor/bundle/ruby/3.3.0/bin/htmlproofer)
/home/runner/work/website/website/vendor/bundle/ruby/3.3.0/gems/html-proofer-5.0.9/lib/html_proofer/configuration.rb:68:in `parse_cli_options': needless argument: --enforce-https=false (OptionParser::NeedlessArgument)
    from /home/runner/work/website/website/vendor/bundle/ruby/3.3.0/gems/html-proofer-5.0.9/lib/html_proofer/cli.rb:14:in `run'
    from /home/runner/work/website/website/vendor/bundle/ruby/3.3.0/gems/html-proofer-5.0.9/exe/htmlproofer:14:in `block in <top (required)>'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/3.3.0/benchmark.rb:313:in `realtime'
    from /home/runner/work/website/website/vendor/bundle/ruby/3.3.0/gems/html-proofer-5.0.9/exe/htmlproofer:14:in `<top (required)>'
    from /home/runner/work/website/website/vendor/bundle/ruby/3.3.0/bin/htmlproofer:25:in `load'
    from /home/runner/work/website/website/vendor/bundle/ruby/3.3.0/bin/htmlproofer:25:in `<top (required)>'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/cli/exec.rb:58:in `load'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/cli/exec.rb:58:in `kernel_load'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/cli/exec.rb:23:in `run'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/cli.rb:451:in `exec'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/vendor/thor/lib/thor/command.rb:28:in `run'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/vendor/thor/lib/thor/invocation.rb:127:in `invoke_command'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/vendor/thor/lib/thor.rb:527:in `dispatch'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/cli.rb:34:in `dispatch'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/vendor/thor/lib/thor/base.rb:584:in `start'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/cli.rb:28:in `start'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/exe/bundle:28:in `block in <top (required)>'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/lib/bundler/friendly_errors.rb:117:in `with_friendly_errors'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/lib/ruby/gems/3.3.0/gems/bundler-2.5.9/exe/bundle:20:in `<top (required)>'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/bin/bundle:25:in `load'
    from /opt/hostedtoolcache/Ruby/3.3.1/x64/bin/bundle:25:in `<main>'
make: *** [Makefile:54: checklinks] Error 1

lsf37 commented 6 months ago

Well, good that the PR checks are running everything. I had not tried the link checker. Now need to find the versions of things that work..

github-actions[bot] commented 6 months ago

Preview your changes here

github-actions[bot] commented 6 months ago

Preview your changes here

lsf37 commented 6 months ago

I've checked this now with the following, and they are all working:

Darwin Intel
Darwin Apple Silicon
Linux arm64 (via docker)
Linux x86 (via docker)

The htmlproofer error seems to be something that starts happening in version 5 of htmlproofer, so I've constrained it to major version 4 in the Gemfile.

lsf37 commented 6 months ago

I think it would help to document in the commit message what you did exactly to update Gemfile.lock and definitely document any manual changes you made and why.

I would annotate all manual changes in the Gemfile.lock with explanations why it's done. (It seems you did that to get it working on Mac, but no idea if there's anything else.)

I made no manual changes to Germfile.lock, they were all the result of bundle update and bundle lock --add-platform .... But I can add that to the commit message so we know how we got there in the future.

lsf37 commented 6 months ago

(e.g. pinning html-proofer to major version 4 is the result of gem "html-proofer", "~>4" in Gemfile, which will cause bundle update to not go beyond version 4, but pick the most recent minor and patch versions)

github-actions[bot] commented 6 months ago

Preview your changes here

Indanz commented 6 months ago

I made no manual changes to Germfile.lock, they were all the result of bundle update and bundle lock --add-platform .... But I can add that to the commit message so we know how we got there in the future.

Great, the --add-platform explains it all then. Because of that I wasn't sure if there was anything else and I got paranoid because of some commits in the past. All good.

seL4 / website

pin ruby version #352