docs(settings): document that autoLabelEnabled only gates the base context label#5318
Merged
Conversation
…ntext label autoLabelEnabled had no doc comment and reads like a master label switch. Its only real consumer gates exclusively the single base gittensorLabel context label -- zero effect on TYPE/taxonomy labels (typeLabelsEnabled), moderation/blacklist labels, or review-state labels. This scoping was already documented on the sibling typeLabelsEnabled field and in the yml example, but not on autoLabelEnabled itself, and the dashboard toggle rendered as plain "Auto-label PRs" with no scoping hint -- the most likely place a real maintainer would be misled. Added a doc comment mirroring the existing cross-reference style, and a hint on the dashboard toggle. Docs-only, no behavior change. Refs #5293
Contributor
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
gittensory-ui | 9e39227 | Commit Preview URL Branch Preview URL |
Jul 12 2026, 01:51 PM |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5318 +/- ##
=======================================
Coverage 94.37% 94.37%
=======================================
Files 474 474
Lines 40128 40128
Branches 14631 14631
=======================================
Hits 37871 37871
Misses 1582 1582
Partials 675 675
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
Closed
22 tasks
This was referenced Jul 12, 2026
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
1 participant
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
`autoLabelEnabled` had no doc comment and reads like a master label switch. Its only real consumer gates exclusively the single base `gittensorLabel` context label — zero effect on TYPE/taxonomy labels (`typeLabelsEnabled`), moderation/blacklist labels, or review-state labels. This scoping was already documented on the sibling `typeLabelsEnabled` field and in the yml example, but not on `autoLabelEnabled` itself — and the dashboard toggle rendered as plain "Auto-label PRs" with no scoping hint, the most likely place a real maintainer would be misled.
Scope
Docs-only. `src/types.ts` (doc comment), `maintainer-settings.tsx` (dashboard hint).
Validation
Closes #5293