Skip to content

Commit 451ddf0

Browse files
committed
feat: enhance feature discovery with detailed issue content generation
- Add comprehensive analysis requirements for Claude Code - Include specific placeholder replacement instructions - Enhance issue quality requirements with detailed guidance - Add implementation complexity and module impact analysis - Improve summary report generation with quality metrics - Ensure actionable, detailed issue descriptions with real examples
1 parent 79868cf commit 451ddf0

File tree

1 file changed

+192
-21
lines changed

1 file changed

+192
-21
lines changed

.github/workflows/feature-discovery.yml

Lines changed: 192 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ jobs:
154154
- Configuration patterns used
155155
156156
### Step 4: Comparison and Analysis
157-
Compare provider documentation with module implementation:
157+
Compare provider documentation with module implementation and perform detailed analysis:
158158
159159
**New Features to Look For:**
160160
- New `aws_ecr_*` resources not in the module
@@ -163,40 +163,188 @@ jobs:
163163
- New lifecycle configurations
164164
- New security features
165165
166+
**For Each Discovery, Document:**
167+
- **Feature Type**: Resource, Argument, Data Source, Enhancement
168+
- **AWS Resource**: Full resource name (e.g., aws_ecr_repository_creation_template)
169+
- **Arguments**: Specific new arguments with their types and descriptions
170+
- **Provider Version**: When the feature was introduced
171+
- **Priority Level**: Critical (security/breaking), High (major feature), Medium (enhancement), Low (minor)
172+
- **Implementation Complexity**: High (major changes), Medium (moderate effort), Low (simple addition)
173+
- **Module Impact**: Which files need modification (main.tf, variables.tf, etc.)
174+
- **Dependencies**: Any new provider requirements or version constraints
175+
- **Use Cases**: Real-world scenarios where this feature would be valuable
176+
166177
**Deprecations to Check:**
167-
- Arguments marked as deprecated
168-
- Resources marked for removal
169-
- Configuration patterns that are outdated
178+
- Arguments marked as deprecated with removal timeline
179+
- Resources marked for removal with migration path
180+
- Configuration patterns that are outdated with modern alternatives
170181
171182
**Bug Fixes:**
172183
- Check Context7 for AWS provider changelogs
173184
- Look for ECR-related fixes that might affect the module
185+
- Document the specific issue being fixed and module impact
174186
175187
### Step 5: Issue Creation
176-
For each significant finding:
188+
For each significant finding, create detailed GitHub issues with comprehensive analysis.
189+
190+
**CRITICAL: Generate Detailed, Actionable Content**
191+
192+
**Issue Quality Requirements:**
193+
1. **Comprehensive Analysis**: Include detailed findings from your Terraform MCP analysis
194+
2. **Specific Implementation Guidance**: Provide exact resource names, arguments, and code patterns
195+
3. **Real Provider Documentation**: Reference actual AWS provider documentation links
196+
4. **Module Integration Details**: Explain how the feature fits into existing module structure
197+
5. **Practical Examples**: Include working code examples with actual values
198+
199+
**Content Generation Instructions:**
200+
- Replace `[FEATURE_NAME]` with the actual discovered feature name (e.g., "image_tag_mutability_exclusion_filter")
201+
- Replace `[DETAILED_DESCRIPTION_FROM_ANALYSIS]` with comprehensive analysis from provider docs including:
202+
* What the feature does and why it's valuable
203+
* How it works in the AWS ecosystem
204+
* Benefits for ECR users
205+
* Integration requirements
206+
- Replace `[PRIORITY_LEVEL]` with justified priority based on impact analysis
207+
- Replace `[AWS_RESOURCE_NAME]` with exact resource (e.g., "aws_ecr_repository")
208+
- Replace `[SPECIFIC_ARGUMENTS]` with actual argument names, types, and descriptions from provider docs
209+
- Replace `[FILES_TO_MODIFY]` with specific module files requiring changes
210+
- Replace `[COMPLEXITY_ASSESSMENT]` with detailed complexity analysis including effort estimation
211+
- Replace `[PROVIDER_DOCS_LINK]` with actual Terraform registry documentation URL
212+
- Replace `[REGISTRY_LINK]` with actual AWS provider documentation link
213+
- Include actual working code examples with realistic values
177214
178215
**If NOT in dry run mode (${{ inputs.dry_run }} == false):**
179216
180-
Create GitHub issues using templates:
217+
Create GitHub issues using these enhanced templates with detailed information:
181218
182219
```bash
183-
# For new features
184-
gh issue create --title "feat: Add support for [feature_name]" \
185-
--body "Auto-discovered ECR feature requiring implementation. See feature tracker for details." \
220+
# For new features - include comprehensive details
221+
gh issue create --title "feat: Add support for [FEATURE_NAME]" \
222+
--body "## 🚀 Auto-Discovered ECR Feature
223+
224+
**Feature:** [FEATURE_NAME]
225+
**AWS Provider Version:** ${{ inputs.provider_version || 'latest' }}
226+
**Priority:** [PRIORITY_LEVEL]
227+
**Discovery Date:** $(date -u '+%Y-%m-%d %H:%M:%S UTC')
228+
229+
### 📋 Description
230+
[DETAILED_DESCRIPTION_FROM_ANALYSIS]
231+
232+
### 🔧 Implementation Requirements
233+
- **Resource:** \`[AWS_RESOURCE_NAME]\`
234+
- **New Arguments:** \`[SPECIFIC_ARGUMENTS]\`
235+
- **Module Files to Update:** [FILES_TO_MODIFY]
236+
- **Estimated Complexity:** [COMPLEXITY_ASSESSMENT]
237+
238+
### 📚 Documentation
239+
- **Provider Documentation:** [PROVIDER_DOCS_LINK]
240+
- **Terraform Registry:** [REGISTRY_LINK]
241+
242+
### 🔍 Discovery Details
243+
- **Workflow Run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
244+
- **Feature Tracker:** \`.github/feature-tracker/ecr-features.json\`
245+
- **Detection Method:** Terraform MCP Server analysis
246+
247+
### ✅ Acceptance Criteria
248+
- [ ] Implement resource/argument in module
249+
- [ ] Add variable validation if needed
250+
- [ ] Create example usage
251+
- [ ] Update documentation
252+
- [ ] Add Terratest coverage" \
186253
--label "enhancement,aws-provider-update,auto-discovered" \
187254
--assignee "@me"
188255
189-
# For deprecations
190-
gh issue create --title "chore: Handle deprecation of [feature_name]" \
191-
--body "Auto-discovered deprecation in AWS ECR provider. Migration required." \
256+
# For deprecations - include migration guidance
257+
gh issue create --title "chore: Handle deprecation of [DEPRECATED_FEATURE]" \
258+
--body "## ⚠️ Auto-Discovered Deprecation
259+
260+
**Deprecated Feature:** [DEPRECATED_FEATURE]
261+
**AWS Provider Version:** ${{ inputs.provider_version || 'latest' }}
262+
**Discovery Date:** $(date -u '+%Y-%m-%d %H:%M:%S UTC')
263+
**Breaking Change Risk:** [RISK_LEVEL]
264+
265+
### 📋 Deprecation Details
266+
[DETAILED_DEPRECATION_INFO]
267+
268+
### 🚨 Impact Analysis
269+
- **Current Usage:** [CURRENT_USAGE_IN_MODULE]
270+
- **Migration Complexity:** [MIGRATION_COMPLEXITY]
271+
272+
### 🔄 Migration Path
273+
- **Replacement Feature:** [REPLACEMENT_OPTION]
274+
- **Migration Steps:** [STEP_BY_STEP_GUIDE]
275+
276+
### 📅 Action Required
277+
- [ ] Plan migration strategy
278+
- [ ] Update module implementation
279+
- [ ] Create migration guide
280+
- [ ] Notify users via changelog
281+
282+
### 📚 Reference
283+
- **Workflow Run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
284+
- **Provider Documentation:** [DEPRECATION_DOCS]" \
192285
--label "deprecation,breaking-change,auto-discovered" \
193286
--assignee "@me"
194287
195-
# For bug fixes
196-
gh issue create --title "fix: Address [bug_description]" \
197-
--body "Auto-discovered bug fix available in AWS ECR provider." \
288+
# For bug fixes - include technical details
289+
gh issue create --title "fix: [BUG_DESCRIPTION]" \
290+
--body "## 🔧 Auto-Discovered Bug Fix
291+
292+
**Issue:** [BUG_DESCRIPTION]
293+
**AWS Provider Version:** ${{ inputs.provider_version || 'latest' }}
294+
**Priority:** [PRIORITY_LEVEL]
295+
**Discovery Date:** $(date -u '+%Y-%m-%d %H:%M:%S UTC')
296+
297+
### 🐛 Problem Description
298+
[DETAILED_BUG_DESCRIPTION]
299+
300+
### 🛠️ Fix Requirements
301+
- **Root Cause:** [ROOT_CAUSE_ANALYSIS]
302+
- **Files to Update:** [FILES_TO_MODIFY]
303+
- **Validation Changes:** [VALIDATION_UPDATES]
304+
305+
### 🧪 Testing Requirements
306+
- [ ] Update existing tests
307+
- [ ] Add regression tests
308+
- [ ] Validate with provider version ${{ inputs.provider_version || 'latest' }}
309+
310+
### 📚 Reference
311+
- **Workflow Run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
312+
- **Provider Fix Details:** [FIX_DOCUMENTATION]" \
198313
--label "bug,aws-provider-update,auto-discovered" \
199314
--assignee "@me"
315+
316+
# For security enhancements - include security details
317+
gh issue create --title "security: Implement [SECURITY_FEATURE]" \
318+
--body "## 🛡️ Auto-Discovered Security Enhancement
319+
320+
**Security Feature:** [SECURITY_FEATURE]
321+
**AWS Provider Version:** ${{ inputs.provider_version || 'latest' }}
322+
**Security Impact:** [SECURITY_IMPACT]
323+
**Discovery Date:** $(date -u '+%Y-%m-%d %H:%M:%S UTC')
324+
325+
### 🔒 Security Enhancement Details
326+
[DETAILED_SECURITY_DESCRIPTION]
327+
328+
### 🎯 Benefits
329+
- **Security Improvement:** [SECURITY_BENEFITS]
330+
- **Compliance Impact:** [COMPLIANCE_BENEFITS]
331+
- **Risk Mitigation:** [RISK_MITIGATION]
332+
333+
### 🔧 Implementation Requirements
334+
- **New Security Arguments:** [SECURITY_ARGUMENTS]
335+
- **Default Security Posture:** [DEFAULT_CONFIG]
336+
337+
### ✅ Security Validation
338+
- [ ] Implement secure defaults
339+
- [ ] Add security tests
340+
- [ ] Update security documentation
341+
- [ ] Validate compliance requirements
342+
343+
### 📚 Reference
344+
- **Workflow Run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
345+
- **Security Documentation:** [SECURITY_DOCS]" \
346+
--label "security,aws-provider-update,auto-discovered" \
347+
--assignee "@me"
200348
```
201349
202350
### Step 6: Update Feature Tracker
@@ -207,12 +355,35 @@ jobs:
207355
- Issues created
208356
- Scan summary
209357
210-
### Step 7: Generate Summary Report
211-
Create a comprehensive summary including:
212-
- Features discovered: count and details
213-
- Deprecations found: count and impact
214-
- Issues created: numbers and links
215-
- Recommendations for next steps
358+
### Step 7: Generate Comprehensive Summary Report
359+
Create a detailed summary report including:
360+
361+
**Discovery Summary:**
362+
- Total features discovered with breakdown by type (resources, arguments, data sources)
363+
- Detailed analysis of each discovery with provider version and impact assessment
364+
- Deprecations found with timeline and migration complexity
365+
- Bug fixes identified with specific module impact
366+
367+
**Implementation Analysis:**
368+
- Priority breakdown: Critical/High/Medium/Low with justification
369+
- Complexity assessment: effort required for each feature
370+
- Module architecture impact: which files and patterns need updates
371+
- Dependency requirements: provider version constraints
372+
373+
**Issues Created:**
374+
- List of GitHub issues created with issue numbers and links
375+
- Content quality summary: level of detail provided for each issue
376+
- Categorization: features vs deprecations vs bug fixes
377+
378+
**Quality Metrics:**
379+
- Analysis depth: how comprehensive the provider documentation review was
380+
- Content accuracy: confidence level in findings
381+
- Implementation guidance: specificity of development instructions
382+
383+
**Next Steps Recommendations:**
384+
- High-priority items requiring immediate attention
385+
- Long-term module evolution suggestions
386+
- Community impact assessment
216387
217388
## Important Notes
218389
- Skip creating issues for features already tracked as "implemented"

0 commit comments

Comments
 (0)