nexus-agents 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +27 -0
- package/dist/chunk-3VJOPTVX.js +13142 -0
- package/dist/chunk-3VJOPTVX.js.map +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +86 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +8526 -0
- package/dist/index.js +551 -0
- package/dist/index.js.map +1 -0
- package/dist/workflows/templates/bug-fix.yaml +109 -0
- package/dist/workflows/templates/code-review.yaml +84 -0
- package/dist/workflows/templates/documentation-update.yaml +91 -0
- package/dist/workflows/templates/feature-implementation.yaml +124 -0
- package/package.json +71 -0
- package/src/workflows/templates/bug-fix.yaml +109 -0
- package/src/workflows/templates/code-review.yaml +84 -0
- package/src/workflows/templates/documentation-update.yaml +91 -0
- package/src/workflows/templates/feature-implementation.yaml +124 -0
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Code Review Workflow Template
|
|
2
|
+
# Automated code review with parallel security analysis
|
|
3
|
+
#
|
|
4
|
+
# Usage:
|
|
5
|
+
# Provide files to review and optional focus area.
|
|
6
|
+
# Workflow analyzes code quality, security, and synthesizes findings.
|
|
7
|
+
|
|
8
|
+
name: code-review
|
|
9
|
+
version: '1.0.0'
|
|
10
|
+
description: |
|
|
11
|
+
Automated code review workflow that performs comprehensive analysis.
|
|
12
|
+
Runs code analysis and security review in parallel, then synthesizes
|
|
13
|
+
findings into actionable recommendations.
|
|
14
|
+
|
|
15
|
+
inputs:
|
|
16
|
+
- name: files
|
|
17
|
+
type: array
|
|
18
|
+
description: List of file paths to review
|
|
19
|
+
required: true
|
|
20
|
+
|
|
21
|
+
- name: focus
|
|
22
|
+
type: string
|
|
23
|
+
description: Review focus area (general, performance, security, maintainability)
|
|
24
|
+
default: general
|
|
25
|
+
|
|
26
|
+
- name: strictness
|
|
27
|
+
type: string
|
|
28
|
+
description: Review strictness level (relaxed, normal, strict)
|
|
29
|
+
default: normal
|
|
30
|
+
|
|
31
|
+
steps:
|
|
32
|
+
# Step 1: Analyze code structure and quality
|
|
33
|
+
- id: analyze
|
|
34
|
+
agent: code_expert
|
|
35
|
+
action: analyze_code
|
|
36
|
+
description: |
|
|
37
|
+
Performs comprehensive code analysis including:
|
|
38
|
+
- Code structure and organization
|
|
39
|
+
- Naming conventions and readability
|
|
40
|
+
- Design patterns and best practices
|
|
41
|
+
- Complexity metrics
|
|
42
|
+
inputs:
|
|
43
|
+
files: ${{ inputs.files }}
|
|
44
|
+
focus: ${{ inputs.focus }}
|
|
45
|
+
strictness: ${{ inputs.strictness }}
|
|
46
|
+
timeout: 120000
|
|
47
|
+
retries: 1
|
|
48
|
+
|
|
49
|
+
# Step 2: Security review (runs in parallel with analyze)
|
|
50
|
+
- id: security
|
|
51
|
+
agent: security_expert
|
|
52
|
+
action: security_review
|
|
53
|
+
description: |
|
|
54
|
+
Performs security-focused code review:
|
|
55
|
+
- OWASP Top 10 vulnerability check
|
|
56
|
+
- Input validation analysis
|
|
57
|
+
- Authentication/authorization review
|
|
58
|
+
- Secrets detection
|
|
59
|
+
inputs:
|
|
60
|
+
files: ${{ inputs.files }}
|
|
61
|
+
depth: comprehensive
|
|
62
|
+
parallel: true
|
|
63
|
+
timeout: 120000
|
|
64
|
+
retries: 1
|
|
65
|
+
|
|
66
|
+
# Step 3: Synthesize reviews into final report
|
|
67
|
+
- id: synthesize
|
|
68
|
+
agent: tech_lead
|
|
69
|
+
action: synthesize_reviews
|
|
70
|
+
description: |
|
|
71
|
+
Combines analysis results into actionable recommendations:
|
|
72
|
+
- Prioritized findings by severity
|
|
73
|
+
- Specific code change suggestions
|
|
74
|
+
- Overall code health assessment
|
|
75
|
+
inputs:
|
|
76
|
+
analysis: ${{ steps.analyze.output }}
|
|
77
|
+
security: ${{ steps.security.output }}
|
|
78
|
+
focus: ${{ inputs.focus }}
|
|
79
|
+
dependsOn:
|
|
80
|
+
- analyze
|
|
81
|
+
- security
|
|
82
|
+
timeout: 60000
|
|
83
|
+
|
|
84
|
+
timeout: 300000
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Documentation Update Workflow Template
|
|
2
|
+
# Analyze, update, and review documentation
|
|
3
|
+
#
|
|
4
|
+
# Usage:
|
|
5
|
+
# Provide documentation scope and target.
|
|
6
|
+
# Workflow analyzes current state, updates docs, and reviews quality.
|
|
7
|
+
|
|
8
|
+
name: documentation-update
|
|
9
|
+
version: '1.0.0'
|
|
10
|
+
description: |
|
|
11
|
+
Documentation update workflow for maintaining accurate docs.
|
|
12
|
+
Analyzes current documentation, identifies gaps, generates updates,
|
|
13
|
+
and performs quality review.
|
|
14
|
+
|
|
15
|
+
inputs:
|
|
16
|
+
- name: scope
|
|
17
|
+
type: string
|
|
18
|
+
description: Documentation scope (api, readme, guide, all)
|
|
19
|
+
required: true
|
|
20
|
+
|
|
21
|
+
- name: targetFiles
|
|
22
|
+
type: array
|
|
23
|
+
description: Specific files to document (optional, auto-detected if omitted)
|
|
24
|
+
required: false
|
|
25
|
+
|
|
26
|
+
- name: sourceFiles
|
|
27
|
+
type: array
|
|
28
|
+
description: Source code files to extract documentation from
|
|
29
|
+
required: false
|
|
30
|
+
|
|
31
|
+
- name: format
|
|
32
|
+
type: string
|
|
33
|
+
description: Output format (markdown, jsdoc, typedoc)
|
|
34
|
+
default: markdown
|
|
35
|
+
|
|
36
|
+
steps:
|
|
37
|
+
# Step 1: Analyze current documentation
|
|
38
|
+
- id: analyze
|
|
39
|
+
agent: documentation_expert
|
|
40
|
+
action: analyze_documentation
|
|
41
|
+
description: |
|
|
42
|
+
Analyzes existing documentation:
|
|
43
|
+
- Identifies outdated sections
|
|
44
|
+
- Finds missing documentation
|
|
45
|
+
- Checks code-documentation sync
|
|
46
|
+
- Assesses documentation quality
|
|
47
|
+
inputs:
|
|
48
|
+
scope: ${{ inputs.scope }}
|
|
49
|
+
targetFiles: ${{ inputs.targetFiles }}
|
|
50
|
+
sourceFiles: ${{ inputs.sourceFiles }}
|
|
51
|
+
timeout: 120000
|
|
52
|
+
|
|
53
|
+
# Step 2: Update documentation
|
|
54
|
+
- id: update
|
|
55
|
+
agent: documentation_expert
|
|
56
|
+
action: update_documentation
|
|
57
|
+
description: |
|
|
58
|
+
Updates and generates documentation:
|
|
59
|
+
- Fixes outdated content
|
|
60
|
+
- Adds missing sections
|
|
61
|
+
- Improves clarity and examples
|
|
62
|
+
- Ensures consistent formatting
|
|
63
|
+
inputs:
|
|
64
|
+
analysis: ${{ steps.analyze.output }}
|
|
65
|
+
scope: ${{ inputs.scope }}
|
|
66
|
+
format: ${{ inputs.format }}
|
|
67
|
+
sourceFiles: ${{ inputs.sourceFiles }}
|
|
68
|
+
dependsOn:
|
|
69
|
+
- analyze
|
|
70
|
+
timeout: 180000
|
|
71
|
+
retries: 1
|
|
72
|
+
|
|
73
|
+
# Step 3: Technical review
|
|
74
|
+
- id: review
|
|
75
|
+
agent: code_expert
|
|
76
|
+
action: review_documentation
|
|
77
|
+
description: |
|
|
78
|
+
Technical accuracy review:
|
|
79
|
+
- Verifies code examples work
|
|
80
|
+
- Checks API signatures match
|
|
81
|
+
- Validates installation steps
|
|
82
|
+
- Ensures technical correctness
|
|
83
|
+
inputs:
|
|
84
|
+
documentation: ${{ steps.update.output }}
|
|
85
|
+
sourceFiles: ${{ inputs.sourceFiles }}
|
|
86
|
+
scope: ${{ inputs.scope }}
|
|
87
|
+
dependsOn:
|
|
88
|
+
- update
|
|
89
|
+
timeout: 90000
|
|
90
|
+
|
|
91
|
+
timeout: 390000
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# Feature Implementation Workflow Template
|
|
2
|
+
# End-to-end feature development from planning to review
|
|
3
|
+
#
|
|
4
|
+
# Usage:
|
|
5
|
+
# Provide feature description and optional constraints.
|
|
6
|
+
# Workflow handles planning, implementation, testing, docs, and review.
|
|
7
|
+
|
|
8
|
+
name: feature-implementation
|
|
9
|
+
version: '1.0.0'
|
|
10
|
+
description: |
|
|
11
|
+
Complete feature implementation workflow from design to review.
|
|
12
|
+
Follows a structured approach: plan, implement, test, document, review.
|
|
13
|
+
Ensures quality through automated testing and code review.
|
|
14
|
+
|
|
15
|
+
inputs:
|
|
16
|
+
- name: feature
|
|
17
|
+
type: string
|
|
18
|
+
description: Feature description and requirements
|
|
19
|
+
required: true
|
|
20
|
+
|
|
21
|
+
- name: targetFiles
|
|
22
|
+
type: array
|
|
23
|
+
description: Target files to modify or create
|
|
24
|
+
required: false
|
|
25
|
+
|
|
26
|
+
- name: testingStrategy
|
|
27
|
+
type: string
|
|
28
|
+
description: Testing approach (unit, integration, e2e, all)
|
|
29
|
+
default: unit
|
|
30
|
+
|
|
31
|
+
- name: generateDocs
|
|
32
|
+
type: boolean
|
|
33
|
+
description: Whether to generate documentation
|
|
34
|
+
default: true
|
|
35
|
+
|
|
36
|
+
steps:
|
|
37
|
+
# Step 1: Architecture planning
|
|
38
|
+
- id: plan
|
|
39
|
+
agent: architecture_expert
|
|
40
|
+
action: design_feature
|
|
41
|
+
description: |
|
|
42
|
+
Creates implementation plan including:
|
|
43
|
+
- Component architecture design
|
|
44
|
+
- Interface definitions
|
|
45
|
+
- Integration points
|
|
46
|
+
- Implementation order
|
|
47
|
+
inputs:
|
|
48
|
+
feature: ${{ inputs.feature }}
|
|
49
|
+
targetFiles: ${{ inputs.targetFiles }}
|
|
50
|
+
timeout: 120000
|
|
51
|
+
|
|
52
|
+
# Step 2: Code implementation
|
|
53
|
+
- id: implement
|
|
54
|
+
agent: code_expert
|
|
55
|
+
action: implement_feature
|
|
56
|
+
description: |
|
|
57
|
+
Implements the feature following the plan:
|
|
58
|
+
- Creates/modifies source files
|
|
59
|
+
- Follows coding standards
|
|
60
|
+
- Adds inline documentation
|
|
61
|
+
inputs:
|
|
62
|
+
plan: ${{ steps.plan.output }}
|
|
63
|
+
feature: ${{ inputs.feature }}
|
|
64
|
+
targetFiles: ${{ inputs.targetFiles }}
|
|
65
|
+
dependsOn:
|
|
66
|
+
- plan
|
|
67
|
+
timeout: 180000
|
|
68
|
+
retries: 2
|
|
69
|
+
|
|
70
|
+
# Step 3: Test generation
|
|
71
|
+
- id: test
|
|
72
|
+
agent: testing_expert
|
|
73
|
+
action: generate_tests
|
|
74
|
+
description: |
|
|
75
|
+
Generates comprehensive tests:
|
|
76
|
+
- Unit tests for new functions
|
|
77
|
+
- Integration tests for interfaces
|
|
78
|
+
- Edge case coverage
|
|
79
|
+
inputs:
|
|
80
|
+
implementation: ${{ steps.implement.output }}
|
|
81
|
+
strategy: ${{ inputs.testingStrategy }}
|
|
82
|
+
feature: ${{ inputs.feature }}
|
|
83
|
+
dependsOn:
|
|
84
|
+
- implement
|
|
85
|
+
timeout: 120000
|
|
86
|
+
|
|
87
|
+
# Step 4: Documentation (conditional)
|
|
88
|
+
- id: document
|
|
89
|
+
agent: documentation_expert
|
|
90
|
+
action: generate_documentation
|
|
91
|
+
description: |
|
|
92
|
+
Creates/updates documentation:
|
|
93
|
+
- API documentation
|
|
94
|
+
- Usage examples
|
|
95
|
+
- README updates
|
|
96
|
+
inputs:
|
|
97
|
+
implementation: ${{ steps.implement.output }}
|
|
98
|
+
tests: ${{ steps.test.output }}
|
|
99
|
+
feature: ${{ inputs.feature }}
|
|
100
|
+
dependsOn:
|
|
101
|
+
- test
|
|
102
|
+
condition: ${{ inputs.generateDocs == true }}
|
|
103
|
+
timeout: 90000
|
|
104
|
+
|
|
105
|
+
# Step 5: Final code review
|
|
106
|
+
- id: review
|
|
107
|
+
agent: code_expert
|
|
108
|
+
action: review_implementation
|
|
109
|
+
description: |
|
|
110
|
+
Final quality review:
|
|
111
|
+
- Verify plan adherence
|
|
112
|
+
- Check code quality
|
|
113
|
+
- Validate test coverage
|
|
114
|
+
- Confirm documentation accuracy
|
|
115
|
+
inputs:
|
|
116
|
+
plan: ${{ steps.plan.output }}
|
|
117
|
+
implementation: ${{ steps.implement.output }}
|
|
118
|
+
tests: ${{ steps.test.output }}
|
|
119
|
+
documentation: ${{ steps.document.output }}
|
|
120
|
+
dependsOn:
|
|
121
|
+
- document
|
|
122
|
+
timeout: 90000
|
|
123
|
+
|
|
124
|
+
timeout: 600000
|
package/package.json
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "nexus-agents",
|
|
3
|
+
"version": "2.0.0",
|
|
4
|
+
"description": "Multi-agent orchestration MCP server with model diversity and workflow automation",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "./dist/index.js",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"bin": {
|
|
10
|
+
"nexus-agents": "./dist/cli.js"
|
|
11
|
+
},
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"types": "./dist/index.d.ts",
|
|
15
|
+
"import": "./dist/index.js"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"src/workflows/templates",
|
|
21
|
+
"README.md"
|
|
22
|
+
],
|
|
23
|
+
"repository": {
|
|
24
|
+
"type": "git",
|
|
25
|
+
"url": "git+https://github.com/williamzujkowski/nexus-agents.git"
|
|
26
|
+
},
|
|
27
|
+
"publishConfig": {
|
|
28
|
+
"access": "public"
|
|
29
|
+
},
|
|
30
|
+
"keywords": [
|
|
31
|
+
"mcp",
|
|
32
|
+
"model-context-protocol",
|
|
33
|
+
"ai",
|
|
34
|
+
"agents",
|
|
35
|
+
"multi-agent",
|
|
36
|
+
"orchestration",
|
|
37
|
+
"claude",
|
|
38
|
+
"openai",
|
|
39
|
+
"gemini",
|
|
40
|
+
"ollama",
|
|
41
|
+
"llm",
|
|
42
|
+
"workflow"
|
|
43
|
+
],
|
|
44
|
+
"author": "William Zujkowski",
|
|
45
|
+
"engines": {
|
|
46
|
+
"node": ">=22.0.0"
|
|
47
|
+
},
|
|
48
|
+
"dependencies": {
|
|
49
|
+
"@anthropic-ai/sdk": "^0.71.2",
|
|
50
|
+
"@google/genai": "^1.34.0",
|
|
51
|
+
"@modelcontextprotocol/sdk": "^1.0.0",
|
|
52
|
+
"ollama": "^0.6.3",
|
|
53
|
+
"openai": "^6.15.0",
|
|
54
|
+
"uuid": "^13.0.0",
|
|
55
|
+
"yaml": "^2.8.2",
|
|
56
|
+
"zod": "^3.24.0"
|
|
57
|
+
},
|
|
58
|
+
"devDependencies": {
|
|
59
|
+
"@types/uuid": "^11.0.0",
|
|
60
|
+
"tsup": "^8.3.0"
|
|
61
|
+
},
|
|
62
|
+
"scripts": {
|
|
63
|
+
"build": "tsup",
|
|
64
|
+
"dev": "tsup --watch",
|
|
65
|
+
"test": "vitest run",
|
|
66
|
+
"test:coverage": "vitest run --coverage",
|
|
67
|
+
"lint": "eslint src/",
|
|
68
|
+
"lint:fix": "eslint src/ --fix",
|
|
69
|
+
"typecheck": "tsc --noEmit"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Bug Fix Workflow Template
|
|
2
|
+
# Structured bug diagnosis, fix, and verification
|
|
3
|
+
#
|
|
4
|
+
# Usage:
|
|
5
|
+
# Provide bug description and affected files.
|
|
6
|
+
# Workflow diagnoses the issue, implements fix, and verifies.
|
|
7
|
+
|
|
8
|
+
name: bug-fix
|
|
9
|
+
version: '1.0.0'
|
|
10
|
+
description: |
|
|
11
|
+
Bug fix workflow for diagnosing, fixing, and verifying bugs.
|
|
12
|
+
Follows systematic approach: diagnose root cause, implement fix,
|
|
13
|
+
add regression tests, and verify the solution.
|
|
14
|
+
|
|
15
|
+
inputs:
|
|
16
|
+
- name: bugDescription
|
|
17
|
+
type: string
|
|
18
|
+
description: Description of the bug and reproduction steps
|
|
19
|
+
required: true
|
|
20
|
+
|
|
21
|
+
- name: affectedFiles
|
|
22
|
+
type: array
|
|
23
|
+
description: Files known to be affected by the bug
|
|
24
|
+
required: false
|
|
25
|
+
|
|
26
|
+
- name: severity
|
|
27
|
+
type: string
|
|
28
|
+
description: Bug severity (critical, high, medium, low)
|
|
29
|
+
default: medium
|
|
30
|
+
|
|
31
|
+
- name: addRegressionTest
|
|
32
|
+
type: boolean
|
|
33
|
+
description: Whether to add regression test
|
|
34
|
+
default: true
|
|
35
|
+
|
|
36
|
+
steps:
|
|
37
|
+
# Step 1: Diagnose the bug
|
|
38
|
+
- id: diagnose
|
|
39
|
+
agent: code_expert
|
|
40
|
+
action: diagnose_bug
|
|
41
|
+
description: |
|
|
42
|
+
Analyzes the bug to identify root cause:
|
|
43
|
+
- Traces code execution path
|
|
44
|
+
- Identifies faulty logic
|
|
45
|
+
- Determines scope of impact
|
|
46
|
+
- Documents reproduction steps
|
|
47
|
+
inputs:
|
|
48
|
+
description: ${{ inputs.bugDescription }}
|
|
49
|
+
affectedFiles: ${{ inputs.affectedFiles }}
|
|
50
|
+
severity: ${{ inputs.severity }}
|
|
51
|
+
timeout: 120000
|
|
52
|
+
retries: 1
|
|
53
|
+
|
|
54
|
+
# Step 2: Implement the fix
|
|
55
|
+
- id: fix
|
|
56
|
+
agent: code_expert
|
|
57
|
+
action: implement_fix
|
|
58
|
+
description: |
|
|
59
|
+
Implements the bug fix:
|
|
60
|
+
- Modifies affected code
|
|
61
|
+
- Ensures minimal change footprint
|
|
62
|
+
- Preserves existing functionality
|
|
63
|
+
- Adds defensive coding where needed
|
|
64
|
+
inputs:
|
|
65
|
+
diagnosis: ${{ steps.diagnose.output }}
|
|
66
|
+
affectedFiles: ${{ inputs.affectedFiles }}
|
|
67
|
+
severity: ${{ inputs.severity }}
|
|
68
|
+
dependsOn:
|
|
69
|
+
- diagnose
|
|
70
|
+
timeout: 120000
|
|
71
|
+
retries: 2
|
|
72
|
+
|
|
73
|
+
# Step 3: Generate regression test
|
|
74
|
+
- id: test
|
|
75
|
+
agent: testing_expert
|
|
76
|
+
action: generate_regression_test
|
|
77
|
+
description: |
|
|
78
|
+
Creates regression tests:
|
|
79
|
+
- Tests that would have caught the bug
|
|
80
|
+
- Verifies the fix works correctly
|
|
81
|
+
- Edge cases around the bug
|
|
82
|
+
inputs:
|
|
83
|
+
diagnosis: ${{ steps.diagnose.output }}
|
|
84
|
+
fix: ${{ steps.fix.output }}
|
|
85
|
+
bugDescription: ${{ inputs.bugDescription }}
|
|
86
|
+
dependsOn:
|
|
87
|
+
- fix
|
|
88
|
+
condition: ${{ inputs.addRegressionTest == true }}
|
|
89
|
+
timeout: 90000
|
|
90
|
+
|
|
91
|
+
# Step 4: Verify the fix
|
|
92
|
+
- id: verify
|
|
93
|
+
agent: testing_expert
|
|
94
|
+
action: verify_fix
|
|
95
|
+
description: |
|
|
96
|
+
Verifies the fix is complete:
|
|
97
|
+
- Runs existing tests
|
|
98
|
+
- Runs new regression tests
|
|
99
|
+
- Checks for side effects
|
|
100
|
+
- Confirms bug is resolved
|
|
101
|
+
inputs:
|
|
102
|
+
diagnosis: ${{ steps.diagnose.output }}
|
|
103
|
+
fix: ${{ steps.fix.output }}
|
|
104
|
+
tests: ${{ steps.test.output }}
|
|
105
|
+
dependsOn:
|
|
106
|
+
- test
|
|
107
|
+
timeout: 90000
|
|
108
|
+
|
|
109
|
+
timeout: 420000
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Code Review Workflow Template
|
|
2
|
+
# Automated code review with parallel security analysis
|
|
3
|
+
#
|
|
4
|
+
# Usage:
|
|
5
|
+
# Provide files to review and optional focus area.
|
|
6
|
+
# Workflow analyzes code quality, security, and synthesizes findings.
|
|
7
|
+
|
|
8
|
+
name: code-review
|
|
9
|
+
version: '1.0.0'
|
|
10
|
+
description: |
|
|
11
|
+
Automated code review workflow that performs comprehensive analysis.
|
|
12
|
+
Runs code analysis and security review in parallel, then synthesizes
|
|
13
|
+
findings into actionable recommendations.
|
|
14
|
+
|
|
15
|
+
inputs:
|
|
16
|
+
- name: files
|
|
17
|
+
type: array
|
|
18
|
+
description: List of file paths to review
|
|
19
|
+
required: true
|
|
20
|
+
|
|
21
|
+
- name: focus
|
|
22
|
+
type: string
|
|
23
|
+
description: Review focus area (general, performance, security, maintainability)
|
|
24
|
+
default: general
|
|
25
|
+
|
|
26
|
+
- name: strictness
|
|
27
|
+
type: string
|
|
28
|
+
description: Review strictness level (relaxed, normal, strict)
|
|
29
|
+
default: normal
|
|
30
|
+
|
|
31
|
+
steps:
|
|
32
|
+
# Step 1: Analyze code structure and quality
|
|
33
|
+
- id: analyze
|
|
34
|
+
agent: code_expert
|
|
35
|
+
action: analyze_code
|
|
36
|
+
description: |
|
|
37
|
+
Performs comprehensive code analysis including:
|
|
38
|
+
- Code structure and organization
|
|
39
|
+
- Naming conventions and readability
|
|
40
|
+
- Design patterns and best practices
|
|
41
|
+
- Complexity metrics
|
|
42
|
+
inputs:
|
|
43
|
+
files: ${{ inputs.files }}
|
|
44
|
+
focus: ${{ inputs.focus }}
|
|
45
|
+
strictness: ${{ inputs.strictness }}
|
|
46
|
+
timeout: 120000
|
|
47
|
+
retries: 1
|
|
48
|
+
|
|
49
|
+
# Step 2: Security review (runs in parallel with analyze)
|
|
50
|
+
- id: security
|
|
51
|
+
agent: security_expert
|
|
52
|
+
action: security_review
|
|
53
|
+
description: |
|
|
54
|
+
Performs security-focused code review:
|
|
55
|
+
- OWASP Top 10 vulnerability check
|
|
56
|
+
- Input validation analysis
|
|
57
|
+
- Authentication/authorization review
|
|
58
|
+
- Secrets detection
|
|
59
|
+
inputs:
|
|
60
|
+
files: ${{ inputs.files }}
|
|
61
|
+
depth: comprehensive
|
|
62
|
+
parallel: true
|
|
63
|
+
timeout: 120000
|
|
64
|
+
retries: 1
|
|
65
|
+
|
|
66
|
+
# Step 3: Synthesize reviews into final report
|
|
67
|
+
- id: synthesize
|
|
68
|
+
agent: tech_lead
|
|
69
|
+
action: synthesize_reviews
|
|
70
|
+
description: |
|
|
71
|
+
Combines analysis results into actionable recommendations:
|
|
72
|
+
- Prioritized findings by severity
|
|
73
|
+
- Specific code change suggestions
|
|
74
|
+
- Overall code health assessment
|
|
75
|
+
inputs:
|
|
76
|
+
analysis: ${{ steps.analyze.output }}
|
|
77
|
+
security: ${{ steps.security.output }}
|
|
78
|
+
focus: ${{ inputs.focus }}
|
|
79
|
+
dependsOn:
|
|
80
|
+
- analyze
|
|
81
|
+
- security
|
|
82
|
+
timeout: 60000
|
|
83
|
+
|
|
84
|
+
timeout: 300000
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Documentation Update Workflow Template
|
|
2
|
+
# Analyze, update, and review documentation
|
|
3
|
+
#
|
|
4
|
+
# Usage:
|
|
5
|
+
# Provide documentation scope and target.
|
|
6
|
+
# Workflow analyzes current state, updates docs, and reviews quality.
|
|
7
|
+
|
|
8
|
+
name: documentation-update
|
|
9
|
+
version: '1.0.0'
|
|
10
|
+
description: |
|
|
11
|
+
Documentation update workflow for maintaining accurate docs.
|
|
12
|
+
Analyzes current documentation, identifies gaps, generates updates,
|
|
13
|
+
and performs quality review.
|
|
14
|
+
|
|
15
|
+
inputs:
|
|
16
|
+
- name: scope
|
|
17
|
+
type: string
|
|
18
|
+
description: Documentation scope (api, readme, guide, all)
|
|
19
|
+
required: true
|
|
20
|
+
|
|
21
|
+
- name: targetFiles
|
|
22
|
+
type: array
|
|
23
|
+
description: Specific files to document (optional, auto-detected if omitted)
|
|
24
|
+
required: false
|
|
25
|
+
|
|
26
|
+
- name: sourceFiles
|
|
27
|
+
type: array
|
|
28
|
+
description: Source code files to extract documentation from
|
|
29
|
+
required: false
|
|
30
|
+
|
|
31
|
+
- name: format
|
|
32
|
+
type: string
|
|
33
|
+
description: Output format (markdown, jsdoc, typedoc)
|
|
34
|
+
default: markdown
|
|
35
|
+
|
|
36
|
+
steps:
|
|
37
|
+
# Step 1: Analyze current documentation
|
|
38
|
+
- id: analyze
|
|
39
|
+
agent: documentation_expert
|
|
40
|
+
action: analyze_documentation
|
|
41
|
+
description: |
|
|
42
|
+
Analyzes existing documentation:
|
|
43
|
+
- Identifies outdated sections
|
|
44
|
+
- Finds missing documentation
|
|
45
|
+
- Checks code-documentation sync
|
|
46
|
+
- Assesses documentation quality
|
|
47
|
+
inputs:
|
|
48
|
+
scope: ${{ inputs.scope }}
|
|
49
|
+
targetFiles: ${{ inputs.targetFiles }}
|
|
50
|
+
sourceFiles: ${{ inputs.sourceFiles }}
|
|
51
|
+
timeout: 120000
|
|
52
|
+
|
|
53
|
+
# Step 2: Update documentation
|
|
54
|
+
- id: update
|
|
55
|
+
agent: documentation_expert
|
|
56
|
+
action: update_documentation
|
|
57
|
+
description: |
|
|
58
|
+
Updates and generates documentation:
|
|
59
|
+
- Fixes outdated content
|
|
60
|
+
- Adds missing sections
|
|
61
|
+
- Improves clarity and examples
|
|
62
|
+
- Ensures consistent formatting
|
|
63
|
+
inputs:
|
|
64
|
+
analysis: ${{ steps.analyze.output }}
|
|
65
|
+
scope: ${{ inputs.scope }}
|
|
66
|
+
format: ${{ inputs.format }}
|
|
67
|
+
sourceFiles: ${{ inputs.sourceFiles }}
|
|
68
|
+
dependsOn:
|
|
69
|
+
- analyze
|
|
70
|
+
timeout: 180000
|
|
71
|
+
retries: 1
|
|
72
|
+
|
|
73
|
+
# Step 3: Technical review
|
|
74
|
+
- id: review
|
|
75
|
+
agent: code_expert
|
|
76
|
+
action: review_documentation
|
|
77
|
+
description: |
|
|
78
|
+
Technical accuracy review:
|
|
79
|
+
- Verifies code examples work
|
|
80
|
+
- Checks API signatures match
|
|
81
|
+
- Validates installation steps
|
|
82
|
+
- Ensures technical correctness
|
|
83
|
+
inputs:
|
|
84
|
+
documentation: ${{ steps.update.output }}
|
|
85
|
+
sourceFiles: ${{ inputs.sourceFiles }}
|
|
86
|
+
scope: ${{ inputs.scope }}
|
|
87
|
+
dependsOn:
|
|
88
|
+
- update
|
|
89
|
+
timeout: 90000
|
|
90
|
+
|
|
91
|
+
timeout: 390000
|