Explain CI
Version updated for https://github.com/gopalcnepal/explain-ci to version v1.
- This action is used across all versions by ? repositories.
Action Type
This is a Composite action.
Go to the GitHub Marketplace to find the latest changes.
Action Summary
The “Explain CI” GitHub Action automates the process of analyzing and explaining failed GitHub Actions jobs by reading failure logs, identifying key error sections, and generating concise, plain-English explanations using an OpenAI-compatible language model. It posts these explanations as comments on pull requests or commits, helping developers quickly understand and address issues without manually parsing complex logs. This action streamlines CI/CD workflows by saving time and improving error visibility.
Release notes
Explain CI helps developers understand failing GitHub Actions workflows instantly.
Key Features:
- Instant Explanations: AI-powered analysis of failed job logs in plain English
- Multi-Provider Support: OpenAI, Claude, Gemini, Mistral, xAI (Grok), and any OpenAI-compatible endpoint
- Smart Commenting: Posts explanations directly on PRs or commits
- Duplicate Prevention: Intelligently avoids duplicate comments on PRs
- Separate Job Pattern: Secure, reliable execution as a dedicated workflow job
What’s in v1:
- Robust failure detection supporting in-progress jobs
- Comprehensive security with automatic API key masking
- Full documentation with practical examples for all providers
- Support for self-hosted LLM endpoints (Ollama, Azure, custom servers)
Requires: actions: read, contents: write, pull-requests: write permissions
Perfect for teams that want to save time debugging CI failures!