diff --git a/docs/tools/pipeline-remediation.md b/docs/tools/pipeline-remediation.md new file mode 100644 index 00000000..98fd14b0 --- /dev/null +++ b/docs/tools/pipeline-remediation.md @@ -0,0 +1,167 @@ +--- +title: Pipeline Failure Remediation +sidebar_label: Pipeline Remediation +description: CodeRabbit's automated pipeline failure detection and remediation capabilities. +--- + +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + +## Overview + +Are pipeline failures holding up your pull requests? Is your latest code failing to build and digging through the failure logs is an absolute nightmare? CodeRabbit's Pipeline Failure Remediation tool automatically detects and fixes build failures across your CI/CD pipelines. + +Our intelligent AI system analyzes pipeline failures in real-time, providing inline comments and actionable suggestions to quickly resolve issues. We support multiple CI/CD platforms and integrate with popular security scanning tools to provide comprehensive remediation guidance. + +## Example Remediations + +With CodeRabbit CI/CD Pipeline Remediation, you have coderabbit automatically review the output of any tooling you desire. Here are some examples of the types of common issues we can help you fix: + +### Docker Build Issues + +- Missing build dependencies +- Base image compatibility +- Multi-stage build optimization +- Cache utilization improvements + +Docker Build Remediation + +### Java Build & Testing + +- Maven/Gradle dependency conflicts +- Compilation errors +- Test failures +- Memory allocation issues + +Java Build Remediation + +### Kubernetes Deployments + +- Service configuration validation +- Resource allocation optimization +- Network policy fixes +- Security context remediation + +Kubernetes Configuration + +### NPM Package Management + +- Package resolution conflicts +- Version compatibility issues +- Security vulnerability patches +- Build script optimization + +NPM Dependencies + +### Python Environment + +- Package dependency resolution +- Virtual environment setup +- Test framework configuration +- Code style compliance + +Python Build Issues + +### Security Scanning + +- SAST finding remediation +- Code injection prevention +- Security best practices +- Compliance validation + +Security Scan Results + +### Terraform and Infrastructure as Code + +- Resource configuration validation +- State management issues +- Provider compatibility +- Security group optimization + +Terraform Configuration + +## Supported Platforms + +### GitHub Actions + +- Automatic detection of workflow failures +- Inline fixes for common build issues +- Integration with GitHub Checks +- Support for custom actions and workflows + +### GitLab CI/CD + +- Pipeline failure analysis +- Integration with GitLab Advanced Security +- Support for DAST (Dynamic Application Security Testing) findings +- Remediation for SAST (Static Application Security Testing) issues + +GitLab CI/CD + +GitLab Security Integration + +### CircleCI + +- Workflow failure detection +- Job-level error analysis +- Configuration validation +- Dependency resolution + +CircleCI Integration + +## Common Use Cases + +Our tool handles a wide range of pipeline failures including: + +### Build Failures + +- Docker build issues +- Node.js dependency conflicts +- Java compilation errors +- Python package resolution +- Go module management + +### Infrastructure as Code + +- Kubernetes manifest validation +- Terraform template errors +- CloudFormation stack issues +- Ansible playbook failures + +### Security Pipeline Integration + +- SAST finding remediation +- DAST vulnerability fixes +- Dependency scanning +- Container security + +### Testing Failures + +- Unit test failures +- Integration test errors +- End-to-end test issues +- Performance test threshold violations + +## How It Works + +1. **Detection**: CodeRabbit monitors your pipeline runs and automatically detects failures +2. **Analysis**: Our AI analyzes the failure logs and context to determine the root cause +3. **Remediation**: We provide inline suggestions and automated fixes where possible +4. **Learning**: The system learns from successful fixes to improve future recommendations + +## Best Practices + +1. **Keep Dependencies Updated**: Regular dependency updates help prevent build failures +2. **Use Lock Files**: Lock files ensure consistent builds across environments +3. **Implement Caching**: Proper caching strategies speed up builds and reduce failures +4. **Monitor Resource Usage**: Ensure sufficient resources are allocated to prevent timeouts +5. **Maintain Clean Tests**: Well-maintained tests reduce false positives + +## Links + +- [GitHub Actions Configuration](https://docs.github.com/en/actions) +- [GitLab CI/CD Documentation](https://docs.gitlab.com/ee/ci/) +- [CircleCI Documentation](https://circleci.com/docs/) diff --git a/docs/tools/tools.md b/docs/tools/tools.md index 3977d6f1..e13cda31 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -42,37 +42,38 @@ Remove extraneous f prefix ## Supported Tools -| Technology | Tools | Category | -| :-------------------------- | :--------------------------------------------------------- | :----------------------------- | -| All | [Gitleaks][Gitleaks] | Code Security | -| CircleCI | [CircleCI][CircleCI] | Configuration Validation | -| CloudFormation | [Checkov][Checkov] | Code Security | -| Cppcheck | [Cppcheck][Cppcheck] | Code Quality | -| CSS | [Biome][Biome] | Code Quality | -| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security | -| GitHub Actions | [actionlint][actionlint] | Code Quality | -| Go | [golangci-lint][golangci-lint] | Code Quality | -| Helm | [Checkov][Checkov] | Code Security | -| Javascript | [Biome][Biome] | Code Quality | -| JSON, JSONC | [Biome][Biome] | Code Quality | -| JSX | [Biome][Biome] | Code Quality | -| Kotlin | [detekt][detekt] | Code Quality | -| Kubernetes | [Checkov][Checkov] | Code Security | -| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking | -| PHP | [PHPStan][PHPStan] | Code Quality | -| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking | -| Java | [PMD][PMD] | Code Quality | -| Protobuf | [Buf][Buf] | Code Quality | -| Python | [Ruff][Ruff] | Code Quality | -| Regal | [Regal][Regal] | Code Quality | -| Ruby | [RuboCop][RuboCop] | Code Quality | -| Semgrep | [Semgrep][Semgrep] | Code Security | -| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality | -| Swift | [SwiftLint][SwiftLint] | Code Quality | -| Terraform | [Checkov][Checkov] | Code Security | -| TSX | [Biome][Biome] | Code Quality | -| Typescript | [Biome][Biome] | Code Quality | -| YAML | [YAMLlint][YAMLlint] | Code Quality | +| Technology | Tools | Category | +| :-------------------------- | :--------------------------------------------------------- | :-------------------------------------------------- | +| All | [Gitleaks][Gitleaks], [Pipeline Remediation][Pipeline] | Code Security, CI/CD | +| CircleCI | [CircleCI][CircleCI], [Pipeline Remediation][Pipeline] | Configuration Validation, CI/CD Failure Remediation | +| CloudFormation | [Checkov][Checkov] | Code Security | +| Cppcheck | [Cppcheck][Cppcheck] | Code Quality | +| CSS | [Biome][Biome] | Code Quality | +| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security | +| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation | +| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation | +| Go | [golangci-lint][golangci-lint] | Code Quality | +| Helm | [Checkov][Checkov] | Code Security | +| Javascript | [Biome][Biome] | Code Quality | +| JSON, JSONC | [Biome][Biome] | Code Quality | +| JSX | [Biome][Biome] | Code Quality | +| Kotlin | [detekt][detekt] | Code Quality | +| Kubernetes | [Checkov][Checkov] | Code Security | +| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking | +| PHP | [PHPStan][PHPStan] | Code Quality | +| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking | +| Java | [PMD][PMD] | Code Quality | +| Protobuf | [Buf][Buf] | Code Quality | +| Python | [Ruff][Ruff] | Code Quality | +| Regal | [Regal][Regal] | Code Quality | +| Ruby | [RuboCop][RuboCop] | Code Quality | +| Semgrep | [Semgrep][Semgrep] | Code Security | +| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality | +| Swift | [SwiftLint][SwiftLint] | Code Quality | +| Terraform | [Checkov][Checkov] | Code Security | +| TSX | [Biome][Biome] | Code Quality | +| Typescript | [Biome][Biome] | Code Quality | +| YAML | [YAMLlint][YAMLlint] | Code Quality | [ShellCheck]: ./shellcheck.md [Ruff]: ./ruff.md @@ -95,3 +96,4 @@ Remove extraneous f prefix [Cppcheck]: ./cppcheck.md [CircleCI]: ./circleci.md [Semgrep]: ./semgrep.md +[Pipeline]: ./pipeline-remediation.md diff --git a/static/img/tools/circle-cicd.png b/static/img/tools/circle-cicd.png new file mode 100644 index 00000000..9af6cf95 Binary files /dev/null and b/static/img/tools/circle-cicd.png differ diff --git a/static/img/tools/docker-build-cicd.png b/static/img/tools/docker-build-cicd.png new file mode 100644 index 00000000..01e6ed58 Binary files /dev/null and b/static/img/tools/docker-build-cicd.png differ diff --git a/static/img/tools/gitlab-advanced-security.png b/static/img/tools/gitlab-advanced-security.png new file mode 100644 index 00000000..94dc3d75 Binary files /dev/null and b/static/img/tools/gitlab-advanced-security.png differ diff --git a/static/img/tools/gitlab-cicd.png b/static/img/tools/gitlab-cicd.png new file mode 100644 index 00000000..0f9c029f Binary files /dev/null and b/static/img/tools/gitlab-cicd.png differ diff --git a/static/img/tools/java-cicd.png b/static/img/tools/java-cicd.png new file mode 100644 index 00000000..b90ec904 Binary files /dev/null and b/static/img/tools/java-cicd.png differ diff --git a/static/img/tools/kubernetes-cicd.png b/static/img/tools/kubernetes-cicd.png new file mode 100644 index 00000000..3b8beb53 Binary files /dev/null and b/static/img/tools/kubernetes-cicd.png differ diff --git a/static/img/tools/npm-cicd.png b/static/img/tools/npm-cicd.png new file mode 100644 index 00000000..f0402362 Binary files /dev/null and b/static/img/tools/npm-cicd.png differ diff --git a/static/img/tools/python-cicd.png b/static/img/tools/python-cicd.png new file mode 100644 index 00000000..cab40924 Binary files /dev/null and b/static/img/tools/python-cicd.png differ diff --git a/static/img/tools/semgrep-cicd.png b/static/img/tools/semgrep-cicd.png new file mode 100644 index 00000000..261cfb5e Binary files /dev/null and b/static/img/tools/semgrep-cicd.png differ diff --git a/static/img/tools/terraform-cicd.png b/static/img/tools/terraform-cicd.png new file mode 100644 index 00000000..ede7a0c2 Binary files /dev/null and b/static/img/tools/terraform-cicd.png differ