Skip to content

create: Strip trailing dot from GitHub description - #24374

Merged
MikeMcQuaid merged 3 commits into
Homebrew:mainfrom
abitrolly:strip-descdot
Oct 29, 2026
Merged

MikeMcQuaid merged 3 commits into
Homebrew:mainfrom
abitrolly:strip-descdot

Conversation

@abitrolly

@abitrolly abitrolly commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Lubricates audit friction:

  * line 2, col 70: Description shouldn't end with a full stop.

Testing

brew create --go https://github.com/viktomas/godu
brew audit --new godu

The message about full stop should not be there.


  • Have you followed our Contributing guidelines?
  • Have you checked for other open Pull Requests for the same change?
  • Have you explained what your changes do? Performance claims (e.g. "this is faster") must include brew benchmark results.
  • Have you explained why you'd like these changes included, not just what they do?
  • For bug fixes, have you given step-by-step brew commands to reproduce the bug?
  • Have you written new tests (excluding integration tests)? Here's an example.
  • Have you successfully run brew lgtm (style, typechecking and tests) locally?

  • I did not use AI/LLM to create this PR, or I disclosed the tool/model below and reviewed its output; I did not attribute commits to AI and will answer maintainer questions and review comments myself without AI/LLM.

@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b2377cff-10b5-45ae-b529-5cb5ef43691e
Commits

Reviewing files that changed from the base of the PR and between 6869eaa and 2ef90dc.

Files selected for processing: 1
  • Library/Homebrew/formula_creator.rb
Files skipped from review as they are similar to previous changes: 1
  • Library/Homebrew/formula_creator.rb

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Bug Fixes
    • Generated formula descriptions based on GitHub repository metadata no longer include a trailing full stop.
    • When repository metadata does not include a description, the generated formula now uses an empty description instead of a null value.
    • Description text is handled consistently whether metadata provides a description or not.

FormulaCreator now initializes @desc as an empty string. It converts fetched GitHub descriptions to strings and removes trailing full stops. The formula template inspects @desc directly.

Changes: Formula description cleanup

Layer / File(s) Summary
Trim repository description
Library/Homebrew/formula_creator.rb
FormulaCreator initializes @desc as an empty string, converts a fetched GitHub description to a string and removes trailing full stops, then interpolates @desc directly in the formula template.

Priority: Low

Merge Risk: Low · up to 2ef90

Creation no longer crashes on a null GitHub description. Descriptions ending in multiple dots can still fail the intended audit check, but this is a narrow, previously reported case.

Pre-merge checks: Passed 4
Check name Status Explanation
Description check Passed The description clearly explains that the change removes trailing full stops from GitHub descriptions generated by brew create. It also includes validation commands and the expected audit result.
Title check Passed The title clearly and concisely summarises the main change: stripping a trailing full stop from GitHub descriptions.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1


Review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7b38e631-4454-4eca-8970-27191a8942e4
Commits

Reviewing files that changed from the base of the PR and between a59d9fc and 5e76068.

Files selected for processing: 1
  • Library/Homebrew/formula_creator.rb

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

Comment thread Library/Homebrew/formula_creator.rb Resolved

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1


Review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: cf8eb056-0874-4d8d-ad63-2cabd1f8bc43
Commits

Reviewing files that changed from the base of the PR and between 5e76068 and a784ad2.

Files selected for processing: 1
  • Library/Homebrew/formula_creator.rb

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

Comment thread Library/Homebrew/formula_creator.rb Resolved
Lubricates audit friction:

  * line 2, col 70: Description shouldn't end with a full stop.

Change @desc type to string, because its null is not used anyway.

@ZhongRuoyu ZhongRuoyu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great, thanks!

Comment thread Library/Homebrew/formula_creator.rb Resolved
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1


Review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 88c0ab74-6715-4092-a5bc-dc5d8eae1e3a
Commits

Reviewing files that changed from the base of the PR and between e0a66b7 and 6869eaa.

Files selected for processing: 1
  • Library/Homebrew/formula_creator.rb

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

Comment thread Library/Homebrew/formula_creator.rb Resolved
Comment thread Library/Homebrew/formula_creator.rb Resolved

@MikeMcQuaid MikeMcQuaid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@MikeMcQuaid
MikeMcQuaid added this pull request to the merge queue Oct 29, 2026
Merged via the queue into Homebrew:main with commit 5460ead Oct 29, 2026
53 checks passed
@abitrolly
abitrolly deleted the strip-descdot branch October 29, 2026 12:13
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

⌂ 换网址