Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jasonetco/todo
🤖✅ GitHub App that creates new issues from actionable comments in your code.
https://github.com/jasonetco/todo
github-app github-bot issue-management issues probot probot-app todo
Last synced: 5 days ago
JSON representation
🤖✅ GitHub App that creates new issues from actionable comments in your code.
- Host: GitHub
- URL: https://github.com/jasonetco/todo
- Owner: JasonEtco
- License: isc
- Archived: true
- Created: 2017-09-28T15:26:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-15T01:13:04.000Z (about 3 years ago)
- Last Synced: 2024-09-27T08:02:24.394Z (4 months ago)
- Topics: github-app, github-bot, issue-management, issues, probot, probot-app, todo
- Language: JavaScript
- Homepage: https://todo.jasonet.co
- Size: 3.62 MB
- Stars: 747
- Watchers: 12
- Forks: 70
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This repository has been archived
See [this discussion](https://github.com/JasonEtco/todo/discussions/293) for details on why!
---
todo[bot]
A GitHub App built with Probot that creates new issues based on actionable comments in your code.
## Usage
Using **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!
If I pushed this:
```js
/**
* @todo Take over the world
* @body Humans are weak; Robots are strong. We must cleanse the world of the virus that is humanity.
*/
function ruleOverPunyHumans () {
// We must strategize beep boop
}
```
**todo** would create a new issue:
**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.
## Behaviour in pull requests
To 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.
## Configuring for your project
There are a couple of configuration options in case you need to change the default behaviour.
**Note**: Adding a configuration file is **completely optional**. The defaults are likely fine for most projects, so you might not need to change them.
Add a **todo** object in your `.github/config.yml` file (and make the file if you don't already have it) like this:
```yml
todo:
keyword: "@makeAnIssue"
```
### Available options
| Name | Type | Description | Default |
|------|------|-------------|---------|
| `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` |
| `keyword` | `string[]` | The keyword(s) to use to generate issue titles | `['@todo','TODO']` |
| `bodyKeyword` | `string[]` | If this is in the line right after the main keyword, it will become the generated issue body. | `['@body','BODY']` |
| `blobLines` | `number, boolean` | The number of lines of code to show, starting from the keyword. | `5` |
| `caseSensitive` | `boolean` | Should the keyword be case sensitive? | `false` |
| `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` |
| `reopenClosed` | `boolean` | If an issue already exists and is closed, reopen it. Note: if set to false, no new issue will be created. | `true` |
| `exclude` | `string` | Exclude certain files and/or directories. Should be a valid regular expression. | `null` |
## CLI
There 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:
```
$ node ./bin/todo -o OWNER -r REPO -s SHA
```
You can also parse a local file instead of a sha:
```
$ node ./bin/todo -o OWNER -r REPO -f ./path/to/file.txt
```
Or check a merged PR:
```
$ node ./bin/todo -o OWNER -r REPO --pr NUMBER
```
## Setup
```
# Install dependencies
npm install
# Run the bot
npm start
```
See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app.