PHPackages                             aeliot/todo-registrar - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [DevOps &amp; Deployment](/categories/devops)
4. /
5. aeliot/todo-registrar

ActiveApplication[DevOps &amp; Deployment](/categories/devops)

aeliot/todo-registrar
=====================

Register TODOs from source code in issue tracker

4.3.0(1w ago)153.0k1[7 issues](https://github.com/Aeliot-Tm/todo-registrar/issues)MITPHPPHP ^8.2CI passing

Since Jun 13Pushed 1w ago1 watchersCompare

[ Source](https://github.com/Aeliot-Tm/todo-registrar)[ Packagist](https://packagist.org/packages/aeliot/todo-registrar)[ RSS](/packages/aeliot-todo-registrar/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (10)Dependencies (134)Versions (66)Used By (0)

[![logo](https://camo.githubusercontent.com/a13664c82b149e4c24da18de0a8b691afb6df4818546f6edc7bb14744fe6bb8e/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f41656c696f742d546d2f746f646f2d726567697374726172406d61696e2f646f63732f6c6f676f2e737667)](https://camo.githubusercontent.com/a13664c82b149e4c24da18de0a8b691afb6df4818546f6edc7bb14744fe6bb8e/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f41656c696f742d546d2f746f646f2d726567697374726172406d61696e2f646f63732f6c6f676f2e737667)

[![GitHub Release](https://camo.githubusercontent.com/0a375355f904ee0bd5e655708fec4c531251d4ee49a6483efc5ebc8f2a337d8c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f41656c696f742d546d2f746f646f2d7265676973747261723f6c6162656c3d52656c65617365266c6162656c436f6c6f723d336333643431)](https://packagist.org/packages/aeliot/todo-registrar)[![Testing](https://github.com/Aeliot-Tm/todo-registrar/actions/workflows/automated-testing.yaml/badge.svg?branch=main)](https://github.com/Aeliot-Tm/todo-registrar/actions/workflows/automated-testing.yaml?query=branch%3Amain)[![Security Audit](https://github.com/Aeliot-Tm/todo-registrar/actions/workflows/security-audit.yaml/badge.svg?branch=main)](https://github.com/Aeliot-Tm/todo-registrar/actions/workflows/security-audit.yaml?query=branch%3Amain)[![GitHub License](https://camo.githubusercontent.com/a825ed6f29eab177ae55f2443686b43a9d9e9c567f4158b85881fd660820febe/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f41656c696f742d546d2f746f646f2d7265676973747261723f6c6162656c3d4c6963656e7365266c6162656c436f6c6f723d336333643431)](LICENSE)

It scans PHP and YAML source files for TODO/FIXME and other configured tags, registers them as issues in trackers such as JIRA or GitHub, and injects issue keys back into comments — with labels, linked issues, assignees, and other metadata as you configure.

Motivation
----------

[](#motivation)

Developers often leave notes in code so they do not forget to fix something — and then forget anyway. One reason is that such comments are hard to manage centrally.

Why write a comment in code instead of creating an issue? It is convenient: no issue tracker UI, no repeated form filling, and the note sits exactly where the change is needed. Whatever the reason, those comments can stay in the codebase for years.

Someone has to manage them.

This tool registers issues with the parameters you need and injects ticket IDs/keys into the original comments. That prevents duplicate issues and makes it easy to jump from a tracker ticket to the right place in code.

How it works
------------

[](#how-it-works)

1. Detect a TODO (or other configured tag) in a comment.
2. Create an issue in the issue tracker ([list of supported](#supported-issue-trackers)).
3. Inject the ticket key into the comment and save the source file.

[![detect_register_inject.png](https://camo.githubusercontent.com/aac53c6e9ab21fda0b84207415310b30871080d2fa88c5af19d3aa6f4a7b9349/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f41656c696f742d546d2f746f646f2d726567697374726172406d61696e2f646f63732f6465746563745f72656769737465725f696e6a6563742e706e67)](https://camo.githubusercontent.com/aac53c6e9ab21fda0b84207415310b30871080d2fa88c5af19d3aa6f4a7b9349/68747470733a2f2f63646e2e6a7364656c6976722e6e65742f67682f41656c696f742d546d2f746f646f2d726567697374726172406d61696e2f646f63732f6465746563745f72656769737465725f696e6a6563742e706e67)

> See latest **benchmark [here](https://github.com/Aeliot-Tm/todo-registrar-benchmark/blob/main/benchmark.md)**.
>
> According to benchmark **TODO Registrar became quicker 20% since version 4.0.0**.

Using
-----

[](#using)

**Basic usage:**

1. Create a [configuration file](docs/config/general_config.md).
2. Run the CLI with the needed [command line options](docs/command_line_options.md).
3. Commit updated files. You can configure a CI job to run the tool and commit changes automatically.

**Prepared ways to run:**

1. [TODO Registrar Action](https://github.com/marketplace/actions/todo-registrar) for GitHub repositories.
2. [Docker container](docs/using/docker.md).
3. [PHAR file](docs/using/phar.md).
4. [Composer package](docs/using/composer.md).

For GitHub-hosted repositories, the GitHub Action is the simplest option.

Docker provides a fully isolated environment — no dependency on your local PHP version or Composer packages.

A single `PHAR` file also avoids dependency conflicts, but you must match PHP version and extensions on the host.

The Composer package is the most common integration, but less flexible than Docker or PHAR.

### Documentation references

[](#documentation-references)

1. [Processing flow](docs/processing_flow.md) — what happens on each run
2. [Features](docs/features.md) — index of all capabilities
3. [Command line options](docs/command_line_options.md)
4. [Configuration](docs/configuration.md):
    1. [General config](docs/config/general_config.md)
        1. Config format:
            1. [YAML file](docs/config/general_config_yaml.md)
            2. [PHP file](docs/config/general_config_php.md)
            3. [YAML from STDIN](docs/config/general_config_yaml.md#loading-from-stdin)
    2. [Inline config](docs/inline_config.md)
    3. Issue trackers:
        1. [GitHub](docs/registrar/GitHub/config.md)
        2. [GitLab](docs/registrar/GitLab/config.md)
        3. [JIRA](docs/registrar/JIRA/config.md)
        4. [Redmine](docs/registrar/Redmine/config.md)
        5. [Yandex Tracker](docs/registrar/YandexTracker/config.md)
5. [Supported formats of comments](docs/supported_patters_of_comments.md)
6. [Integration on CI](docs/integration_on_ci.md)
7. [Customization](docs/customization.md)

Supported Issue Trackers
------------------------

[](#supported-issue-trackers)

Issue TrackerDescription[![](https://camo.githubusercontent.com/dccd53d6ca653b7c7b8e77f2f3377eaae3f8f594c0a40e66834f4fc299e42c75/68747470733a2f2f63646e2e73696d706c6569636f6e732e6f72672f676974687562)](https://camo.githubusercontent.com/dccd53d6ca653b7c7b8e77f2f3377eaae3f8f594c0a40e66834f4fc299e42c75/68747470733a2f2f63646e2e73696d706c6569636f6e732e6f72672f676974687562) [GitHub](https://github.com/)See [description of configuration](docs/registrar/GitHub/config.md). Supported via API tokens.[![](https://camo.githubusercontent.com/4e55ae7a4ca43ceba7d254b2e2c68c7c5371a47a1f8c4a0085f3f285250b66c6/68747470733a2f2f63646e2e73696d706c6569636f6e732e6f72672f6769746c6162)](https://camo.githubusercontent.com/4e55ae7a4ca43ceba7d254b2e2c68c7c5371a47a1f8c4a0085f3f285250b66c6/68747470733a2f2f63646e2e73696d706c6569636f6e732e6f72672f6769746c6162) [GitLab](https://about.gitlab.com/)See [description of configuration](docs/registrar/GitLab/config.md). Supported via API tokens (HTTP Token or OAuth).[![](https://camo.githubusercontent.com/a5fb20e015365d65a6633464aad5f5b79c214f4da3450632dd1ffc6c03fb9408/68747470733a2f2f63646e2e73696d706c6569636f6e732e6f72672f6a697261)](https://camo.githubusercontent.com/a5fb20e015365d65a6633464aad5f5b79c214f4da3450632dd1ffc6c03fb9408/68747470733a2f2f63646e2e73696d706c6569636f6e732e6f72672f6a697261) [JIRA](https://www.atlassian.com/software/jira)See [description of configuration](docs/registrar/JIRA/config.md). Supported via API tokens.[![](https://camo.githubusercontent.com/5312834d7a3a272e93676ce042a9b141123800decdb3fb6f675c95f77b7d9242/68747470733a2f2f63646e2e73696d706c6569636f6e732e6f72672f7265646d696e65)](https://camo.githubusercontent.com/5312834d7a3a272e93676ce042a9b141123800decdb3fb6f675c95f77b7d9242/68747470733a2f2f63646e2e73696d706c6569636f6e732e6f72672f7265646d696e65) [Redmine](https://www.redmine.org/)See [description of configuration](docs/registrar/Redmine/config.md). Supported via API keys or Basic Auth.[![](https://camo.githubusercontent.com/b37a370a312de8f508b18f523ab5ed847e697ed10b05fe3bd8fd96dbd40d8798/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f662f66332f4c6f676f5f59616e6465785f547261636b65725f323032312e737667)](https://camo.githubusercontent.com/b37a370a312de8f508b18f523ab5ed847e697ed10b05fe3bd8fd96dbd40d8798/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f662f66332f4c6f676f5f59616e6465785f547261636b65725f323032312e737667) [Yandex Tracker](https://tracker.yandex.com/)See [description of configuration](docs/registrar/YandexTracker/config.md). Supported via OAuth tokens.Other Issue TrackersRequest an implementation through the [issues](https://github.com/Aeliot-Tm/todo-registrar/issues) section or see [customization](docs/customization.md) section to do it yourself.GitHub Actions based on the project
-----------------------------------

[](#github-actions-based-on-the-project)

- [TODO Registrar Action](https://github.com/marketplace/actions/todo-registrar) — register issues and create Pull Request on GitHub.
- [TODO Registrar Statistic Action](https://github.com/marketplace/actions/todo-registrar-statistic) — add sticky-comment Pull Request on GitHub with statistic about not registered TODOs code

Articles
--------

[](#articles)

RU:

Contributing
------------

[](#contributing)

Read [contributing instructions](CONTRIBUTING.md).

###  Health Score

52

—

FairBetter than 96% of packages

Maintenance88

Actively maintained with recent releases

Popularity25

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 97.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~17 days

Recently: every ~5 days

Total

45

Last Release

10d ago

Major Versions

v1.8.0 → v2.0.02025-12-19

v2.3.1 → v3.0.02026-01-09

3.5.2 → 4.0.02026-06-07

### Community

Maintainers

![](https://www.gravatar.com/avatar/56d81f2702c20990da8d701ba1083e398c94cfcadfdd27b1a90e7791aac92053?d=identicon)[aeliot-tm](/maintainers/aeliot-tm)

---

Top Contributors

[![Aeliot-Tm](https://avatars.githubusercontent.com/u/8513062?v=4)](https://github.com/Aeliot-Tm "Aeliot-Tm (953 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (15 commits)")[![actions-user](https://avatars.githubusercontent.com/u/65916846?v=4)](https://github.com/actions-user "actions-user (7 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (4 commits)")

---

Tags

ci-cdgithub-issuesgitlab-issuesissue-automationissue-trackingjira-apireadminereadmine-issuesstatic-anaysistodo-automationtodo-commenttodo-registrartodo-trackeryandex-trackerstatic analysisTODO registrarissue-trackingJIRA APIyandex trackercreate issueTODO commenttodo trackingGitHub IssueGitLab IssueReadmine Issue

###  Code Quality

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/aeliot-todo-registrar/health.svg)

```
[![Health](https://phpackages.com/badges/aeliot-todo-registrar/health.svg)](https://phpackages.com/packages/aeliot-todo-registrar)
```

###  Alternatives

[drupal/core-recommended

Locked core dependencies; require this project INSTEAD OF drupal/core.

6942.5M421](/packages/drupal-core-recommended)[typo3/cms

TYPO3 CMS is a free open source Content Management Framework initially created by Kasper Skaarhoj and licensed under GNU/GPL.

1.2k1.9M122](/packages/typo3-cms)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.5k5.9M737](/packages/sylius-sylius)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M577](/packages/shopware-core)[open-dxp/opendxp

Content &amp; Product Management Framework (CMS/PIM)

9421.6k61](/packages/open-dxp-opendxp)[oro/platform

Business Application Platform (BAP)

645143.5k115](/packages/oro-platform)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
