mirror of
https://github.com/zhigang1992/probot.github.io.git
synced 2026-03-29 07:48:07 +08:00
64 lines
1.8 KiB
Markdown
64 lines
1.8 KiB
Markdown
---
|
|
title: todo
|
|
description: Creates new issues from actionable comments in your code.
|
|
slug: todo
|
|
screenshots:
|
|
- https://user-images.githubusercontent.com/10660468/31048765-83569c30-a5f2-11e7-933a-a119d43ad029.png
|
|
authors:
|
|
- JasonEtco
|
|
repository: JasonEtco/todo
|
|
host: https://todo-github-app.now.sh
|
|
stars: 87
|
|
updated: 2018-03-02 18:19:53 UTC
|
|
installations: 137
|
|
organizations:
|
|
- mas-cli
|
|
- thibmaek
|
|
- heinrichreimer
|
|
- Laravel-Backpack
|
|
- caarlos0
|
|
- SpoonX
|
|
- icco
|
|
- timvideos
|
|
- getantibody
|
|
- drinchev
|
|
---
|
|
## Usage
|
|
|
|
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:
|
|
|
|
|
|
|
|
## Configuring for your project
|
|
|
|
There are a couple of configuration options in case you need to change the default behaviour. Note that 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 like this:
|
|
|
|
```yml
|
|
todo:
|
|
keyword: "@makeAnIssue"
|
|
|
|
```
|
|
|
|
### Available options
|
|
|
|
| Name | Type | Description | Default |
|
|
|------|------|-------------|---------|
|
|
| autoAssign | `string`, `string[]` or `boolean` | 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 to use to generate issue titles | `@todo` |
|
|
| blobLines | `number` or `false` | The number of lines of code to show, starting from the keyword. | 5 |
|
|
| caseSensitive | `boolean` | Should the keyword be case sensitive? | false |
|