| | --- |
| | language: |
| | - ar |
| | - en |
| | tags: |
| | - repoguard-ai |
| | - repoguard |
| | license: mit |
| | --- |
| | |
| | # GitHub Auto-Guardian |
| |
|
| | ## Overview |
| |
|
| | GitHub Auto-Guardian is an automated code quality maintenance system for GitHub repositories. It automatically detects and fixes code issues, prevents merging of broken code, and alerts you to problems that require human intervention. |
| |
|
| | ## Features |
| |
|
| | - **Issue Detection**: Analyze code for syntax errors, security vulnerabilities, and code quality issues |
| | - **Auto-Fix**: Automatically fix formatting issues, linting errors, and style violations |
| | - **Quality Gate**: Prevent merging of code that doesn't meet quality standards |
| | - **Smart Alerts**: Notify developers about issues that require human intervention |
| |
|
| | ## Quick Start |
| |
|
| | ### 1. Setup |
| |
|
| | ```bash |
| | # Copy the .github folder to your project |
| | cp -r .github/ /path/to/your/project/ |
| | |
| | # Install dependencies |
| | pip install -r .github/scripts/requirements.txt |
| | ``` |
| |
|
| | ### 2. Configure Branch Protection |
| |
|
| | Go to your GitHub repository settings: |
| |
|
| | 1. Navigate to **Settings** → **Branches** → **Branch protection rules** |
| | 2. Create a new rule for your main branch |
| | 3. Enable **Require status checks to pass before merging** |
| | 4. Add `Auto-Guardian Quality Gate` to the required checks |
| |
|
| | ### 3. Test the System |
| |
|
| | Create a pull request with some code quality issues to see the system in action. |
| |
|
| | ## File Structure |
| |
|
| | ``` |
| | .github/ |
| | ├── workflows/ |
| | │ └── auto-maintenance.yml # Main GitHub Actions workflow |
| | ├── scripts/ |
| | │ ├── auto-fix.sh # Auto-fix script |
| | │ ├── code-analyzer.py # Code analysis script |
| | │ ├── report-generator.py # Report generation script |
| | │ └── requirements.txt # Python dependencies |
| | └── configs/ |
| | ├── .eslintrc.json # ESLint configuration |
| | ├── .prettierrc # Prettier configuration |
| | └── pyproject.toml # Python tools configuration |
| | ``` |
| |
|
| | ## Local Usage |
| |
|
| | ### Run Code Analysis |
| |
|
| | ```bash |
| | python .github/scripts/code-analyzer.py |
| | ``` |
| |
|
| | ### Run Auto-Fix |
| |
|
| | ```bash |
| | bash .github/scripts/auto-fix.sh |
| | ``` |
| |
|
| | ### Generate Report |
| |
|
| | ```bash |
| | python .github/scripts/report-generator.py --scan-results scan-results.json |
| | ``` |
| |
|
| | ## Supported Languages |
| |
|
| | - Python |
| | - JavaScript / TypeScript |
| | - Go |
| | - Java |
| |
|
| | ## How It Works |
| |
|
| | ### 1. Detection Phase |
| | The system analyzes your code using multiple tools: |
| | - Linters (ESLint, Flake8, Pylint) |
| | - Security scanners (Bandit, custom patterns) |
| | - Code quality analyzers |
| |
|
| | ### 2. Auto-Fix Phase |
| | The system automatically fixes issues that are safe to correct: |
| | - Code formatting |
| | - Import organization |
| | - Style violations |
| | - Deprecated syntax |
| |
|
| | ### 3. Quality Gate Phase |
| | All changes must pass strict quality checks: |
| | - Test execution |
| | - Code complexity limits |
| | - Type checking |
| | - Security validation |
| |
|
| | ### 4. Alert Phase |
| | The system provides clear feedback: |
| | - Comments on Pull Requests |
| | - Slack/Discord notifications (optional) |
| | - Status checks with detailed reports |
| |
|
| | ## Configuration |
| |
|
| | ### Customizing Rules |
| |
|
| | Edit the configuration files to customize behavior: |
| |
|
| | - `.eslintrc.json` - ESLint rules |
| | - `.prettierrc` - Prettier formatting rules |
| | - `pyproject.toml` - Python tool settings |
| | - `.github/workflows/auto-maintenance.yml` - CI/CD pipeline |
| |
|
| | ### Adding New Languages |
| |
|
| | 1. Add language detection to `code-analyzer.py` |
| | 2. Add fix commands to `auto-fix.sh` |
| | 3. Create language-specific configurations |
| |
|
| | ## Troubleshooting |
| |
|
| | ### Issues Not Being Fixed |
| |
|
| | 1. Check if the issue is marked as `fixable: false` |
| | 2. Review the suggestion in the report |
| | 3. Manual intervention may be required |
| |
|
| | ### False Positives |
| |
|
| | 1. Add suppressions to ESLint/Pylint config |
| | 2. Use `# noqa` comments in code |
| | 3. Update the analyzer rules |
| |
|
| | ### Workflow Not Running |
| |
|
| | 1. Verify GitHub Actions are enabled |
| | 2. Check branch protection settings |
| | 3. Review workflow syntax |
| |
|
| | ## Contributing |
| |
|
| | 1. Fork the repository |
| | 2. Create a feature branch |
| | 3. Make your changes |
| | 4. Submit a pull request |
| |
|
| | ## License |
| |
|
| | MIT License - feel free to use this in your projects. |
| |
|
| | ## Support |
| |
|
| | For issues and feature requests, please open a GitHub issue. |
| |
|
