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

Date

PreviousOverviewNextGitHub Issue closed

Last updated 6 months ago

Was this helpful?

Use the date trigger to expire a TODO at a specified date.

Usage with a syntax

➡️ TODO(on:date('2023-06-01')) ➡️ TODO(on:'2023-06-01') (Same as above, but with the short form)

Examples

Expire a TODO on June 1st, 2023

➡️ TODO(on:'2023-06-01')

Expire a TODO on August 23rd, 2023 at 10AM

➡️ TODO(on:'2023-08-23 10:00')

Usage when detected automatically

Catana will always use today's date as reference point for relative dates (next month, in three weeks...). You can omit some components from a date (the day, month or year), in such cases Catana will fill itself, with the final result being a date always in the future. Catana will never detect a date trigger if the date you specify is undetermined (later, someday, when I have time ...).

Examples

TODO: Ensure we use the blob package by Feb. 4 Equivalent to: date('2025-2-4') (Assuming today's date is passed Februry 4)

TODO: Tweak the debounce next week once we have collected enough real traffic data Result: date('2024-11-12') (Assuming today's date is November 5)

TODO: Polish and optimise after hack days Result: No detection, as the event's date can't be determined.

🔔