Skip to content

ruby-version-released-1.md

Latest commit

 

History

History
61 lines (34 loc) · 2.71 KB

ruby-version-released-1.md

File metadata and controls

61 lines (34 loc) · 2.71 KB

Ruby Version upgraded

{% hint style="info" %} Use the Ruby upgrade trigger to expire a TODO when Ruby is upgraded in your application to a new version. {% endhint %}

Usage with a syntax

➡️ TODO(on:ruby_bump([...]))

Requirements

Catana detects the ruby version your application runs on by parsing the Gemfile.lock file.
Pull Requests introducing a TODO with a ruby_bump trigger will fail validation in the following conditions:

  • Your application does not have a Gemfile.lock file.
  • The Gemfile.lock file is not located at the root of your project.
  • The Gemfile.lock file lacks Ruby Version information because the Gemfile doesn't specify a Ruby Version.

Examples

Expire a TODO when Ruby is upgraded to a version superior to the current one.

➡️ TODO(on:ruby_bump)

Expire a TODO when Ruby is upgraded to version 3.3 or higher.

➡️ TO➡️ TODO(on:ruby_bump('> 3.3'))

Expire a TODO when Ruby is upgraded to 3.2.2

➡️ TO➡️ TODO(on:ruby_bump('3.2.2'))

Usage when detected automatically

Examples

TODO: Use the new Regexp timeout feature once we are on Ruby 3.2
Equivalent to: ruby_bump('3.2')

TODO: No need to remove the tempfile manually on Ruby 3.4, if we use the anonymous keyword
Equivalent to: ruby_bump('3.4')

TODO: Do something after we upgrade Ruby
Equivalent to: ruby_bump()