Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

rubocops/caveats: Disallow ANSI escape codes #14372

Merged
merged 1 commit into from Jan 19, 2023
Merged

rubocops/caveats: Disallow ANSI escape codes #14372

merged 1 commit into from Jan 19, 2023

Conversation

samford
Copy link
Member

@samford samford commented Jan 16, 2023

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

Formula caveats text appears on formulae.brew.sh but escape characters, as used in ANSI escape codes, should not appear in HTML (see Homebrew/formulae.brew.sh#680, Homebrew/homebrew-core#120530). This PR adds a RuboCop to disallow escape characters in the caveats text.

@samford
rubocops/caveats: Disallow ANSI escape codes
a1993b9 
Formula caveats text appears on formulae.brew.sh but escape
characters, as used in ANSI escape codes, should not appear in HTML.
This commit adds a RuboCop to disallow escape characters in the
caveats text.
@BrewTestBot
Copy link
Member

Review period will end on 2023-01-17 at 06:32:01 UTC.

@BrewTestBot BrewTestBot added the waiting for feedback Merging is blocked until sufficient time has passed for review label Jan 16, 2023
@MikeMcQuaid MikeMcQuaid added the critical Critical change which should be shipped as soon as possible. label Jan 16, 2023
@BrewTestBot BrewTestBot removed the waiting for feedback Merging is blocked until sufficient time has passed for review label Jan 16, 2023
@BrewTestBot
Copy link
Member

Review period skipped due to critical label.

MikeMcQuaid
MikeMcQuaid approved these changes Jan 16, 2023
View reviewed changes
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks for this @samford!

@MikeMcQuaid MikeMcQuaid merged commit 5a4e226 into Homebrew:master Jan 19, 2023
@samford samford deleted the rubocops-caveats-disallow-ansi-escape-codes branch January 19, 2023 15:13
@github-actions github-actions bot added the outdated PR was locked due to age label Feb 19, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@MikeMcQuaid MikeMcQuaid MikeMcQuaid approved these changes

@BrewTestBot BrewTestBot BrewTestBot approved these changes

Assignees
No one assigned
Labels
critical Critical change which should be shipped as soon as possible. outdated PR was locked due to age
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@samford @BrewTestBot @MikeMcQuaid