Fix label naming inconsistency and document workflow migration requirements#6893
Conversation
- Rename review:approved to approval:codeowner to avoid confusion with review/* labels - Add note explaining the distinct prefix to prevent implementor confusion - Document required workflow updates for sync-plugin-docs label migration - Specify exact files and line numbers that need updating Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
| | `approval:codeowner` | Codeowner approved | | ||
|
|
||
| > [!Note] | ||
| > The `approval:codeowner` label uses a distinct prefix (`approval:`) to avoid confusion with the `review/*` labels, which represent **automated review outcomes** from the doc review pipeline. |
There was a problem hiding this comment.
@copilot Why do some use slashes and others use colons?
There was a problem hiding this comment.
The separators follow GitHub label conventions based on their purpose:
Colons (:) = Namespace/category prefixes for organizational grouping:
product:v3-monolith,product:telegrafsource:auto-detected,source:manualwaiting:engineering,approval:codeownerai:tooling,ci:testing
Slashes (/) = Hierarchical state values (GitHub's native pattern for mutually exclusive states):
review/approved,review/changes-requested,review/needs-human
This matches GitHub's own convention (e.g., type/bug, status/in-progress) where slashes indicate "pick one from this set" while colons create organized label families that can be applied together.
Addresses feedback on the document review pipeline implementation plan regarding label taxonomy clarity and migration requirements.
Changes
Label naming: Renamed
review:approved→approval:codeownerto distinguish human approval workflow state from automatedreview/*outcome labelsWorkflow migration requirements: Documented GitHub Actions files requiring updates when migrating
sync-plugin-docs→source:auto-detected.github/workflows/sync-plugins.yml(lines 28, 173, 421).github/ISSUE_TEMPLATE/sync-plugin-docs.yml(line 4)Context
The original plan used both
review:(colon) andreview/(slash) prefixes, which would confuse both humans and automation. The rename creates clear separation:approval:approval:codeownerreview/review/approved,review/changes-requestedThe
sync-plugin-docslabel is actively used in automation workflows that would break silently after label migration without explicit documentation of required updates.💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.