Repository navigation
Expand file tree
/
Copy pathexample-workflow.yml
More file actions
114 lines (99 loc) · 5.18 KB
/
Copy pathexample-workflow.yml
File metadata and controls
114 lines (99 loc) · 5.18 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# Example workflow for using the OpenAPI Analyzer in your repository
# Copy this file to your repository's .github/workflows/ directory
name: OpenAPI Analysis
on:
push:
branches: [ main, develop ]
paths:
- '**/*.json'
- '**/*.yaml'
- '**/*.yml'
pull_request:
branches: [ main, develop ]
paths:
- '**/*.json'
- '**/*.yaml'
- '**/*.yml'
workflow_dispatch:
jobs:
analyze-openapi:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Analyze OpenAPI
id: analyze
uses: ApyGuard/apyguard_openapi_analysis@main
with:
# Change this to your OpenAPI file path
file: your-openapi-file.json
output_format: json
- name: Display Results
run: |
echo "🔍 OpenAPI Analysis Results:"
echo "============================"
echo "✅ Valid: ${{ steps.analyze.outputs.is_valid }}"
echo "📊 Basic Metrics:"
echo " - Operations: ${{ steps.analyze.outputs.operations_count }}"
echo " - Paths: ${{ steps.analyze.outputs.paths_count }}"
echo " - Schemas: ${{ steps.analyze.outputs.schemas_count }}"
echo " - Total Suggestions: ${{ steps.analyze.outputs.suggestions_count }}"
echo ""
echo "🎯 Advanced Analytics:"
echo " - Complexity Score: ${{ steps.analyze.outputs.complexity_score }}"
echo " - Maintainability Score: ${{ steps.analyze.outputs.maintainability_score }}"
echo ""
echo "📋 Analysis Categories:"
echo " - 🔒 Security Issues: ${{ steps.analyze.outputs.security_issues }}"
echo " - ⚡ Performance Issues: ${{ steps.analyze.outputs.performance_issues }}"
echo " - 🏗️ Design Pattern Issues: ${{ steps.analyze.outputs.design_pattern_issues }}"
echo " - 🔄 Versioning Issues: ${{ steps.analyze.outputs.versioning_issues }}"
echo " - 📝 Documentation Issues: ${{ steps.analyze.outputs.documentation_issues }}"
echo " - 🛡️ Compliance Issues: ${{ steps.analyze.outputs.compliance_issues }}"
echo " - 🧪 Testing Recommendations: ${{ steps.analyze.outputs.testing_recommendations }}"
echo " - 📈 Monitoring Recommendations: ${{ steps.analyze.outputs.monitoring_recommendations }}"
echo " - 🔧 Code Generation Opportunities: ${{ steps.analyze.outputs.code_generation_opportunities }}"
echo " - 🏛️ Governance Issues: ${{ steps.analyze.outputs.governance_issues }}"
- name: Comment on PR
if: github.event_name == 'pull_request'
uses: actions/github-script@v7
with:
script: |
const analysis = JSON.parse('${{ steps.analyze.outputs.analysis }}');
const categories = analysis.analysis_categories || {};
const analytics = analysis.analytics || {};
const comment = `## 🔍 OpenAPI Analysis Results
**Valid**: ${analysis.is_valid ? '✅' : '❌'}
**Total Suggestions**: ${analysis.suggestions ? Object.values(analysis.suggestions).reduce((total, suggestions) => total + suggestions.length, 0) : 0}
### 📊 Basic Metrics
- **Operations**: ${analysis.summary ? analysis.summary.operations_count : 0}
- **Paths**: ${analysis.summary ? analysis.summary.paths_count : 0}
- **Schemas**: ${analysis.summary ? analysis.summary.schemas_count : 0}
### 🎯 Advanced Analytics
- **Complexity Score**: ${analytics.complexity_score || 0}
- **Maintainability Score**: ${analytics.maintainability_score || 0}/100
### 📋 Analysis Categories
- **Security Issues**: ${categories.security || 0}
- **Performance Issues**: ${categories.performance || 0}
- **Design Pattern Issues**: ${categories.design_patterns || 0}
- **Versioning Issues**: ${categories.versioning || 0}
- **Documentation Issues**: ${categories.documentation || 0}
- **Compliance Issues**: ${categories.compliance || 0}
- **Testing Recommendations**: ${categories.testing || 0}
- **Monitoring Recommendations**: ${categories.monitoring || 0}
- **Code Generation Opportunities**: ${categories.code_generation || 0}
- **Governance Issues**: ${categories.governance || 0}
${analysis.suggestions && Object.keys(analysis.suggestions).length > 0 ?
Object.entries(analysis.suggestions).map(([category, suggestions]) =>
`### ${category} (${suggestions.length} issues)\n\n${suggestions.slice(0, 3).map(s => `- ${s}`).join('\n')}${suggestions.length > 3 ? `\n- ... and ${suggestions.length - 3} more` : ''}\n`
).join('\n') :
'### ✅ No suggestions found! Your OpenAPI specification looks great! 🎉'
}
---
*Powered by ApyGuard OpenAPI Analyzer with comprehensive best practices analysis*`;
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: comment
});