ci: add brand-name check for 'VelaClaw' in Markdown - #637
Closed
tanghao-xiaomi wants to merge 1 commit into
Closed
Conversation
Add a lightweight PR check that fails when the CamelCase brand form
'VelaClaw' appears in any Markdown file. The convention is to use
'openvelaClaw' (lowercase 'openvela' prefix, capital 'C') as the brand
name in prose, to reduce trademark risk.
The check is intentionally case-sensitive and does NOT flag:
- lowercase code identifiers: velaclaw, @system.velaclaw,
velaclaw_client_open, velaclaw_ask (real framework APIs)
- uppercase macro: VELACLAW_DAEMON (real Kconfig / macro name)
Note: this check depends on the brand rename in open-vela#636 being merged
first. Otherwise the base branch's existing 'VelaClaw' occurrences
would cause subsequent PRs to fail.
Collaborator
Author
|
Superseded by #638, which combines the rename and the CI check into a single PR. Closing this one. |
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
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
Add a lightweight PR check that fails when the CamelCase brand form
VelaClawappears in any Markdown file. The convention is to useopenvelaClaw(lowercaseopenvelaprefix, capitalC) as the brand name in prose, to reduce trademark risk.The check is intentionally case-sensitive and does not flag the following, which are real framework API / macro names and must remain unchanged:
velaclaw,@system.velaclaw,velaclaw_client_open,velaclaw_askVELACLAW_DAEMONBehavior
pull_request(opened / reopened / synchronize).*.mdfiles with a plain case-sensitivegrep.::error file=...,line=...annotations pointing at each offending line, prints a summary that names the allowed form and the identifiers that are intentionally exempt, and fails the job.OKline and passes.Scope
.github/workflows/brand-name-check.ymlThis check depends on #636 (the brand rename in
mini_memo_guide.md) being merged first. If this workflow lands before #636, every subsequent PR againstdev-ai-contest-2026would fail this check because the base branch still contains the 18VelaClawoccurrences that #636 removes.Suggested sequencing: