Catana Documentation
  • 🐱Overview
    • Introduction
    • Installation
  • 📖Core concepts
    • Regular and expiring TODOs
    • Assigning TODOs
    • Create, update and delete
    • Validation
    • Ignored TODOs
  • 🔔Triggers
    • Overview
    • Date
    • GitHub Issue closed
    • GitHub Pull Request closed
    • Ruby Gem released
    • Ruby Gem upgraded
    • Ruby Version released
    • Ruby Version upgraded
  • 🤖Commands
    • Overview
    • Done
    • Bump
    • Link
  • 🔗Grouped TODOs
    • Overview
  • ⚙️Configuration
    • Open GitHub issues
    • Enforce expiring TODOs
    • Rules
    • Exclusion list
Powered by GitBook
On this page
  • Usage with a syntax
  • Usage when detected automatically

Was this helpful?

  1. Triggers

Ruby Gem released

PreviousGitHub Pull Request closedNextRuby Gem upgraded

Last updated 7 months ago

Was this helpful?

Use the Ruby Gem released trigger to expire a TODO when a version of a Gem matching the constraint(s) is released.

Usage with a syntax

➡️ TODO(on:gem_release('nokogiri', '> 1.15'))

Examples

Expire a TODO when the Nokogori Ruby gem is released with a version '> 1.15'

➡️ TODO(on:gem_release('nokogiri', '> 1.15'))

Expire a TODO when the Rails Ruby gem version 7.1 is released

➡️ TODO(on:gem_release('nokogiri', '7.1'))

Expire a TODO when the Devise Ruby gem is released with a version '> 4.9.2' and '< 5'

➡️ TODO(on:gem_release('devise', '> 4.9.2', '< 5'))

Usage when detected automatically

Please ensure you always explicitly mention the term "gem" (literally), for Catana to correctly detect this trigger.

Examples

TODO: Make sure to upgrade when the gem super-fun is released to 3.5.1 Equivalent to: gem_release('super-fun', '3.5.1')

TODO: Check the required redis-rb version once the sidekiq gem gets a new release in the > 7 serie Equivalent to: gem_release('sidekiq', '> 7')

TODO: Do something after kuaz-thermometer cuts 3.4 Equivalent to: No detection as the term "gem" is not mentioned

🔔