Skip to content

Commit c4bf2ec

Browse files
Feat/pipeline failure docs (#219)
* add screenshots * adding pipeline remediation tool in * adding more in * use the pictures * fix words * 🎨 pnpm run lint:fix [dependabot skip] * smaller pictures * organize and gtg --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent c9b41be commit c4bf2ec

12 files changed

+200
-31
lines changed

docs/tools/pipeline-remediation.md

+167
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
title: Pipeline Failure Remediation
3+
sidebar_label: Pipeline Remediation
4+
description: CodeRabbit's automated pipeline failure detection and remediation capabilities.
5+
---
6+
7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
13+
## Overview
14+
15+
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.
16+
17+
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.
18+
19+
## Example Remediations
20+
21+
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:
22+
23+
### Docker Build Issues
24+
25+
- Missing build dependencies
26+
- Base image compatibility
27+
- Multi-stage build optimization
28+
- Cache utilization improvements
29+
30+
<img src="/img/tools/docker-build-cicd.png" width="600" alt="Docker Build Remediation" />
31+
32+
### Java Build & Testing
33+
34+
- Maven/Gradle dependency conflicts
35+
- Compilation errors
36+
- Test failures
37+
- Memory allocation issues
38+
39+
<img src="/img/tools/java-cicd.png" width="600" alt="Java Build Remediation" />
40+
41+
### Kubernetes Deployments
42+
43+
- Service configuration validation
44+
- Resource allocation optimization
45+
- Network policy fixes
46+
- Security context remediation
47+
48+
<img src="/img/tools/kubernetes-cicd.png" width="600" alt="Kubernetes Configuration" />
49+
50+
### NPM Package Management
51+
52+
- Package resolution conflicts
53+
- Version compatibility issues
54+
- Security vulnerability patches
55+
- Build script optimization
56+
57+
<img src="/img/tools/npm-cicd.png" width="600" alt="NPM Dependencies" />
58+
59+
### Python Environment
60+
61+
- Package dependency resolution
62+
- Virtual environment setup
63+
- Test framework configuration
64+
- Code style compliance
65+
66+
<img src="/img/tools/python-cicd.png" width="600" alt="Python Build Issues" />
67+
68+
### Security Scanning
69+
70+
- SAST finding remediation
71+
- Code injection prevention
72+
- Security best practices
73+
- Compliance validation
74+
75+
<img src="/img/tools/semgrep-cicd.png" width="600" alt="Security Scan Results" />
76+
77+
### Terraform and Infrastructure as Code
78+
79+
- Resource configuration validation
80+
- State management issues
81+
- Provider compatibility
82+
- Security group optimization
83+
84+
<img src="/img/tools/terraform-cicd.png" width="600" alt="Terraform Configuration" />
85+
86+
## Supported Platforms
87+
88+
### GitHub Actions
89+
90+
- Automatic detection of workflow failures
91+
- Inline fixes for common build issues
92+
- Integration with GitHub Checks
93+
- Support for custom actions and workflows
94+
95+
### GitLab CI/CD
96+
97+
- Pipeline failure analysis
98+
- Integration with GitLab Advanced Security
99+
- Support for DAST (Dynamic Application Security Testing) findings
100+
- Remediation for SAST (Static Application Security Testing) issues
101+
102+
<img src="/img/tools/gitlab-cicd.png" width="600" alt="GitLab CI/CD" />
103+
104+
<img src="/img/tools/gitlab-advanced-security.png" width="600" alt="GitLab Security Integration" />
105+
106+
### CircleCI
107+
108+
- Workflow failure detection
109+
- Job-level error analysis
110+
- Configuration validation
111+
- Dependency resolution
112+
113+
<img src="/img/tools/circle-cicd.png" width="600" alt="CircleCI Integration" />
114+
115+
## Common Use Cases
116+
117+
Our tool handles a wide range of pipeline failures including:
118+
119+
### Build Failures
120+
121+
- Docker build issues
122+
- Node.js dependency conflicts
123+
- Java compilation errors
124+
- Python package resolution
125+
- Go module management
126+
127+
### Infrastructure as Code
128+
129+
- Kubernetes manifest validation
130+
- Terraform template errors
131+
- CloudFormation stack issues
132+
- Ansible playbook failures
133+
134+
### Security Pipeline Integration
135+
136+
- SAST finding remediation
137+
- DAST vulnerability fixes
138+
- Dependency scanning
139+
- Container security
140+
141+
### Testing Failures
142+
143+
- Unit test failures
144+
- Integration test errors
145+
- End-to-end test issues
146+
- Performance test threshold violations
147+
148+
## How It Works
149+
150+
1. **Detection**: CodeRabbit monitors your pipeline runs and automatically detects failures
151+
2. **Analysis**: Our AI analyzes the failure logs and context to determine the root cause
152+
3. **Remediation**: We provide inline suggestions and automated fixes where possible
153+
4. **Learning**: The system learns from successful fixes to improve future recommendations
154+
155+
## Best Practices
156+
157+
1. **Keep Dependencies Updated**: Regular dependency updates help prevent build failures
158+
2. **Use Lock Files**: Lock files ensure consistent builds across environments
159+
3. **Implement Caching**: Proper caching strategies speed up builds and reduce failures
160+
4. **Monitor Resource Usage**: Ensure sufficient resources are allocated to prevent timeouts
161+
5. **Maintain Clean Tests**: Well-maintained tests reduce false positives
162+
163+
## Links
164+
165+
- [GitHub Actions Configuration](https://docs.github.com/en/actions)
166+
- [GitLab CI/CD Documentation](https://docs.gitlab.com/ee/ci/)
167+
- [CircleCI Documentation](https://circleci.com/docs/)

docs/tools/tools.md

+33-31
Original file line numberDiff line numberDiff line change
@@ -42,37 +42,38 @@ Remove extraneous f prefix
4242

4343
## Supported Tools
4444

45-
| Technology | Tools | Category |
46-
| :-------------------------- | :--------------------------------------------------------- | :----------------------------- |
47-
| All | [Gitleaks][Gitleaks] | Code Security |
48-
| CircleCI | [CircleCI][CircleCI] | Configuration Validation |
49-
| CloudFormation | [Checkov][Checkov] | Code Security |
50-
| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
51-
| CSS | [Biome][Biome] | Code Quality |
52-
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
53-
| GitHub Actions | [actionlint][actionlint] | Code Quality |
54-
| Go | [golangci-lint][golangci-lint] | Code Quality |
55-
| Helm | [Checkov][Checkov] | Code Security |
56-
| Javascript | [Biome][Biome] | Code Quality |
57-
| JSON, JSONC | [Biome][Biome] | Code Quality |
58-
| JSX | [Biome][Biome] | Code Quality |
59-
| Kotlin | [detekt][detekt] | Code Quality |
60-
| Kubernetes | [Checkov][Checkov] | Code Security |
61-
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
62-
| PHP | [PHPStan][PHPStan] | Code Quality |
63-
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
64-
| Java | [PMD][PMD] | Code Quality |
65-
| Protobuf | [Buf][Buf] | Code Quality |
66-
| Python | [Ruff][Ruff] | Code Quality |
67-
| Regal | [Regal][Regal] | Code Quality |
68-
| Ruby | [RuboCop][RuboCop] | Code Quality |
69-
| Semgrep | [Semgrep][Semgrep] | Code Security |
70-
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
71-
| Swift | [SwiftLint][SwiftLint] | Code Quality |
72-
| Terraform | [Checkov][Checkov] | Code Security |
73-
| TSX | [Biome][Biome] | Code Quality |
74-
| Typescript | [Biome][Biome] | Code Quality |
75-
| YAML | [YAMLlint][YAMLlint] | Code Quality |
45+
| Technology | Tools | Category |
46+
| :-------------------------- | :--------------------------------------------------------- | :-------------------------------------------------- |
47+
| All | [Gitleaks][Gitleaks], [Pipeline Remediation][Pipeline] | Code Security, CI/CD |
48+
| CircleCI | [CircleCI][CircleCI], [Pipeline Remediation][Pipeline] | Configuration Validation, CI/CD Failure Remediation |
49+
| CloudFormation | [Checkov][Checkov] | Code Security |
50+
| Cppcheck | [Cppcheck][Cppcheck] | Code Quality |
51+
| CSS | [Biome][Biome] | Code Quality |
52+
| Docker | [Hadolint][Hadolint], [Checkov][Checkov] | Code Quality, Code Security |
53+
| GitHub Actions | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation |
54+
| GitLab Pipelines | [Pipeline Remediation][Pipeline] | CI/CD Failure Remediation |
55+
| Go | [golangci-lint][golangci-lint] | Code Quality |
56+
| Helm | [Checkov][Checkov] | Code Security |
57+
| Javascript | [Biome][Biome] | Code Quality |
58+
| JSON, JSONC | [Biome][Biome] | Code Quality |
59+
| JSX | [Biome][Biome] | Code Quality |
60+
| Kotlin | [detekt][detekt] | Code Quality |
61+
| Kubernetes | [Checkov][Checkov] | Code Security |
62+
| Markdown | [markdownlint][markdownlint], [LanguageTool][LanguageTool] | Code Quality, Grammar Checking |
63+
| PHP | [PHPStan][PHPStan] | Code Quality |
64+
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
65+
| Java | [PMD][PMD] | Code Quality |
66+
| Protobuf | [Buf][Buf] | Code Quality |
67+
| Python | [Ruff][Ruff] | Code Quality |
68+
| Regal | [Regal][Regal] | Code Quality |
69+
| Ruby | [RuboCop][RuboCop] | Code Quality |
70+
| Semgrep | [Semgrep][Semgrep] | Code Security |
71+
| Shell (sh, bash, ksh, dash) | [ShellCheck][ShellCheck] | Code Quality |
72+
| Swift | [SwiftLint][SwiftLint] | Code Quality |
73+
| Terraform | [Checkov][Checkov] | Code Security |
74+
| TSX | [Biome][Biome] | Code Quality |
75+
| Typescript | [Biome][Biome] | Code Quality |
76+
| YAML | [YAMLlint][YAMLlint] | Code Quality |
7677

7778
[ShellCheck]: ./shellcheck.md
7879
[Ruff]: ./ruff.md
@@ -95,3 +96,4 @@ Remove extraneous f prefix
9596
[Cppcheck]: ./cppcheck.md
9697
[CircleCI]: ./circleci.md
9798
[Semgrep]: ./semgrep.md
99+
[Pipeline]: ./pipeline-remediation.md

static/img/tools/circle-cicd.png

270 KB
Loading
254 KB
Loading
223 KB
Loading

static/img/tools/gitlab-cicd.png

283 KB
Loading

static/img/tools/java-cicd.png

139 KB
Loading

static/img/tools/kubernetes-cicd.png

212 KB
Loading

static/img/tools/npm-cicd.png

139 KB
Loading

static/img/tools/python-cicd.png

226 KB
Loading

static/img/tools/semgrep-cicd.png

211 KB
Loading

static/img/tools/terraform-cicd.png

235 KB
Loading

0 commit comments

Comments
 (0)