Forem: Xianpeng Shen

Thank you for sharing the Conventional Branch.

Xianpeng Shen — Tue, 16 Sep 2025 13:05:31 +0000

Louis Liu

Mar 26 '25

From Conventional Commits to Conventional Branch

#programming #git #github

Comments

3 min read

New Jenkins Plugin: Let AI Explain Your Build Failures

Xianpeng Shen — Fri, 01 Aug 2025 18:00:49 +0000

Recently, I released my first-ever Jenkins plugin – and it's now officially available in the Jenkins Center! 🎉

This plugin makes it possible to analyze build errors with AI directly inside Jenkins, so you no longer need to copy and paste logs into ChatGPT or other tools. Instead, you'll see an "Explain Error" button right in the console output, and you can also use the explainError() step in your pipeline to trigger AI analysis automatically when a build fails.

This is my first contribution to the Jenkins plugin ecosystem. I used to think most things could be handled by pipeline scripts, and there wasn’t much need for custom plugins. But as AI becomes increasingly mainstream, I noticed something surprising: Jenkins still didn’t have a plugin for AI-based error explanation. So, I decided to build one myself.

With the help of AI and some late-night coding sessions, along with several rounds of thorough code review from the Jenkins Hosting team, the plugin finally went live last weekend. 🚀

Introducing the Plugin

Explain Error Plugin is an OpenAI-powered Jenkins plugin that can automatically analyze logs from failed builds and generate easy-to-understand explanations. It works with both Pipeline and Freestyle job types.

GitHub repo: https://github.com/jenkinsci/explain-error-plugin

Demo

👉 Watch the hands-on demo on YouTube — setup, run, and see how AI explains your Jenkins job failures.

Key Features

Feature	Description
✅ One-click console error explanation	Adds an “Explain Error” button to the build log view
✅ Pipeline support	Use `explainError()` in your pipeline scripts
✅ Custom model support	Choose GPT-3.5 or other models
✅ Jenkins CasC compatible	Supports Configuration as Code
✅ Log filtering	Use regex patterns to focus on error content

Requirements

Jenkins version ≥ 2.479.3
Java version ≥ 17
An OpenAI API key (you can get one at OpenAI)

How to Install

Go to Manage Jenkins → Manage Plugins → Available, then search for:

“Explain Error Plugin”

And install it like any other Jenkins plugin.

Configuration

Once installed, head to Manage Jenkins → Configure System and scroll to Explain Error Plugin Configuration to enter your OpenAI settings.

Setting	Description	Default
Enable Explanation	Enable/disable AI explanation	✅ Enabled
API Key	Your OpenAI API key	Required
API URL	OpenAI endpoint	`https://api.openai.com/v1/chat/completions`
AI Model	Model to use	`gpt-3.5-turbo`

Prefer managing Jenkins with Configuration as Code? You can configure it like this:

unclassified:
  explainError:
    enableExplanation: true
    apiKey: "${AI_API_KEY}"
    apiUrl: "https://api.openai.com/v1/chat/completions"
    model: "gpt-3.5-turbo"

How to Use It

In Your Pipeline

Best used in a post { failure { ... } } block so it automatically analyzes failures:

post {
  failure {
    explainError()
  }
}

You can also customize how logs are filtered:

explainError(
  maxLines: 500,
  logPattern: '(?i)(error|failed|exception)'
)

In Console Output

This works for any job type:

Go to the console output of a failed build
Click the “Explain Error” button at the top
The AI-generated explanation will appear below the button

Demo Preview

When a build fails, you’ll see a sidebar entry on the build page where the AI explanation will be shown:

Or you can view the explanation directly on the console page after clicking the “Explain Error” button:

What’s Next

Error caching: Avoid redundant API calls for the same errors (already implemented, pending merge)
Multi-model support: Plan to support other AI services like Gemini, Claude, DeepSeek, etc.

More features are under development or in the idea phase — and your feedback is always welcome!

Final Thoughts

The plugin is 100% open source — contributions and suggestions are very welcome!

If you try the plugin and find it useful, feel free to share this article, or give the project a ⭐ on GitHub:

GitHub: https://github.com/jenkinsci/explain-error-plugin

That’s the best way to support open-source work like this. 🙌

C/C++ Lint Action | clang-format & clang-tidy

Xianpeng Shen — Fri, 26 Nov 2021 13:49:33 +0000

My Workflow

A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of thread comments and/or annotations.

Submission Category:

Maintainer Must-Haves

Yaml File or Link to Code

cpp-linter / cpp-linter-action

A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of file-annotations, thread-comments, workflow step-summary, and Pull Request reviews.

C/C++ Linter Action ^{| clang-format & clang-tidy}

A Github Action for linting C/C++ code integrating clang-tidy and clang-format to collect feedback provided in the form of file-annotations, thread-comments workflow step-summary, and Pull Request reviews (with tidy-review or format-review).

Usage

Create a new GitHub Actions workflow in your project, e.g. at .github/workflows/cpp-linter.yml

The content of the file should be in the following format.

    steps:
      - uses: actions/checkout@v5
      - uses: cpp-linter/cpp-linter-action@v2
        id: linter
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          style: 'file'  # Use .clang-format config file
          tidy-checks: '' # Use .clang-tidy config file
          # only 'update' a single comment in a pull request thread.
          thread-comments: ${{ github.event_name == 'pull_request' && 'update' }}
      - name: Fail fast?!
        if: steps.linter.outputs.checks-failed > 0
        run: exit 1

For all explanations of our available input parameters and…

View on GitHub

cpp-linter.yml

name: cpp-linter

on:
  pull_request:
    types: [opened, reopened]  # let PR-synchronize events be handled by push events
  push:

jobs:
  cpp-linter:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: cpp-linter/cpp-linter-action@v2
        id: linter
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          style: file

      - name: Fail fast?!
        if: steps.linter.outputs.checks-failed > 0
        run: |
          echo "Some files failed the linting checks!"
        # for actual deployment
        # run: exit 1

Additional Resources / Info

https://cpp-linter.github.io/cpp-linter-action/

Example

Annotations

Thread Comment