https://github.com/somaz94/github-action-analyzer
github-action-analyzer
https://github.com/somaz94/github-action-analyzer
Last synced: 3 months ago
JSON representation
github-action-analyzer
- Host: GitHub
- URL: https://github.com/somaz94/github-action-analyzer
- Owner: somaz94
- License: mit
- Created: 2025-02-18T02:34:08.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-18T04:00:44.000Z (3 months ago)
- Last Synced: 2025-02-18T04:21:47.829Z (3 months ago)
- Language: Go
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# GitHub Action Analyzer
[](https://github.com/somaz94/github-action-analyzer)
[](https://github.com/marketplace/actions/github-action-analyzer)
## Overview
The **GitHub Action Analyzer** is a GitHub Action that analyzes your workflow performance and provides optimization recommendations. It helps identify bottlenecks, suggests caching strategies, and offers Docker optimization tips to improve your CI/CD pipeline efficiency.
## Inputs
| Input | Required | Description | Default | Example |
|-----------------|----------|------------------------------------------------|---------|------------------------|
| `github_token` | Yes | GitHub token for API access | - | `${{ secrets.GITHUB_TOKEN }}` |
| `workflow_file` | Yes | Name of the workflow file to analyze | - | `"ci.yml"` |
| `repository` | Yes | Repository in owner/repo format | - | `"owner/repo"` |
| `debug` | No | Enable debug mode for detailed logging | `false` | `true` |
| `analysis_depth`| No | Number of workflow runs to analyze | `10` | `"20"` |
| `ignore_patterns`| No | Comma-separated list of step names to ignore | - | `"checkout,setup"` |
| `timeout` | No | Analysis timeout in minutes | `60` | `"15"` |
## Outputs
| Output | Description |
|-----------------------|------------------------------------------------|
| `metrics_summary` | Summary of workflow metrics in JSON format |
| `performance_summary` | Detailed performance analysis summary |
| `cache_recommendations`| Cache optimization recommendations |
| `docker_optimizations` | Docker-related optimization suggestions |
| `status` | Analysis execution status |
## Example Usage
### Basic Usage
```yaml
name: Analyze Workflow
on: [push, workflow_dispatch]
jobs:
analyze:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Analyze Workflow Performance
uses: somaz94/github-action-analyzer@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
workflow_file: ci.yml
repository: ${{ github.repository }}
```
### With Debug Mode
```yaml
name: Analyze Workflow with Debug
on: [push, workflow_dispatch]
jobs:
analyze:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Analyze Workflow Performance
uses: somaz94/github-action-analyzer@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
workflow_file: ci.yml
repository: ${{ github.repository }}
debug: true # Enable debug mode for detailed logging
```
## Debug Mode
When debug mode is enabled (`debug: true`), the analyzer will:
- Display the full workflow file content being analyzed
- Show detected programming languages
- Log version detection attempts and results
- Print detailed cache strategy recommendations
- Output additional diagnostic information
This is useful for:
- Troubleshooting analysis issues
- Verifying language detection
- Checking version detection accuracy
- Understanding the analyzer's decision process
## Features
- Workflow runtime analysis
- Cache hit rate monitoring
- Docker layer optimization suggestions
- Job dependency analysis
- Resource usage tracking
- Step duration analysis
- Automated recommendations for:
- Caching strategies
- Docker image optimization
- Workflow structure improvements
- Resource allocation
## Supported Languages & Frameworks
| Language/Framework | Cache Recommendations | Version Check |
|-------------------|----------------------|---------------|
| Go | ✅ | ✅ |
| Node.js | ✅ | ✅ |
| Python | ✅ | ✅ |
| Java/Maven | ✅ | ✅ |
| Ruby | ✅ | ✅ |
| Rust | ✅ | ✅ |
| .NET | ✅ | ✅ |
Each language includes specific recommendations for:
- Dependencies caching
- Build artifacts caching
- Version updates
- Best practices for the ecosystem
## Advanced Usage
### Basic Usage
```yaml
name: Analyze Workflow
on: [push, workflow_dispatch]
jobs:
analyze:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Analyze Workflow Performance
uses: somaz94/github-action-analyzer@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
workflow_file: ci.yml
repository: ${{ github.repository }}
```
### Advanced Usage with All Options
```yaml
name: Detailed Workflow Analysis
on: [push, workflow_dispatch]
jobs:
analyze:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Analyze Workflow Performance
uses: somaz94/github-action-analyzer@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
workflow_file: ci.yml
repository: ${{ github.repository }}
debug: true
analysis_depth: '20'
ignore_patterns: 'checkout,setup'
timeout: '15'
```
### Analyzing Multiple Workflows
```yaml
jobs:
analyze:
runs-on: ubuntu-latest
steps:
- name: Analyze CI Workflow
uses: somaz94/github-action-analyzer@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
workflow_file: ci.yml
repository: ${{ github.repository }}
- name: Analyze Deploy Workflow
uses: somaz94/github-action-analyzer@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
workflow_file: deploy.yml
repository: ${{ github.repository }}
```
### Using Analysis Results
```yaml
jobs:
analyze:
runs-on: ubuntu-latest
steps:
- name: Analyze Workflow
id: analysis
uses: somaz94/github-action-analyzer@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
workflow_file: ci.yml
repository: ${{ github.repository }}
- name: Print Analysis Results
run: |
echo "Metrics Summary: ${{ steps.analysis.outputs.metrics_summary }}"
echo "Performance Summary: ${{ steps.analysis.outputs.performance_summary }}"
echo "Cache Recommendations: ${{ steps.analysis.outputs.cache_recommendations }}"
echo "Docker Optimizations: ${{ steps.analysis.outputs.docker_optimizations }}"
echo "Status: ${{ steps.analysis.outputs.status }}"
```
## Analysis Types
### 1. Performance Analysis
- Job execution time trends
- Step duration breakdown
- Resource utilization patterns
- Bottleneck identification
### 2. Cache Analysis
- Cache hit/miss ratios
- Cache size monitoring
- Cache restoration times
- Optimization suggestions
### 3. Docker Analysis
- Layer caching effectiveness
- Image size optimization
- Build time analysis
- Multi-stage build recommendations
## Troubleshooting
Common issues and solutions:
1. **API Rate Limiting**
- Error: `API rate limit exceeded`
- Solution: Use a GitHub token with appropriate permissions
2. **Access Denied**
- Error: `Resource not accessible`
- Solution: Ensure the token has `repo` scope access
3. **Invalid Workflow File**
- Error: `Workflow file not found`
- Solution: Verify the workflow file path and name
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.