bisect

Automate regression bisection in ClickHouse using CI artifact binaries.

1|Updated Jul 29, 2024
One-click install
npx skills add https://github.com/codacy-open-source-projects-scans/clickhouse --skill bisect
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bisect
Source: https://github.com/codacy-open-source-projects-scans/clickhouse/tree/main/.claude/skills/bisect
Command: npx skills add https://github.com/codacy-open-source-projects-scans/clickhouse --skill bisect

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of identifying the exact commit that introduced a regression in ClickHouse by using a binary search approach with pre-built binaries.

Core Features & Use Cases

  • Automated Regression Bisection: Efficiently pinpoints the commit responsible for a bug.
  • Pre-built Binaries: Leverages CI artifacts to avoid compiling ClickHouse at each step.
  • Use Case: When a new bug is reported in ClickHouse, use this Skill with a reproduction script to automatically find the commit that caused the issue, speeding up the debugging process.

Quick Start

Use the bisect skill to find the commit that introduced a bug using the provided SQL reproduction file.

Frequently Asked Questions about bisect

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find the exact commit that introduced a regression in ClickHouse?

You can find the exact commit that introduced a regression in ClickHouse by running an automated bisection. This process uses a SQL reproduction file to test pre-built master binaries from CI artifacts, performing a binary search across commit history to pinpoint the faulty commit.

What is git bisect and how does it work with pre-built binaries?

Git bisect is a binary search technique used to identify regression-introducing commits. This automation applies bisect by leveraging pre-built ClickHouse master binaries from CI artifacts, avoiding local compilation at each step to rapidly isolate the specific bad commit.

Do I need a SQL reproduction file to start debugging a ClickHouse regression?

Yes, a SQL reproduction file is required to debug a ClickHouse regression. This file acts as the test case to trigger the bug against pre-built binaries during the automated bisect process, allowing the search to verify good and bad commits.

Can I specify custom good and bad Git references to narrow down the bisect search range?

Yes, you can optionally provide good and bad Git references to define the search range. Specifying these commit boundaries narrows the binary search scope, making the regression bisection process faster and more targeted within the commit history.

Why should I use automated regression bisection instead of manually checking commits?

Automated regression bisection is faster than manually checking commits because it leverages pre-built CI artifacts to avoid compiling ClickHouse at each step. It systematically performs a binary search across commit history to isolate the exact commit that introduced the bug.