generated from ztimson/template
Compare commits
5 Commits
3daf5442d8
...
0.0.5
| Author | SHA1 | Date | |
|---|---|---|---|
| 3c2d6f7824 | |||
| 2d9662e86d | |||
| 91d22b8b16 | |||
| c7f8ffb32a | |||
| 27fad6a3d3 |
44
.github/issue_template/ai-refinement.md
vendored
44
.github/issue_template/ai-refinement.md
vendored
@@ -8,46 +8,12 @@ labels:
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# [Module] - [Add/Change/Fix/Refactor/Remove] [Feature/Component]
|
Describe your request:
|
||||||
|
|
||||||
## Type: [Bug/DevOps/Enhancement/Refactor/Security]
|
What are you trying to do and what's happening?
|
||||||
|
|
||||||
| | Score |
|
How can it be fixed or improved?
|
||||||
|------------|----------|
|
|
||||||
| Size | 0-5 |
|
|
||||||
| Complexity | 0-5 |
|
|
||||||
| Unknowns | 0-5 |
|
|
||||||
| **Total** | **0-15** |
|
|
||||||
|
|
||||||
## Description
|
Steps to reproduce?
|
||||||
|
|
||||||
A clear explanation of the issue, feature, or change needed
|
Anything other useful information, logs or screenshots?
|
||||||
|
|
||||||
## Current Behavior
|
|
||||||
|
|
||||||
For bugs: what's happening now
|
|
||||||
For refactors: what exists today
|
|
||||||
For enhancements: current state/gap
|
|
||||||
|
|
||||||
## Expected Behavior
|
|
||||||
|
|
||||||
What should happen instead
|
|
||||||
|
|
||||||
## Steps to Reproduce
|
|
||||||
|
|
||||||
1. First step
|
|
||||||
2. Second step
|
|
||||||
3. Third step
|
|
||||||
|
|
||||||
## Additional Context
|
|
||||||
|
|
||||||
Logs, screenshots, links, related issues
|
|
||||||
|
|
||||||
## Acceptance Criteria
|
|
||||||
|
|
||||||
- [ ] Todo requirement
|
|
||||||
- [X] Completed requirement
|
|
||||||
|
|
||||||
## Technical Notes
|
|
||||||
|
|
||||||
Implementation details, constraints, dependencies, design decisions
|
|
||||||
|
|||||||
2
.github/workflows/code-review.yml
vendored
2
.github/workflows/code-review.yml
vendored
@@ -16,7 +16,7 @@ jobs:
|
|||||||
git fetch origin ${{ github.event.pull_request.base.ref }}
|
git fetch origin ${{ github.event.pull_request.base.ref }}
|
||||||
|
|
||||||
- name: Run AI Review
|
- name: Run AI Review
|
||||||
run: npx -y @ztimson/ai-agents@latest review
|
run: npx -y -p @ztimson/ai-agents@latest review
|
||||||
env:
|
env:
|
||||||
AI_HOST: anthropic
|
AI_HOST: anthropic
|
||||||
AI_MODEL: claude-sonnet-4-5
|
AI_MODEL: claude-sonnet-4-5
|
||||||
|
|||||||
4
.github/workflows/ticket-refinement.yml
vendored
4
.github/workflows/ticket-refinement.yml
vendored
@@ -2,7 +2,7 @@ name: Ticket refinement
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
issues:
|
issues:
|
||||||
types: [opened, labeled]
|
types: [labeled]
|
||||||
jobs:
|
jobs:
|
||||||
format:
|
format:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -14,7 +14,7 @@ jobs:
|
|||||||
git checkout ${{ github.event.repository.default_branch }}
|
git checkout ${{ github.event.repository.default_branch }}
|
||||||
|
|
||||||
- name: Run AI Formatter
|
- name: Run AI Formatter
|
||||||
run: npx -y @ztimson/ai-agents@latest refine .github/issue_template/ai-refinement.md
|
run: npx -y -p @ztimson/ai-agents@latest refine
|
||||||
env:
|
env:
|
||||||
AI_HOST: anthropic
|
AI_HOST: anthropic
|
||||||
AI_MODEL: claude-sonnet-4-5
|
AI_MODEL: claude-sonnet-4-5
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@ztimson/ai-agents",
|
"name": "@ztimson/ai-agents",
|
||||||
"version": "0.0.4",
|
"version": "0.0.5",
|
||||||
"description": "AI agents",
|
"description": "AI agents",
|
||||||
"keywords": ["ai", "review"],
|
"keywords": ["ai", "review"],
|
||||||
"author": "ztimson",
|
"author": "ztimson",
|
||||||
|
|||||||
128
src/refine.mjs
128
src/refine.mjs
@@ -14,8 +14,6 @@ dotenv.config({path: '.env.local', override: true, quiet: true});
|
|||||||
if(p === 'refine' || p.endsWith('refine.mjs')) p = null;
|
if(p === 'refine' || p.endsWith('refine.mjs')) p = null;
|
||||||
if(!/^(\/|[A-Z]:)/m.test(p)) p = path.join(process.cwd(), p);
|
if(!/^(\/|[A-Z]:)/m.test(p)) p = path.join(process.cwd(), p);
|
||||||
|
|
||||||
if(!p || !fs.existsSync(p)) throw new Error('Please provide a template');
|
|
||||||
|
|
||||||
const git = process.env['GIT_HOST'],
|
const git = process.env['GIT_HOST'],
|
||||||
owner = process.env['GIT_OWNER'],
|
owner = process.env['GIT_OWNER'],
|
||||||
repo = process.env['GIT_REPO'],
|
repo = process.env['GIT_REPO'],
|
||||||
@@ -38,9 +36,49 @@ dotenv.config({path: '.env.local', override: true, quiet: true});
|
|||||||
return process.exit();
|
return process.exit();
|
||||||
}
|
}
|
||||||
|
|
||||||
let readme = '', readmeP = path.join(process.cwd(), 'README.md');
|
let title = '', type = '', readme = '', readmeP = path.join(process.cwd(), 'README.md');
|
||||||
if(fs.existsSync(readmeP)) readme = fs.readFileSync(readmeP, 'utf-8');
|
if(fs.existsSync(readmeP)) readme = fs.readFileSync(readmeP, 'utf-8');
|
||||||
const template = fs.readFileSync(p, 'utf-8');
|
const template = p ? fs.readFileSync(p, 'utf-8') : `## Description
|
||||||
|
|
||||||
|
A clear explanation of the request
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Current Behavior
|
||||||
|
|
||||||
|
what's happening now or the current state/gap
|
||||||
|
|
||||||
|
## Expected Behavior
|
||||||
|
|
||||||
|
What should happen instead
|
||||||
|
|
||||||
|
## Steps to Reproduce / Desired Flow
|
||||||
|
|
||||||
|
1. First step
|
||||||
|
2. Second step
|
||||||
|
3. Third step
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
|
||||||
|
Logs, screenshots, links, related issues
|
||||||
|
|
||||||
|
## Acceptance Criteria
|
||||||
|
|
||||||
|
- [ ] Todo requirement
|
||||||
|
- [X] Completed requirement
|
||||||
|
|
||||||
|
## Technical Notes
|
||||||
|
|
||||||
|
Implementation details, constraints, dependencies, design decisions
|
||||||
|
|
||||||
|
|
||||||
|
| Effort / Weight | Score |
|
||||||
|
|-----------------|----------|
|
||||||
|
| Size | 0-5 |
|
||||||
|
| Complexity | 0-5 |
|
||||||
|
| Unknowns | 0-5 |
|
||||||
|
| **Total** | **0-15** |
|
||||||
|
`;
|
||||||
|
|
||||||
let options = {ollama: {model, host}};
|
let options = {ollama: {model, host}};
|
||||||
if(host === 'anthropic') options = {anthropic: {model, token}};
|
if(host === 'anthropic') options = {anthropic: {model, token}};
|
||||||
@@ -49,26 +87,47 @@ dotenv.config({path: '.env.local', override: true, quiet: true});
|
|||||||
...options,
|
...options,
|
||||||
model: [host, model],
|
model: [host, model],
|
||||||
path: process.env['path'] || os.tmpdir(),
|
path: process.env['path'] || os.tmpdir(),
|
||||||
system: `You are a ticket formatter. Transform raw issue descriptions into structured tickets.
|
tools: [{
|
||||||
|
name: 'title',
|
||||||
|
description: 'Set the ticket title, must be called EXACTLY ONCE',
|
||||||
|
args: {value: {type: 'string', description: 'Ticket title, must match format: [Module] - [Verb] [noun]', required: true}},
|
||||||
|
fn: (args) => title = args.title
|
||||||
|
}, {
|
||||||
|
name: 'type',
|
||||||
|
description: 'Set the ticket type, must be called EXACTLY ONCE',
|
||||||
|
args: {type: {type: 'string', description: 'Ticket type', enum: ['Bug', 'DevOps', 'Document', 'Enhancement', 'Refactor', 'Security'], required: true}},
|
||||||
|
fn: (args) => type = args.type
|
||||||
|
}],
|
||||||
|
system: `Transform raw tickets into structured markdown following the template EXACTLY.
|
||||||
|
|
||||||
**CRITICAL RULES:**
|
**MANDATORY STEPS:**
|
||||||
1. Identify the ticket type (Bug, DevOps, Enhancement, Refactor, Security)
|
1. Identify ticket type: Bug, DevOps, Document, Enhancement, Refactor, or Security
|
||||||
2. Output MUST only contain the new ticket information in markdown, no extra fluff
|
2. Call \`type\` tool EXACTLY ONCE with the type from step 1
|
||||||
3. Follow the template structure EXACTLY:
|
3. Call \`title\` tool EXACTLY ONCE in format: "[Module] - [Verb] [subject]"
|
||||||
- Title format: [Module] - [Verb] [noun]
|
4. Output formatted markdown matching template structure below
|
||||||
Example: Storage - Fix file uploads
|
|
||||||
- Fill in the identified ticket type
|
**TEMPLATE RULES:**
|
||||||
- Write a clear description
|
- Use ## headers (match template exactly)
|
||||||
- For bugs: fill Steps to Reproduce with numbered list
|
- Description: Clear summary of the request
|
||||||
- For enhancements/refactors: REMOVE the Steps to Reproduce section entirely
|
- Current Behavior: What's happening now (remove for Document tickets)
|
||||||
- Acceptance Criteria: convert requirements into checkboxes (- [ ])
|
- Expected Behavior: What should happen (remove for Document tickets)
|
||||||
- Weight scoring (0-5 each):
|
- Steps to Reproduce: Numbered list for bugs, flow for enhancements, remove if not applicable
|
||||||
* Size: Number of modules, layers & files affected by change
|
- Additional Context: Logs, screenshots, links provided by user
|
||||||
* Complexity: Technical difficulty to implement
|
- Acceptance Criteria: Convert to checkboxes (- [ ] format)
|
||||||
* Unknowns: Research/uncertainty in work estimation
|
- Technical Notes: Implementation approach, constraints, dependencies
|
||||||
* Calculate Total as sum of the three
|
- Weight table (use exact format below):
|
||||||
- Remove sections that are not applicable based on ticket type
|
|
||||||
- Use proper markdown headers (##)
|
| Effort / Weight | Score |
|
||||||
|
|-----------------|----------|
|
||||||
|
| Size | 0-5 |
|
||||||
|
| Complexity | 0-5 |
|
||||||
|
| Unknowns | 0-5 |
|
||||||
|
| **Total** | **0-15** |
|
||||||
|
|
||||||
|
**SCORING:**
|
||||||
|
- Size: # of modules/layers/files changed
|
||||||
|
- Complexity: Technical difficulty
|
||||||
|
- Unknowns: Research/uncertainty needed
|
||||||
|
|
||||||
**README:**
|
**README:**
|
||||||
\`\`\`markdown
|
\`\`\`markdown
|
||||||
@@ -80,19 +139,14 @@ ${readme.trim() || 'No README available'}
|
|||||||
${template.trim()}
|
${template.trim()}
|
||||||
\`\`\`
|
\`\`\`
|
||||||
|
|
||||||
Output ONLY the formatted ticket, no explanation.`
|
Output ONLY markdown. No explanations, labels, or extra formatting.`});
|
||||||
})
|
|
||||||
|
|
||||||
const messages = await ai.language.ask(`Title: ${issueData.title}\n\nDescription:\n${issueData.body || 'No description provided'}`).catch(() => []);
|
const messages = await ai.language.ask(`Title: ${issueData.title}\n\nDescription:\n${issueData.body || 'No description provided'}`).catch(() => []);
|
||||||
const content = messages?.pop()?.content;
|
const body = messages?.pop()?.content;
|
||||||
if(!content) {
|
if(!body) {
|
||||||
console.log('Invalid response from AI');
|
console.log('Invalid response from AI');
|
||||||
return process.exit(1);
|
return process.exit(1);
|
||||||
}
|
}
|
||||||
const title = /^# (.+)$/m.exec(content)?.[1] || issueData.title;
|
|
||||||
const typeMatch = /^## Type:\s*(.+)$/m.exec(content);
|
|
||||||
const type = typeMatch?.[1]?.split('/')[0]?.trim() || 'Unassigned';
|
|
||||||
const body = content.replace(/^# .+$/m, '').replace(/^## Type:.+$/m, '').trim();
|
|
||||||
const updateRes = await fetch(`${git}/api/v1/repos/${owner}/${repo}/issues/${ticket}`, {
|
const updateRes = await fetch(`${git}/api/v1/repos/${owner}/${repo}/issues/${ticket}`, {
|
||||||
method: 'PATCH',
|
method: 'PATCH',
|
||||||
headers: {
|
headers: {
|
||||||
@@ -102,9 +156,17 @@ Output ONLY the formatted ticket, no explanation.`
|
|||||||
body: JSON.stringify({
|
body: JSON.stringify({
|
||||||
title,
|
title,
|
||||||
body,
|
body,
|
||||||
labels: type?.length ? [`Kind/${type[0].toUpperCase() + type.slice(1).toLowerCase()}`] : []
|
|
||||||
})
|
})
|
||||||
});
|
});
|
||||||
if(!updateRes.ok) throw new Error(`${updateRes.status} ${await updateRes.text()}`);
|
if(!updateRes.ok) throw new Error(`${updateRes.status} ${await updateRes.text()}`);
|
||||||
console.log(body);
|
if(type) fetch(`${git}/api/v1/repos/${owner}/${repo}/issues/${ticket}/labels`, {
|
||||||
|
method: 'POST',
|
||||||
|
headers: {
|
||||||
|
'Authorization': `token ${auth}`,
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
},
|
||||||
|
body: `["Kind/${type[0].toUpperCase() + type.slice(1).toLowerCase()}"]`
|
||||||
|
})
|
||||||
|
|
||||||
|
console.log(`Title: ${title}\nType: ${type}\nBody:\n${body}`);
|
||||||
})();
|
})();
|
||||||
|
|||||||
Reference in New Issue
Block a user