Skip to content

ci: auto-label issues by bug / feature / performance#7727

Merged
Xuanwo merged 3 commits into
lance-format:mainfrom
wjones127:wjones/issue-templates
Jul 13, 2026
Merged

ci: auto-label issues by bug / feature / performance#7727
Xuanwo merged 3 commits into
lance-format:mainfrom
wjones127:wjones/issue-templates

Conversation

@wjones127

@wjones127 wjones127 commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Labeling incoming issues by hand as bug / feature / performance is tedious. This applies the label automatically through three complementary layers, so it works no matter how an issue is opened. The aim is reliable labeling, not enforcing issue structure.

1. Issue templates (web UI)

Templates under .github/ISSUE_TEMPLATE/, each auto-applying its label:

  • Bug reportbug — a light form: description, reproduction, Lance version, language binding (env and logs optional).
  • Feature requestfeature — free-form.
  • Performance issueperformance — free-form.

config.yml keeps blank issues enabled and routes usage questions to Discord.

2. Content-based labeler (everything else)

Templates only fire for the web-UI chooser. Issues opened via gh issue create, the REST API, or an agent bypass them and land unlabeled. .github/workflows/issue-labeler.yml closes that gap: it runs srvaroa/labeler (the same pinned action the PR labeler uses) on issues events, keyed by .github/labeler-issues.yml.

  • Primary signal: a leading marker in the title (bug:, [feature], perf -, …), which people commonly type by hand.
  • Fallback: body keywords (panic/crash → bug, regression/OOM → performance, …).
  • Unmatched issues get no label and are left for human triage rather than guessed at. appendOnly means it never strips a template/human label and is idempotent on edit.

3. Agent contract (AGENTS.md)

A template can't bind an agent, so AGENTS.md now instructs agents to pass an explicit --label bug|feature|performance (and prefix the title) when opening issues.

Notes

  • Templates can't be previewed from a diff — worth clicking through the "New issue" chooser on a fork before merging.
  • Left blank issues enabled so no one is forced through a template.
  • A future refinement could add an LLM classify step in the labeler workflow for the unmatched residual; out of scope here.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added structured templates for bug, feature, and performance issue reports.
    • Added guidance for filing issues, including recommended labels and title prefixes.
  • Chores
    • Enabled automatic issue labeling based on titles and descriptions.
    • Added a contact link directing usage questions to the community Discord.
    • Enabled blank issue creation.

Adds issue forms under `.github/ISSUE_TEMPLATE/` that route new issues to the
`bug`, `feature`, and `performance` labels automatically, so triage no longer
depends on hand-labeling. Each form collects the fields we routinely ask for
(Lance version, language binding, environment, reproduction), and `config.yml`
points usage questions to Discord.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Adds structured GitHub issue templates and contact guidance, configures title- and body-based automatic labeling for issue events, and documents label and title conventions for issues created through the CLI or API.

Changes

Issue management

Layer / File(s) Summary
Structured issue intake
.github/ISSUE_TEMPLATE/*
Adds bug, feature request, and performance templates with classification labels and structured reporting prompts; enables blank issues and links usage questions to Discord.
Automatic issue classification
.github/labeler-issues.yml, .github/workflows/issue-labeler.yml, AGENTS.md
Adds append-only title/body labeling rules, runs them on opened or edited issues with per-issue concurrency, and documents matching labels and title prefixes for CLI/API-created issues.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Reporter
  participant GitHubIssues
  participant IssueLabelerWorkflow
  participant IssueLabelerConfig
  Reporter->>GitHubIssues: Create or edit issue
  GitHubIssues->>IssueLabelerWorkflow: Emit opened or edited event
  IssueLabelerWorkflow->>IssueLabelerConfig: Apply title and body rules
  IssueLabelerConfig-->>GitHubIssues: Add matching labels
Loading
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: automatic issue labeling for bug, feature, and performance reports.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added A-ci CI / build workflows ci Github Action or Test issues labels Jul 10, 2026
…ract

The ISSUE_TEMPLATE forms only label issues opened through the web UI. Issues
filed via `gh issue create`, the REST API, or an agent bypass templates and
land unlabeled.

Add a content-based labeler (srvaroa/labeler, reusing the pinned action from
the PR labeler) that runs on `issues` events and applies bug/feature/
performance from a leading title marker (e.g. `bug:`, `[feature]`), with body
keywords as a secondary fallback. Unmatched issues get no label and are left
for human triage rather than guessed at; `appendOnly` stacks harmlessly with
template labels.

Also document in AGENTS.md that agents should pass an explicit `--label` when
opening issues, since that path bypasses the templates.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@wjones127 wjones127 changed the title ci: add GitHub issue templates for bug, feature, and performance ci: auto-label issues by bug / feature / performance Jul 10, 2026
The goal is reliable labeling, not enforcing structure. Keep the bug report as
a form (repro, version, bindings are worth prompting for) but convert the
feature and performance templates to free-form Markdown templates that still
apply their label via front matter.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@wjones127
wjones127 marked this pull request as ready for review July 10, 2026 18:25
@wjones127
wjones127 requested review from Xuanwo and westonpace July 10, 2026 18:25

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/config.yml:
- Around line 3-4: Update the “Question / usage help” link in the issue template
to use the same Discord invite URL referenced by CONTRIBUTING.md, replacing the
stale or inconsistent invite.

In @.github/workflows/issue-labeler.yml:
- Around line 18-29: Add a top-level permissions: {} block for defense-in-depth,
and add a brief explanatory comment above the existing job-level permissions in
the label job clarifying that issues: write is intentionally scoped to the
labeler action.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 7eb3ea94-72f1-4b73-9e20-4ef1221e6b7a

📥 Commits

Reviewing files that changed from the base of the PR and between 1aec146 and 1e7418e.

📒 Files selected for processing (7)
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/feature_request.md
  • .github/ISSUE_TEMPLATE/performance_issue.md
  • .github/labeler-issues.yml
  • .github/workflows/issue-labeler.yml
  • AGENTS.md

Comment thread .github/ISSUE_TEMPLATE/config.yml
Comment thread .github/workflows/issue-labeler.yml

@Xuanwo Xuanwo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

@Xuanwo
Xuanwo merged commit 4318ea0 into lance-format:main Jul 13, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-ci CI / build workflows ci Github Action or Test issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants