Skip to content

Commit 4781ac8

Browse files
leogdionclaude
leogdion
and
claude
committed
Add issue creation scripts and documentation
Scripts for automated GitHub issue generation: - Scripts/create-issues.js: Main automation script - Scripts/issue-config.json: Issue specifications for all 18 tasks - Scripts/package.json: Node.js configuration - Scripts/README.md: Script usage documentation - Scripts/ISSUE_CREATION_SUMMARY.md: Detailed breakdown of created issues These scripts successfully created issues #107-#124 for the skit-aist implementation, organized into 7 phases with proper dependency tracking. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 1b4212a commit 4781ac8

5 files changed

Lines changed: 859 additions & 0 deletions

File tree

‎Scripts/ISSUE_CREATION_SUMMARY.md‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
# GitHub Issues Creation Summary
2+
3+
## Overview
4+
5+
Successfully created 18 GitHub issues from the skit-analyze-plan.md implementation plan.
6+
7+
## Issue Breakdown by Phase
8+
9+
### Phase 1: Project Setup & Infrastructure (Issues #107-#109)
10+
11+
**Issue #107: Setup OpenAPI Specification and Generator Configuration**
12+
- Labels: infrastructure, setup
13+
- Dependencies: None
14+
- Files: Sources/ClaudeKit/openapi.json, Sources/ClaudeKit/openapi-generator-config.yaml
15+
16+
**Issue #108: Update Package.swift with Dependencies and Targets**
17+
- Labels: infrastructure, setup
18+
- Dependencies: #107
19+
- Files: Package.swift
20+
21+
**Issue #109: Create ConfigKeyKit Target Structure**
22+
- Labels: infrastructure, setup
23+
- Dependencies: #108
24+
- Files: Package.swift
25+
26+
### Phase 2: Core Configuration & Command Infrastructure (Issues #110-#111)
27+
28+
**Issue #110: Implement AnalyzerConfiguration and AnalyzerError**
29+
- Labels: enhancement, configuration
30+
- Dependencies: #109
31+
- Files: Sources/AiSTKit/AnalyzerConfiguration.swift, Sources/AiSTKit/AnalyzerError.swift
32+
33+
**Issue #111: Implement AnalyzeCommand and Main Entry Point**
34+
- Labels: enhancement, cli
35+
- Dependencies: #110
36+
- Files: Sources/skit-aist/AnalyzeCommand.swift, Sources/skit-aist/main.swift
37+
38+
### Phase 3: Input/Output Handlers (Issues #112-#115)
39+
40+
**Issue #112: Implement InputFolderReader**
41+
- Labels: enhancement, io
42+
- Dependencies: #110
43+
- Files: Sources/AiSTKit/InputFolderReader.swift
44+
45+
**Issue #113: Implement LibraryCollector**
46+
- Labels: enhancement, io
47+
- Dependencies: #110
48+
- Files: Sources/AiSTKit/LibraryCollector.swift
49+
50+
**Issue #114: Implement LibraryWriter**
51+
- Labels: enhancement, io
52+
- Dependencies: #118 (LibraryUpdateResult)
53+
- Files: Sources/AiSTKit/LibraryWriter.swift
54+
55+
**Issue #115: Implement ASTGenerator**
56+
- Labels: enhancement, ast
57+
- Dependencies: #110
58+
- Files: Sources/AiSTKit/ASTGenerator.swift
59+
60+
### Phase 4: Claude API Integration (Issues #116-#119)
61+
62+
**Issue #116: Implement ClaudeKit Wrapper**
63+
- Labels: enhancement, api
64+
- Dependencies: #108, #117, #119
65+
- Files: Sources/AiSTKit/ClaudeKit.swift
66+
67+
**Issue #117: Implement AuthenticationMiddleware**
68+
- Labels: enhancement, api
69+
- Dependencies: #108
70+
- Files: Sources/AiSTKit/AuthenticationMiddleware.swift
71+
72+
**Issue #118: Implement LibraryUpdateResult and FileReference Models**
73+
- Labels: enhancement, models
74+
- Dependencies: #110
75+
- Files: Sources/AiSTKit/LibraryUpdateResult.swift, Sources/AiSTKit/FileReference.swift
76+
77+
**Issue #119: Implement PromptTemplate**
78+
- Labels: enhancement, prompts
79+
- Dependencies: None
80+
- Files: Sources/AiSTKit/PromptTemplate.swift
81+
82+
### Phase 5: Main Orchestration (Issue #120)
83+
84+
**Issue #120: Implement SyntaxKitAnalyzer Orchestration**
85+
- Labels: enhancement, orchestration
86+
- Dependencies: #112, #113, #114, #115, #116
87+
- Files: Sources/AiSTKit/SyntaxKitAnalyzer.swift
88+
89+
### Phase 6: Testing Infrastructure (Issue #121)
90+
91+
**Issue #121: Implement Test/Validation Mode Components**
92+
- Labels: enhancement, testing
93+
- Dependencies: #120
94+
- Files: Sources/AiSTKit/Testing/*.swift (TestRunner, TestCaseDiscoverer, TestValidator, TestModels)
95+
96+
### Phase 7: Verification & Documentation (Issues #122-#124)
97+
98+
**Issue #122: Create Verification Test Cases**
99+
- Labels: testing
100+
- Dependencies: #121
101+
- Files: examples/*/dsl.swift, examples/*/expected.swift
102+
103+
**Issue #123: Create Example Usage Documentation**
104+
- Labels: documentation
105+
- Dependencies: #120
106+
- Files: Docs/skit-aist-usage.md
107+
108+
**Issue #124: Create Integration Tests**
109+
- Labels: testing, integration
110+
- Dependencies: #122
111+
- Files: Tests/AiSTKitTests/IntegrationTests.swift
112+
113+
## Labels Created
114+
115+
The following labels were created for this project:
116+
117+
- **infrastructure** (#0052CC) - Infrastructure and setup tasks
118+
- **setup** (#0052CC) - Setup and configuration
119+
- **configuration** (#5319E7) - Configuration related
120+
- **cli** (#1D76DB) - Command-line interface
121+
- **io** (#006B75) - Input/Output operations
122+
- **api** (#0E8A16) - API integration
123+
- **models** (#FBCA04) - Data models
124+
- **prompts** (#D93F0B) - Prompt templates
125+
- **orchestration** (#C5DEF5) - Workflow orchestration
126+
- **ast** (#BFD4F2) - AST generation
127+
- **testing** (#d876e3) - Testing infrastructure
128+
- **integration** (#5319E7) - Integration testing
129+
130+
Existing labels used:
131+
- **enhancement** - New features
132+
- **documentation** - Documentation updates
133+
134+
## Implementation Order
135+
136+
Issues should be worked on in dependency order:
137+
138+
1. **Phase 1**: #107 → #108 → #109 (Foundation)
139+
2. **Phase 2**: #110 → #111 (Configuration)
140+
3. **Phase 3**: #112, #113, #115 (can be parallel), then #118, then #114
141+
4. **Phase 4**: #119 (parallel), #117 (parallel with #118), then #116
142+
5. **Phase 5**: #120 (Main orchestration - requires most prior work)
143+
6. **Phase 6**: #121 (Testing infrastructure)
144+
7. **Phase 7**: #122 → #123 (parallel), #124
145+
146+
## Quick Reference Commands
147+
148+
```bash
149+
# View all skit-aist issues
150+
gh issue list --label infrastructure,configuration,cli,io,api,orchestration
151+
152+
# View issues by phase (using labels)
153+
gh issue list --label infrastructure # Phase 1
154+
gh issue list --label configuration # Phase 2
155+
gh issue list --label io # Phase 3
156+
gh issue list --label api # Phase 4
157+
gh issue list --label orchestration # Phase 5
158+
gh issue list --label testing # Phase 6-7
159+
160+
# Start work on first issue
161+
gh issue view 107
162+
```
163+
164+
## Files Created
165+
166+
- `scripts/package.json` - Node.js package configuration
167+
- `scripts/issue-config.json` - Issue metadata and configuration
168+
- `scripts/create-issues.js` - Automated issue creation script
169+
- `scripts/ISSUE_CREATION_SUMMARY.md` - This summary document
170+
171+
## Success Metrics
172+
173+
- ✅ All 18 issues created successfully
174+
- ✅ All labels created with appropriate colors
175+
- ✅ Dependencies correctly cross-referenced
176+
- ✅ Issues numbered #107-#124
177+
- ✅ Each issue is self-contained and actionable
178+
- ✅ All code snippets from plan included in relevant issues
179+
- ✅ Acceptance criteria clearly defined for each issue
180+
181+
## Next Steps
182+
183+
1. Review all issues to ensure completeness
184+
2. Consider creating a GitHub Project board to track progress
185+
3. Assign issues to team members or milestones
186+
4. Begin implementation starting with Phase 1 issues
187+
188+
```bash
189+
# Optional: Create a project board
190+
gh project create --title "skit-aist Implementation" --body "Track skit-aist tool development"
191+
```

‎Scripts/README.md‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
# GitHub Issue Creation Scripts
2+
3+
This directory contains scripts for automating the creation of GitHub issues from implementation plans.
4+
5+
## Files
6+
7+
- **`create-issues.js`** - Main script that creates GitHub issues from configuration
8+
- **`issue-config.json`** - Issue metadata, labels, and specifications
9+
- **`package.json`** - Node.js package configuration
10+
- **`ISSUE_CREATION_SUMMARY.md`** - Summary of created issues
11+
12+
## Prerequisites
13+
14+
1. **GitHub CLI** installed and authenticated:
15+
```bash
16+
gh auth status
17+
gh auth login # if needed
18+
```
19+
20+
2. **Node.js** (v18 or later recommended):
21+
```bash
22+
node --version
23+
```
24+
25+
## Usage
26+
27+
### Create Issues
28+
29+
```bash
30+
cd scripts
31+
node create-issues.js
32+
```
33+
34+
The script will:
35+
1. Create all necessary labels if they don't exist
36+
2. Create issues in dependency order
37+
3. Cross-reference dependencies between issues
38+
4. Output a summary with issue numbers
39+
40+
### View Created Issues
41+
42+
```bash
43+
# List all issues
44+
gh issue list --limit 20
45+
46+
# View specific issue
47+
gh issue view 107
48+
49+
# List issues by label
50+
gh issue list --label infrastructure
51+
gh issue list --label testing
52+
```
53+
54+
## Issue Configuration
55+
56+
The `issue-config.json` file defines:
57+
58+
- **labels** - Label names and colors
59+
- **issues** - Array of issue specifications with:
60+
- `id` - Local issue ID (for dependency tracking)
61+
- `phase` - Implementation phase
62+
- `title` - Issue title
63+
- `labels` - Array of label names
64+
- `dependencies` - Array of issue IDs this depends on
65+
- `files` - Files to create/modify
66+
- `spec` - Specification text
67+
- `acceptance` - Array of acceptance criteria
68+
69+
## Adding New Issues
70+
71+
To add new issues:
72+
73+
1. Edit `issue-config.json`
74+
2. Add new issue object to the `issues` array
75+
3. Ensure dependencies reference existing issue IDs
76+
4. Run `node create-issues.js`
77+
78+
## Script Features
79+
80+
- **Dependency Handling** - Creates issues in order, cross-references dependencies
81+
- **Label Management** - Creates missing labels automatically
82+
- **Error Handling** - Continues on errors, reports failures
83+
- **Rate Limiting** - Small delays between API calls
84+
- **Summary Output** - Maps local IDs to GitHub issue numbers
85+
86+
## Example Output
87+
88+
```
89+
GitHub Issue Creator for skit-analyze-plan.md
90+
==================================================
91+
92+
Step 1: Creating labels...
93+
Created label: infrastructure
94+
Label "enhancement" already exists
95+
...
96+
97+
Step 2: Creating issues...
98+
99+
Creating issue 1: Setup OpenAPI Specification and Generator Configuration
100+
Created issue #107: Setup OpenAPI Specification and Generator Configuration
101+
102+
Creating issue 2: Update Package.swift with Dependencies and Targets
103+
Created issue #108: Update Package.swift with Dependencies and Targets
104+
...
105+
106+
==================================================
107+
Summary:
108+
Total issues created: 18 / 18
109+
110+
Issue mapping:
111+
Issue 1 -> #107: Setup OpenAPI Specification and Generator Configuration
112+
Issue 2 -> #108: Update Package.swift with Dependencies and Targets
113+
...
114+
```
115+
116+
## Troubleshooting
117+
118+
### GitHub CLI Not Authenticated
119+
120+
```bash
121+
gh auth login
122+
```
123+
124+
### Label Already Exists Error
125+
126+
This is expected - the script handles existing labels gracefully.
127+
128+
### Issue Creation Failed
129+
130+
Check the error message. Common issues:
131+
- Network connectivity
132+
- API rate limiting (add delays in script)
133+
- Invalid characters in title/body (check escaping)
134+
135+
## Customization
136+
137+
### Changing Label Colors
138+
139+
Edit the `labels` object in `issue-config.json`:
140+
141+
```json
142+
"labels": {
143+
"infrastructure": "0052CC",
144+
"custom-label": "FF0000"
145+
}
146+
```
147+
148+
### Modifying Issue Template
149+
150+
Edit the `formatIssueBody()` function in `create-issues.js` to change the issue body format.
151+
152+
## Related Documentation
153+
154+
- [skit-analyze-plan.md](../Docs/skit-analyze-plan.md) - Full implementation plan
155+
- [ISSUE_CREATION_SUMMARY.md](./ISSUE_CREATION_SUMMARY.md) - Summary of created issues

0 commit comments

Comments
 (0)