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

Was this helpful?

  1. Commands

Overview

Let Catana edit or remove TODOs from the GitHub UI.

PreviousRuby Version upgradedNextDone

Last updated 5 months ago

Was this helpful?

Catana provides a feature to perform operations on TODOs by commenting on associated GitHub issues.

The pitfall of manually editing TODOs

A common pitfall when a user goes through its TODOs is to leave them untouched while they should either be removed or updated.

Having to go through a git dance and review process only to edit or remove a TODO is tedious, and developers tend to take a mental note to follow up later (aka never).

🤖 The perfect task for a bot

Simple changes like modifying or removing a TODO should be delegated to a bot. Catana's commands are a convenient way to manage TODOs and save developers valuable time.

When a user types a command, Catana will perform the requested operation and open a Pull Request for review. Developers only have to click on the "merge" button.

Usage

To perform a command, reply in a comment to a GitHub issue previously opened by Catana and type @catanacorp followed by the command name.

🤖
  • The pitfall of manually editing TODOs
  • 🤖 The perfect task for a bot
  • Usage