Skip to content

Conversation

@stefannibrasil
Copy link
Contributor

@stefannibrasil stefannibrasil commented Jan 14, 2026

Motivation / Background

This Pull Request has been created because bumping rdoc without handling the erb version constraint for Ruby 3.1 breaks CI. See #3178

When bumping 'rdoc''s version, we need to handle 'erb' manually while Ruby 3.1 is still supported.

Closes #3182

Additional information

Since I was working on CI, I took the opportunity to cache the dependencies automatically using ruby/setup-ruby recommendation.

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, refactor something, or add a feature.
  • Tests and Rubocop are passing before submitting your proposed changes.

@stefannibrasil stefannibrasil changed the title Sb rdoc bump version ci errors Remove 'rdoc' dependency and improve CI bundle cache Jan 14, 2026
@stefannibrasil stefannibrasil changed the title Remove 'rdoc' dependency and improve CI bundle cache Bump 'rdoc' dependency, handle 'erb' version constraint with Ruby 3.1 and improve CI bundle cache Jan 14, 2026
To speed our CI a bit, let's cache the dependencies.
I am using the recommended cache strategy for Ruby:
https://github.com/actions/cache/blob/main/examples.md#ruby---bundler

Additionally, to use the `--without` configuration, we need
to explicitely set the configuration keys through the environment:
https://bundler.io/man/bundle-config.1.html#CONFIGURATION-KEYS
After changing CI to use ruby/setup-ruby cache,
CI fails for Ruby 3.1 because 'erbv 6.0' is not compatible
with that ruby version.
Although RUby 3.1 is EOL, we will support it until
Ruby 3.2 becomes EOL.
@stefannibrasil stefannibrasil force-pushed the sb-rdoc-bump-version-ci-errors branch from 2cbf8e8 to adb6cc5 Compare January 14, 2026 21:04
@stefannibrasil stefannibrasil marked this pull request as ready for review January 14, 2026 21:09

PLATFORMS
arm64-darwin-22
arm64-darwin
Copy link
Contributor Author

@stefannibrasil stefannibrasil Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the specific versions that is being removed, I was getting a diff every time I ran bundle install.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix errors when upgrading 'rdoc'

2 participants