feat(ci): smart PR labeler with type, size, module, complexity detection#148
Open
Yuvraj-Sarathe wants to merge 3 commits into
Open
feat(ci): smart PR labeler with type, size, module, complexity detection#148Yuvraj-Sarathe wants to merge 3 commits into
Yuvraj-Sarathe wants to merge 3 commits into
Conversation
- Add prLabels config to kdm-automation.json with label definitions and module path mappings - Rewrite pr-labeler.cjs: title-based type detection, size calculation from additions/deletions, module detection from file paths, complexity scoring - Refactor pr-labeler.cjs to use shared helpers (buildBotContext, addLabels) - Add validatePrLabels() to config-loader.cjs for config validation - Fix helper require() calls to use .cjs extension (Node.js v24 compat) - Add LABELS.md documenting the complete label system
github-actions
Bot
added
the
documentation
Contributor
|
Warning Review limit reached
More reviews will be available in 39 minutes and 17 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (8)
Warning
|
| Layer / File(s) | Summary |
|---|---|
Label taxonomy configuration and documentation .github/kdm-automation.json, .github/LABELS.md |
The prLabels configuration section maps label values for type, size, module, and complexity categories, plus path-to-module glob assignments. LABELS.md documents how the labeler derives each label type using thresholds and heuristics for reviewer reference. |
Label configuration validation .github/scripts/helpers/config-loader.cjs |
Adds validatePrLabels() to validate the optional prLabels config structure, including type/size/module/complexity shape checks, required string-prefix formats, and cross-referencing of modulePaths values against known modules. |
Helper module extension consistency .github/scripts/helpers/api.cjs, .github/scripts/helpers/checks.cjs, .github/scripts/helpers/comments.cjs, .github/scripts/helpers/constants.cjs, .github/scripts/helpers/index.cjs |
All local module imports updated to explicitly require .cjs-suffixed file extensions instead of extensionless paths for consistent module resolution. |
PR labeler detection and determination functions .github/scripts/pr-labeler.cjs |
Rewritten from fixed path-based rules into a configurable system. New functions: detectType() classifies PR type from title patterns; determineSize() maps total changes to size buckets; detectModules() matches changed files against configured glob patterns; matchGlobPattern() provides custom glob-to-regex matching; calculateComplexity() computes a heuristic score; determineComplexity() maps scores to complexity tiers. The main labelPR() function loads config, fetches PR details via GitHub API, applies all detection functions, collects labels, and applies them via addLabels(). |
Estimated code review effort
🎯 4 (Complex) | ⏱️ ~60 minutes
Possibly related issues
- [Feature]: Introduce a Unique PR Identity & Smart Labeling System #107: Implements a configurable PR auto-labeler with smart detection of PR type, size, module, and complexity labels as requested.
Possibly related PRs
- KDM-cli/kdm-cli#33: Updates workflow to run
./.github/scripts/pr-labeler.cjsdirectly, which is the labeler being rewritten in this PR. - KDM-cli/kdm-cli#32: Switches workflow to run a JS labeler script, setting up the execution context for the labeler logic implemented in this PR.
Suggested labels
ci/cd
Suggested reviewers
- utkarsh232005
- codescene-delta-analysis
Poem
🐰 A labeler rabbit hops through PR tides,
Sniffing titles, files, and code-change sizes,
Complexity scores and module guides,
Smart tags applied—automation surprises! ✨
🚥 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 accurately summarizes the main change: a rewrite of pr-labeler.cjs implementing smart PR labeling with type, size, module, and complexity detection based on configuration. It is concise, clear, and directly reflects the substantial work in the PR. |
| 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. |
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
✨ Finishing Touches
🧪 Generate unit tests (beta)
- Create PR with unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands and usage tips.
Member
Author
|
Solves Issue #148 |
![codescene-delta-analysis[bot]](https://avatars.githubusercontent.com/in/53921?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Nitpick comments (2)
.github/scripts/helpers/config-loader.cjs (1)
318-320: 💤 Low valueUse
inoperator for more robust property checking.The condition
!pr.module[moduleName]uses a truthy check, which could incorrectly flag keys with falsy values (though the label format validation prevents empty strings). Using!(moduleName in pr.module)is more explicit and idiomatic for checking property existence.♻️ Proposed refactor
- if (typeof moduleName === 'string' && pr.module && !pr.module[moduleName]) { + if (typeof moduleName === 'string' && pr.module && !(moduleName in pr.module)) { errors.push(`prLabels.modulePaths["${pattern}"] references unknown module "${moduleName}"`); }🤖 Prompt for 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. In @.github/scripts/helpers/config-loader.cjs around lines 318 - 320, Replace the truthy property check used in the condition that validates moduleName existence and use the `in` operator instead: in the block where you check `if (typeof moduleName === 'string' && pr.module && !pr.module[moduleName])` change the existence test to `!(moduleName in pr.module)` so the condition becomes `if (typeof moduleName === 'string' && pr.module && !(moduleName in pr.module))`; keep the same error push using `pattern` and `moduleName`..github/kdm-automation.json (1)
127-127: src/ →module: clifallback is intentional (and documented)**
detectModulescollects all matchingprLabels.modulePathsentries (deduped), so any changedsrc/**file will addmodule: cliin addition to any more specific module matches.- This “fallback” is explicitly documented in
.github/LABELS.mdundermodule: cli(src/**(fallback)).- Because
matchedModules.lengthdrives both the complexity score and themulti-moduleindicator, the catch-allclican increase those counts; consider making the fallback apply only when no other non-climodule matched if label noise becomes a concern.🤖 Prompt for 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. In @.github/kdm-automation.json at line 127, detectModules currently adds the catch-all "module: cli" for any src/** change which inflates matchedModules and multi-module/complexity metrics; update the detection logic in detectModules (which reads prLabels.modulePaths and builds matchedModules) to dedupe as it does now but then, if matchedModules contains more than one entry and includes the "cli" module, remove "cli" so it only remains when it is the sole match; ensure the same adjusted matchedModules is used downstream for complexity scoring and multi-module determination.
🤖 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/LABELS.md:
- Line 4: The relative path to the pr-labeler script in LABELS.md is wrong;
update the two occurrences of "../.github/scripts/pr-labeler.cjs" to
"scripts/pr-labeler.cjs" so the link correctly points from LABELS.md to
pr-labeler.cjs under the same .github directory (apply the change at both
locations referenced in the diff).
In @.github/scripts/helpers/config-loader.cjs:
- Around line 297-310: The complexity validation loop currently checks only
label; extend it to validate entry.maxScore: for keys 'easy' and 'medium' ensure
entry.maxScore is a finite number (typeof === 'number' and isFinite) and for
'complex' allow either a finite number or null (explicitly check === null),
pushing descriptive errors to errors (e.g.
prLabels.complexity["${key}"].maxScore must be a number or null) when the check
fails; reference the pr.complexity object, the compKeys loop and the
determineComplexity() usage so the validation prevents runtime errors.
- Around line 297-310: The complexity validation currently checks only that each
complexity entry has a label but doesn't enforce ascending thresholds required
by determineComplexity(); update the validation in the pr.complexity block to
verify that entry.maxScore for 'easy' and 'medium' are numbers, that
easy.maxScore < medium.maxScore, and that complex.maxScore is null (or omitted)
— push corresponding error messages into errors when types or ordering violate
this (reference pr.complexity, compKeys, each entry, and determineComplexity()
to locate where to add the checks).
- Around line 273-286: The size label validation in the pr.size loop (inside
config-loader.cjs) currently only checks entry.label but not entry.maxChanges,
so add validation that entry.maxChanges is a finite number for keys
'xs','s','m','l' and is either a finite number or null for 'xl' (or whatever key
you expect to allow null), and push an error to errors with a clear message when
the value is invalid; update the loop that iterates sizeKeys (and reference
pr.size[key] / entry.maxChanges) to perform typeof/Number.isFinite checks (or
allow null for the XL case) so determineSize() numeric comparisons won't receive
non-numeric types.
- Around line 273-286: Add validation to the existing pr.size block to ensure
numeric thresholds are strictly ascending to match determineSize's assumptions:
after reading entries for sizeKeys (xs, s, m, l, xl) check that for keys
xs→s→m→l each entry.maxChanges is a finite number and strictly less than the
next key's maxChanges, and require xl.maxChanges to be null; push descriptive
errors to errors (e.g., `prLabels.size["xs"].maxChanges must be <
prLabels.size["s"].maxChanges`) when any check fails. Use the same symbols found
in the diff (pr.size, sizeKeys, entry, entry.maxChanges) so the validation sits
next to the existing label checks.
In @.github/scripts/helpers/index.cjs:
- Around line 8-13: The helper index currently requires modules without the .cjs
extension (constants, logger, validation, api, checks, comments), which fails
under Node’s extensionless resolution for this folder; update each require call
in the helpers index (the statements that reference constants, logger,
validation, api, checks, comments) to append “.cjs” (e.g.,
require('./constants.cjs'), require('./logger.cjs'), etc.), and make equivalent
fixes in other scripts mentioned (bot-inactivity-comments.cjs,
bot-on-pr-merged.cjs, bot-inactivity.cjs) so every require('./helpers...') or
require('./helpers/<name>') uses the .cjs filename explicitly.
In @.github/scripts/pr-labeler.cjs:
- Around line 224-230: The PR file listing only requests one page (per_page:
100) using github.rest.pulls.listFiles, so files is incomplete for large PRs and
breaks downstream detectModules(files, ...) and
calculateComplexity(files.length, ...); update the code to paginate through all
pages (e.g., use github.paginate or loop over pages calling
github.rest.pulls.listFiles with page) to accumulate all file entries into files
before calling detectModules and calculateComplexity, ensuring resp and files
are merged/concatenated across pages and handling the full result set.
---
Nitpick comments:
In @.github/kdm-automation.json:
- Line 127: detectModules currently adds the catch-all "module: cli" for any
src/** change which inflates matchedModules and multi-module/complexity metrics;
update the detection logic in detectModules (which reads prLabels.modulePaths
and builds matchedModules) to dedupe as it does now but then, if matchedModules
contains more than one entry and includes the "cli" module, remove "cli" so it
only remains when it is the sole match; ensure the same adjusted matchedModules
is used downstream for complexity scoring and multi-module determination.
In @.github/scripts/helpers/config-loader.cjs:
- Around line 318-320: Replace the truthy property check used in the condition
that validates moduleName existence and use the `in` operator instead: in the
block where you check `if (typeof moduleName === 'string' && pr.module &&
!pr.module[moduleName])` change the existence test to `!(moduleName in
pr.module)` so the condition becomes `if (typeof moduleName === 'string' &&
pr.module && !(moduleName in pr.module))`; keep the same error push using
`pattern` and `moduleName`.
🪄 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: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 11dce551-bd95-47fd-90df-a7d67dc6927f
📒 Files selected for processing (9)
.github/LABELS.md.github/kdm-automation.json.github/scripts/helpers/api.cjs.github/scripts/helpers/checks.cjs.github/scripts/helpers/comments.cjs.github/scripts/helpers/config-loader.cjs.github/scripts/helpers/constants.cjs.github/scripts/helpers/index.cjs.github/scripts/pr-labeler.cjs
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Our agent can fix these. Install it.
No application code in the PR — skipped Code Health checks.
Quality Gate Profile: The Bare Minimum
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.
Member
Author
|
All done @utkarsh232005 |
Member
|
can you provide any tested automation labeling pr ss? |
Member
Author
you'll have to wait till tomorrow |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Release Notes
New Features
Documentation
Chores