{"id":15140202,"url":"https://github.com/jasonetco/todo","last_synced_at":"2025-09-29T08:31:42.878Z","repository":{"id":46643981,"uuid":"105165445","full_name":"JasonEtco/todo","owner":"JasonEtco","description":"🤖✅ GitHub App that creates new issues from actionable comments in your code.","archived":true,"fork":false,"pushed_at":"2022-01-15T01:13:04.000Z","size":3801,"stargazers_count":747,"open_issues_count":0,"forks_count":70,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-09-27T08:02:24.394Z","etag":null,"topics":["github-app","github-bot","issue-management","issues","probot","probot-app","todo"],"latest_commit_sha":null,"homepage":"https://todo.jasonet.co","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JasonEtco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-28T15:26:21.000Z","updated_at":"2024-07-10T14:11:03.000Z","dependencies_parsed_at":"2022-07-20T15:49:53.268Z","dependency_job_id":null,"html_url":"https://github.com/JasonEtco/todo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JasonEtco%2Ftodo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JasonEtco%2Ftodo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JasonEtco%2Ftodo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JasonEtco%2Ftodo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JasonEtco","download_url":"https://codeload.github.com/JasonEtco/todo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234604488,"owners_count":18859164,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-app","github-bot","issue-management","issues","probot","probot-app","todo"],"created_at":"2024-09-26T08:01:36.895Z","updated_at":"2025-09-29T08:31:42.487Z","avatar_url":"https://github.com/JasonEtco.png","language":"JavaScript","readme":"\u003ch1\u003eThis repository has been archived\u003c/h1\u003e\n\nSee [this discussion](https://github.com/JasonEtco/todo/discussions/293) for details on why!\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://avatars2.githubusercontent.com/in/5534?s=128\u0026v=4\" width=\"64\"\u003e\n  \u003ch3 align=\"center\"\u003e\u003ca href=\"https://todo.jasonet.co\"\u003etodo[bot]\u003c/a\u003e\u003c/h3\u003e\n  \u003cp align=\"center\"\u003eA GitHub App built with \u003ca href=\"https://github.com/probot/probot\"\u003eProbot\u003c/a\u003e that creates new issues based on actionable comments in your code.\u003cp\u003e\n  \u003cp align=\"center\"\u003e\u003ca href=\"https://github.com/JasonEtco/actions-toolkit\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/JasonEtco/actions-toolkit/workflows/Node%20CI/badge.svg\"\u003e\u003c/a\u003e \u003ca href=\"https://codecov.io/gh/JasonEtco/todo/\"\u003e\u003cimg src=\"https://img.shields.io/codecov/c/github/JasonEtco/todo.svg\" alt=\"Codecov\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\n## Usage\n\nUsing **todo** should be really simple. Once you've installed it in your repository, simply push some code (to your default branch, a PR; doesn't matter). If the code you pushed includes one of the configured keywords (defaults are `@todo` and `TODO`), then the integration will create a new issue for you using the comment your wrote in your code!\n\nIf I pushed this:\n\n```js\n/**\n * @todo Take over the world\n * @body Humans are weak; Robots are strong. We must cleanse the world of the virus that is humanity.\n */\nfunction ruleOverPunyHumans () {\n  // We must strategize beep boop\n}\n```\n\n**todo** would create a new issue:\n\n![todo](https://user-images.githubusercontent.com/10660468/31048765-83569c30-a5f2-11e7-933a-a119d43ad029.png)\n\n**Note:** While the above example is in Javascript, **todo** has been tested in JS, Go, C, C#, Ruby, Bash and Python, and should work in any language.\n\n## Behaviour in pull requests\n\nTo reduce noise and keep your **todo** notes in the right context, **todo** comments made in commits that are part of a pull request will be converted into comments on that pull request. When the PR is merged, **todo** will determine which of those **todo**s have yet to be resolved and open an appropriate issue. \n\n## Configuring for your project\n\nThere are a couple of configuration options in case you need to change the default behaviour.\n\n**Note**: Adding a configuration file is **completely optional**. The defaults are likely fine for most projects, so you might not need to change them.\n\nAdd a **todo** object in your `.github/config.yml` file (and make the file if you don't already have it) like this:\n\n```yml\ntodo:\n  keyword: \"@makeAnIssue\"\n\n```\n\n### Available options\n\n\u003c!--DOC GENERATOR--\u003e\n| Name | Type | Description | Default |\n|------|------|-------------|---------|\n| `autoAssign` | `boolean, string[], string` | Should **todo** automatically assign a user to the new issue? If `true`, it'll assign whoever pushed the code. If a string, it'll assign that user by username. You can also give it an array of usernames or `false` to not assign anyone. | `true` |\n| `keyword` | `string[]` | The keyword(s) to use to generate issue titles | `['@todo','TODO']` |\n| `bodyKeyword` | `string[]` | If this is in the line right after the main keyword, it will become the generated issue body. | `['@body','BODY']` |\n| `blobLines` | `number, boolean` | The number of lines of code to show, starting from the keyword. | `5` |\n| `caseSensitive` | `boolean` | Should the keyword be case sensitive? | `false` |\n| `label` | `boolean, string[]` | Add a label to the new issue. If true, add the `todo` label. If false, don't add any label.You can also give it a label name or an array of label names. | `true` |\n| `reopenClosed` | `boolean` | If an issue already exists and is closed, reopen it. Note: if set to false, no new issue will be created. | `true` |\n| `exclude` | `string` | Exclude certain files and/or directories. Should be a valid regular expression. | `null` |\n\u003c!--ENDDOC GENERATOR--\u003e\n\n## CLI\n\nThere is a CLI tool in this repo that you can use to verify that **todo** is working on your commits. This tool will not actually create new issues, but will let you know what issues a commit _would_ create. Follow the setup instructions below, then run:\n\n```\n$ node ./bin/todo -o OWNER -r REPO -s SHA\n```\n\nYou can also parse a local file instead of a sha:\n\n```\n$ node ./bin/todo -o OWNER -r REPO -f ./path/to/file.txt\n```\n\nOr check a merged PR:\n\n```\n$ node ./bin/todo -o OWNER -r REPO --pr NUMBER\n```\n\n## Setup\n\n```\n# Install dependencies\nnpm install\n\n# Run the bot\nnpm start\n```\n\nSee [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjasonetco%2Ftodo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjasonetco%2Ftodo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjasonetco%2Ftodo/lists"}