docs: auto-update documentation based on changes in next branch
This PR was automatically generated to update documentation based on recent changes. Original commit: feat: implement tdd workflow (#1309)\n\nCo-authored-by: Claude <noreply@anthropic.com>\nCo-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>\n\n Co-authored-by: Claude <claude-assistant@anthropic.com>
This commit is contained in:
@@ -20,7 +20,7 @@ To optimize LLM context usage, you can control which Task Master MCP tools are l
|
||||
### Configuration Modes
|
||||
|
||||
#### All Tools (Default)
|
||||
Loads all 36 available tools. Use when you need full Task Master functionality.
|
||||
Loads all 44 available tools. Use when you need full Task Master functionality.
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -40,7 +40,7 @@ Loads all 36 available tools. Use when you need full Task Master functionality.
|
||||
If `TASK_MASTER_TOOLS` is not set, all tools are loaded by default.
|
||||
|
||||
#### Core Tools (Lean Mode)
|
||||
Loads only 7 essential tools for daily development. Ideal for minimal context usage.
|
||||
Loads only 12 essential tools for daily development. Ideal for minimal context usage.
|
||||
|
||||
**Core tools included:**
|
||||
- `get_tasks` - List all tasks
|
||||
@@ -50,6 +50,11 @@ Loads only 7 essential tools for daily development. Ideal for minimal context us
|
||||
- `update_subtask` - Add implementation notes
|
||||
- `parse_prd` - Generate tasks from PRD
|
||||
- `expand_task` - Break down tasks into subtasks
|
||||
- `autopilot_start` - Start TDD workflow
|
||||
- `autopilot_next` - Get next workflow action
|
||||
- `autopilot_status` - Check workflow status
|
||||
- `autopilot_complete_phase` - Complete workflow phase
|
||||
- `autopilot_commit` - Commit workflow changes
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -69,7 +74,7 @@ Loads only 7 essential tools for daily development. Ideal for minimal context us
|
||||
You can also use `"lean"` as an alias for `"core"`.
|
||||
|
||||
#### Standard Tools
|
||||
Loads 15 commonly used tools. Balances functionality with context efficiency.
|
||||
Loads 20 commonly used tools. Balances functionality with context efficiency.
|
||||
|
||||
**Standard tools include all core tools plus:**
|
||||
- `initialize_project` - Set up new projects
|
||||
@@ -80,6 +85,9 @@ Loads 15 commonly used tools. Balances functionality with context efficiency.
|
||||
- `generate` - Generate task markdown files
|
||||
- `add_task` - Create new tasks
|
||||
- `complexity_report` - View complexity analysis
|
||||
- `autopilot_resume` - Resume interrupted workflow
|
||||
- `autopilot_finalize` - Complete and merge workflow
|
||||
- `autopilot_abort` - Abort current workflow
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -129,8 +137,8 @@ When the MCP server starts, it logs which tools were loaded:
|
||||
Task Master MCP Server starting...
|
||||
Tool mode configuration: standard
|
||||
Loading standard tools
|
||||
Registering 15 MCP tools (mode: standard)
|
||||
Successfully registered 15/15 tools
|
||||
Registering 20 MCP tools (mode: standard)
|
||||
Successfully registered 20/20 tools
|
||||
```
|
||||
|
||||
## Tool Categories
|
||||
@@ -185,4 +193,15 @@ The MCP tools can be categorized in the same way as the core functionalities:
|
||||
- **`list_tags`**: Lists all tags.
|
||||
- **`use_tag`**: Switches to a different tag.
|
||||
- **`rename_tag`**: Renames a tag.
|
||||
- **`copy_tag`**: Copies a tag.
|
||||
- **`copy_tag`**: Copies a tag.
|
||||
|
||||
### 7. Autonomous TDD Workflow (Autopilot)
|
||||
|
||||
- **`autopilot_start`**: Initialize autonomous TDD workflow for a task.
|
||||
- **`autopilot_next`**: Get next action with context in the workflow.
|
||||
- **`autopilot_status`**: Check current workflow status and progress.
|
||||
- **`autopilot_complete_phase`**: Complete current phase with test results.
|
||||
- **`autopilot_commit`**: Commit changes with generated metadata.
|
||||
- **`autopilot_resume`**: Resume interrupted workflow from saved state.
|
||||
- **`autopilot_finalize`**: Complete workflow and merge changes.
|
||||
- **`autopilot_abort`**: Abort current workflow and clean up state.
|
||||
@@ -33,7 +33,47 @@ description: "Configure Task Master through environment variables in a .env file
|
||||
|
||||
## TDD Workflow Configuration
|
||||
|
||||
Additional options for autonomous TDD workflow:
|
||||
Comprehensive options for autonomous TDD workflow via `.taskmaster/config.json`:
|
||||
|
||||
### Core Workflow Settings
|
||||
|
||||
| Setting | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `workflow.enableAutopilot` | `true` | Enable autopilot/TDD workflow features |
|
||||
| `workflow.maxPhaseAttempts` | `3` | Maximum retry attempts for phase validation |
|
||||
| `workflow.branchPattern` | `"task-{taskId}"` | Branch naming pattern for workflow branches |
|
||||
| `workflow.requireCleanWorkingTree` | `true` | Require clean working tree before starting workflow |
|
||||
| `workflow.autoStageChanges` | `true` | Automatically stage all changes during commit phase |
|
||||
|
||||
### Commit Configuration
|
||||
|
||||
| Setting | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `workflow.includeCoAuthor` | `true` | Include co-author attribution in commits |
|
||||
| `workflow.coAuthorName` | `"Claude"` | Co-author name for commit messages |
|
||||
| `workflow.coAuthorEmail` | `"noreply@anthropic.com"` | Co-author email for commit messages |
|
||||
| `workflow.commitMessageTemplate` | `"{type}: {description}\n\n{body}"` | Commit message template pattern |
|
||||
| `workflow.defaultCommitType` | `"feat"` | Default commit type for autopilot |
|
||||
| `workflow.allowedCommitTypes` | `["feat", "fix", "refactor", "test", "docs", "chore"]` | Allowed conventional commit types |
|
||||
|
||||
### Test Validation Thresholds
|
||||
|
||||
| Setting | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `workflow.testThresholds.minTests` | `1` | Minimum test count for valid RED phase |
|
||||
| `workflow.testThresholds.maxFailuresInGreen` | `0` | Maximum allowed failing tests in GREEN phase |
|
||||
|
||||
### Activity Logging
|
||||
|
||||
| Setting | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `workflow.enableActivityLogging` | `true` | Enable activity logging for workflow events |
|
||||
| `workflow.activityLogPath` | `".taskmaster/logs"` | Path to store workflow activity logs |
|
||||
| `workflow.enableStateBackup` | `true` | Enable automatic backup of workflow state |
|
||||
| `workflow.maxStateBackups` | `10` | Maximum workflow state backups to retain |
|
||||
| `workflow.operationTimeout` | `300000` | Timeout for workflow operations in milliseconds |
|
||||
|
||||
### Environment Variables (Legacy Support)
|
||||
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
@@ -41,9 +81,11 @@ Additional options for autonomous TDD workflow:
|
||||
| `TM_AUTO_COMMIT` | `true` | Auto-commit after GREEN phase |
|
||||
| `TM_PROJECT_ROOT` | Current dir | Default project root |
|
||||
|
||||
## Example .env File
|
||||
## Example Configuration
|
||||
|
||||
```
|
||||
### Environment Variables (.env file)
|
||||
|
||||
```bash
|
||||
# Required
|
||||
ANTHROPIC_API_KEY=sk-ant-api03-your-api-key
|
||||
|
||||
@@ -66,11 +108,56 @@ DEFAULT_PRIORITY=medium
|
||||
DEBUG=false
|
||||
LOG_LEVEL=info
|
||||
|
||||
# TDD Workflow
|
||||
# TDD Workflow (Legacy)
|
||||
TM_MAX_ATTEMPTS=3
|
||||
TM_AUTO_COMMIT=true
|
||||
```
|
||||
|
||||
### Config JSON (.taskmaster/config.json)
|
||||
|
||||
```json
|
||||
{
|
||||
"models": {
|
||||
"main": "claude-3-5-sonnet-20241022",
|
||||
"research": "perplexity-llama-3.1-sonar-large-128k-online",
|
||||
"fallback": "claude-3-haiku-20240307"
|
||||
},
|
||||
"workflow": {
|
||||
"enableAutopilot": true,
|
||||
"maxPhaseAttempts": 3,
|
||||
"branchPattern": "task-{taskId}",
|
||||
"requireCleanWorkingTree": true,
|
||||
"autoStageChanges": true,
|
||||
"includeCoAuthor": true,
|
||||
"coAuthorName": "Claude",
|
||||
"coAuthorEmail": "noreply@anthropic.com",
|
||||
"commitMessageTemplate": "{type}: {description}\n\n{body}",
|
||||
"defaultCommitType": "feat",
|
||||
"allowedCommitTypes": ["feat", "fix", "refactor", "test", "docs", "chore"],
|
||||
"testThresholds": {
|
||||
"minTests": 1,
|
||||
"maxFailuresInGreen": 0
|
||||
},
|
||||
"enableActivityLogging": true,
|
||||
"activityLogPath": ".taskmaster/logs",
|
||||
"enableStateBackup": true,
|
||||
"maxStateBackups": 10,
|
||||
"operationTimeout": 300000
|
||||
},
|
||||
"tasks": {
|
||||
"defaultPriority": "medium",
|
||||
"maxSubtasks": 10,
|
||||
"validateDependencies": true
|
||||
},
|
||||
"logging": {
|
||||
"enabled": true,
|
||||
"level": "info",
|
||||
"logRequests": false,
|
||||
"logPerformance": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### If `task-master init` doesn't respond:
|
||||
|
||||
80
output.txt
Normal file
80
output.txt
Normal file
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user