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

Link

PreviousBumpNextOverview

Last updated 7 months ago

Was this helpful?

The @CatanaCorp link command can be invoked by commenting on a Pull Request.

When to use it

A common convention is to require each TODO to have an associated issue, with the TODO referencing the issue number. This workflow is tedious, as developers need to manually create an issue for each TODO, update the codebase to link the issue number, commit the changes, and finally push to Git.

Catana automates this process, saving you and your team valuable time.

Command

➡️ @catanacorplink

This command performs the following actions:

  • Parses the Pull Request changes and detects new TODO annotations.

  • Opens a GitHub issue for each new TODO item.

  • Edits each TODO in the codebase to reference the corresponding issue. The changes made by the Catana bot are not pushed to your branch but are provided as GitHub suggestions, which you can apply with a single click.

🤖