Skip to content

[Internal] PRLint: Refactors regex failure comment format in prlint.yml#5893

Merged
yash2710 merged 2 commits into
mainfrom
users/trivediyash/prlint
May 21, 2026
Merged

[Internal] PRLint: Refactors regex failure comment format in prlint.yml#5893
yash2710 merged 2 commits into
mainfrom
users/trivediyash/prlint

Conversation

@yash2710
Copy link
Copy Markdown
Contributor

Description

Updated the comment format for regex failure messages and examples in the PR lint workflow.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

Closing issues

Changelog

  • I have added a changelog entry under ### Unreleased in changelog.md
    for the user-facing impact of this change.
  • No changelog entry is required because this PR is one of:
    documentation-only, test-only, CI / build-only, or a pure internal refactor
    with no observable customer impact.

If the second box is checked, briefly justify here:

Internal CI comment changes for build error clarity

Updated the comment format for regex failure messages and examples in the PR lint workflow.
Copy link
Copy Markdown
Member

@kushagraThapar kushagraThapar left a comment

Choose a reason for hiding this comment

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

Nice cleanup — switching from > + <br /> to | is much more readable. Two small follow-ups I'd suggest folding into this PR, since they're in the same lines and would deliver the full "comment now renders cleanly on GitHub" outcome:

  1. Drop the backslash escapes in \"[Internal] Category: ...\". Backslash escapes (\") are only interpreted inside YAML double-quoted strings — in | (or >) block scalars they pass through literally, so the rendered comment shows \"…\" with visible backslashes. Either remove the backslashes ("[Internal] Category: ...") or wrap the format spec in backticks for inline-code rendering.

  2. Wrap the regex in backticks so GitHub Markdown doesn't try to interpret characters like |, ?, ., [, ]:

    Regex: `(\[Internal\]|\[v4\] )?.{3}.+: (Adds|Fixes|Refactors|Removes) .{3}.+`

Nit: the new blank line between the regex and the [Internal] paragraph has 9 trailing spaces — harmless in YAML, but some lint configs flag it.

Otherwise LGTM 👍

Updated regex comment formatting in PR linting workflow.
@yash2710 yash2710 enabled auto-merge (squash) May 20, 2026 18:56
Copy link
Copy Markdown
Member

@kushagraThapar kushagraThapar left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @yash2710 !

@yash2710 yash2710 changed the title [Internal]: Refactors regex failure comment format in prlint.yml [Internal] PRLint: Refactors regex failure comment format in prlint.yml May 20, 2026
Copy link
Copy Markdown
Member

@ananth7592 ananth7592 left a comment

Choose a reason for hiding this comment

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

LGTM

@yash2710 yash2710 merged commit 6a94f48 into main May 21, 2026
33 checks passed
@yash2710 yash2710 deleted the users/trivediyash/prlint branch May 21, 2026 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants