Contrib.social

Internal checks create TODO finder.

Open on Drupal.org →
Created on 12 August 2024, 3 months ago
Updated 29 August 2024, 2 months ago

Problem/Motivation

We have a few "@todo" in the code. It'd be great if we can have visibility of those in the CI job. It doesn't need to fail, but just show them so we have them more present.

If we make the job generic enough (eg: "look for all '@todo' inside a folder"), we can document it in our documentation in case people want to reuse it in their modules or even create it as an optional job (turned off by default of course).

📌 Task
Status

Active

Component

gitlab-ci

Created by

🇪🇸Spain fjgarlin

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @fjgarlin
  • Comment 2 months ago →
    🇬🇧United Kingdom jonathan1055

    This is a good idea. It could also be enhanced so that for each '@todo' found, we display git blame -L the/file/found for +/-5 lines around the todo, to give the context of the change.

  • Comment 2 months ago →
    🇺🇸United States moshe weitzman Boston, MA

    IMO this is beyond the scope of this project. I suggest finding some code on Gitlab or elsewhere for this and adding a custom job.

  • Comment 2 months ago →
    🇪🇸Spain fjgarlin

    Happy to reuse any existing job elsewhere. Note that this is just an internal task, not for contrib space.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024