Skip to content

Honour sponsor benefits across platforms - #24414

Merged
MikeMcQuaid merged 2 commits into
mainfrom
respect-existing-sponsor-tiers
Nov 1, 2026
Merged

MikeMcQuaid merged 2 commits into
mainfrom
respect-existing-sponsor-tiers

Conversation

@MikeMcQuaid

Copy link
Copy Markdown
Member
  • Preserve retired tiers and contributions before 30 October 2026.
  • Recognise one-time gifts for twelve months, with annual prices for new gifts.
  • Import Patreon and Open Collective sponsorships and profile images without counting platform transfers as sponsors.
  • Read top sponsors from the README for major/minor blog drafts.
  • Explain sponsorship recognition, funding and project spending.

  • 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.

Codex with GPT 6 Astra at Extra High effort, with local review and testing.


@coderabbitai

coderabbitai Bot commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Summary

Summary by CodeRabbit

  • New Features
    • Sponsor recognition now includes eligible contributions from GitHub, Patreon and Open Collective, with names and logos shown according to applicable recognition tiers.
    • Major and minor release notes now thank listed sponsors.
    • The README now links to sponsorship information and displays sponsor details and release-sponsor logos.
  • Bug Fixes
    • Scheduled sponsor-list updates can continue alongside other updates if sponsorship data cannot be fetched, while reporting the failure.
    • Running the sponsor update when the README has no changes now completes without failing.
  • Documentation
    • Added guidance on sponsoring Homebrew and how sponsor recognition works.

The PR adds sponsorship collection from GitHub, Patreon and Open Collective. It updates sponsor listings in the README, adds sponsor acknowledgements to major and minor release notes, changes scheduled update handling, and adds sponsorship documentation. It also updates maintainer listings.

Changes: Sponsor recognition

Layer / File(s) Summary
Sponsor data and collection
Library/Homebrew/utils/github.rb, Library/Homebrew/utils/sponsors.rb, Library/Homebrew/test/utils/github_spec.rb, Library/Homebrew/test/utils/sponsors_spec.rb
GitHub sponsorship data now includes one-time tiers, tier descriptions and start dates. The new Sponsors module collects eligible records from GitHub, Patreon and Open Collective. Tests cover provider eligibility, benefit periods and historical tier descriptions.
Sponsor records and README output
Library/Homebrew/dev-cmd/update-sponsors.rb, Library/Homebrew/test/dev-cmd/update-sponsors_spec.rb, completions/fish/brew.fish, completions/zsh/_brew, README.md
brew update-sponsors combines provider records and updates the README with platform-specific sponsor names and logo entries. It applies tier, ordering, name-escaping and URL rules. The command descriptions now refer to sponsors, and tests cover output and failure cases. The README links to sponsorship information and lists supporters by platform.
Scheduled sponsor updates
.github/workflows/sponsors-maintainers-man-completions.yml
The workflow provides the Patreon token and continues other update commands if sponsor updates fail. A later step reports the failure and exits with a non-zero status. The scheduled issue body points to the workflow log and notes that some updates may have completed.
Release acknowledgements
Library/Homebrew/dev-cmd/release.rb, Library/Homebrew/test/dev-cmd/release_spec.rb
Major and minor releases fetch origin and read sponsor names from origin/main:README.md. The release command prints a thank-you when the README contains sponsor names. Tests cover attribution conditions and event order.
Sponsorship information
docs/Sponsoring-Homebrew.md, docs/index.md
The new guide describes contribution use, recognition criteria and durations, and the update process. The documentation index links to the guide.

Maintainer listings

Layer / File(s) Summary
Maintainer and author lists
README.md, docs/Manpage.md, manpages/brew.1
The README and manpage author and maintainer lists are updated. The generated manpage date changes to November 2026.
Merge Risk: Moderate · up to 94f6c

Some sponsors may receive incorrect benefits, while automated README updates can create unnecessary reorder-only commits. These issues should be addressed before merging.

Pre-merge checks: Passed 4
Check name Status Explanation
Title check Passed The title clearly summarises the main change: applying sponsor benefits across multiple platforms.
Description check Passed The description directly explains the sponsorship changes, recognition rules, platform integrations, documentation, and testing.
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.

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

@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: 4

Nitpick comments: 1
Library/Homebrew/test/dev-cmd/update-sponsors_spec.rb: 1

123-129: Trivial · Maintainability & Code Quality · Low value

Split the failure and success cases into separate examples.

The failure branch has two expect calls (Lines 125 and 126). The example also branches on failure.

The repository learning requires one expect per unit test. The before setup here is trivial, so the exception does not apply. Use two examples, each with one expect. Use readme.read in a separate example, or a before hook for the shared stubs.

Based on learnings: "Use a single expect per unit test; combine expectations only in integration tests or when the before setup is non-trivial."

Source: Learnings


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: 55847302-c421-42c2-a774-ed7140e5e580
Commits

Reviewing files that changed from the base of the PR and between 8a17c20 and 3eb1254.

Files selected for processing: 12
  • .github/workflows/sponsors-maintainers-man-completions.yml
  • Library/Homebrew/dev-cmd/release.rb
  • Library/Homebrew/dev-cmd/update-sponsors.rb
  • Library/Homebrew/test/dev-cmd/release_spec.rb
  • Library/Homebrew/test/dev-cmd/update-sponsors_spec.rb
  • Library/Homebrew/test/utils/github_spec.rb
  • Library/Homebrew/test/utils/sponsors_spec.rb
  • Library/Homebrew/utils/github.rb
  • Library/Homebrew/utils/sponsors.rb
  • README.md
  • docs/Sponsoring-Homebrew.md
  • docs/index.md

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/utils/sponsors.rb Resolved
Comment thread Library/Homebrew/utils/sponsors.rb Resolved
@MikeMcQuaid
MikeMcQuaid force-pushed the respect-existing-sponsor-tiers branch from 3eb1254 to 9f26f12 Compare October 31, 2026 21:17

@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: 2

Additional comments: 1
Library/Homebrew/utils/sponsors.rb-136-139: 1

136-139: Minor · Stability & Availability · Quick win

Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.

Reject a repeated Patreon pagination cursor.

The loop stops only when meta.pagination.cursors.next is blank. If Patreon returns the same cursor that the request just used, the loop sends the same request again without end. The scheduled workflow then hangs until the job times out. Raise an error when the cursor does not change.

Proposed fix
       cursor = result.dig("meta", "pagination", "cursors", "next")
       break if cursor.blank?
+      raise "Patreon returned a repeated pagination cursor." if cursor == parameters["page[cursor]"]
 
       parameters["page[cursor]"] = cursor

Based on learnings: reject responses where the server reports more pages but the cursor is unchanged, to prevent infinite loops.

Source: Learnings


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: 764b0b12-52ed-411e-9cad-7c3e7f257546
Commits

Reviewing files that changed from the base of the PR and between 3eb1254 and 9f26f12.

Files selected for processing: 7
  • .github/workflows/sponsors-maintainers-man-completions.yml
  • Library/Homebrew/dev-cmd/release.rb
  • Library/Homebrew/dev-cmd/update-sponsors.rb
  • Library/Homebrew/test/dev-cmd/release_spec.rb
  • Library/Homebrew/test/dev-cmd/update-sponsors_spec.rb
  • Library/Homebrew/test/utils/sponsors_spec.rb
  • Library/Homebrew/utils/sponsors.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.

Comment thread Library/Homebrew/dev-cmd/release.rb Resolved
@MikeMcQuaid
MikeMcQuaid force-pushed the respect-existing-sponsor-tiers branch from 9f26f12 to 5e6010e Compare October 31, 2026 21:36

@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: eb5dd669-43b5-4606-a196-6728f959e6e7
Commits

Reviewing files that changed from the base of the PR and between 9f26f12 and 5e6010e.

Files selected for processing: 5
  • .github/workflows/sponsors-maintainers-man-completions.yml
  • Library/Homebrew/dev-cmd/release.rb
  • Library/Homebrew/test/dev-cmd/release_spec.rb
  • completions/fish/brew.fish
  • completions/zsh/_brew

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

Comment thread Library/Homebrew/dev-cmd/release.rb Resolved
@MikeMcQuaid
MikeMcQuaid force-pushed the respect-existing-sponsor-tiers branch 2 times, most recently from 92ea809 to 012ca61 Compare November 1, 2026 14:23

@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: 61298497-eebf-4bd6-9bc9-be0866a270ec
Commits

Reviewing files that changed from the base of the PR and between 012ca61 and f49734c.

Files selected for processing: 3
  • README.md
  • docs/Manpage.md
  • manpages/brew.1

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 docs/Manpage.md Resolved
@MikeMcQuaid
MikeMcQuaid force-pushed the respect-existing-sponsor-tiers branch 2 times, most recently from 2ed3aec to eaa8881 Compare November 1, 2026 15:17

@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: a9b4289d-0546-4dfe-a187-7c2070d4b189
Commits

Reviewing files that changed from the base of the PR and between f49734c and 2ed3aec.

Files selected for processing: 3
  • Library/Homebrew/dev-cmd/update-sponsors.rb
  • Library/Homebrew/test/dev-cmd/update-sponsors_spec.rb
  • README.md

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

@MikeMcQuaid
MikeMcQuaid force-pushed the respect-existing-sponsor-tiers branch from eaa8881 to ef26c31 Compare November 1, 2026 15:33

@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: 5f0ff958-a190-44f9-87ca-9dad0facfe66
Commits

Reviewing files that changed from the base of the PR and between eaa8881 and ef26c31.

Files selected for processing: 6
  • Library/Homebrew/dev-cmd/release.rb
  • Library/Homebrew/dev-cmd/update-sponsors.rb
  • Library/Homebrew/test/dev-cmd/release_spec.rb
  • Library/Homebrew/test/dev-cmd/update-sponsors_spec.rb
  • Library/Homebrew/test/utils/github_spec.rb
  • Library/Homebrew/utils/github.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.

@MikeMcQuaid
MikeMcQuaid force-pushed the respect-existing-sponsor-tiers branch 2 times, most recently from 6f89a38 to 08dfffe Compare November 1, 2026 16:32

@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.

Nitpick comments: 1
Library/Homebrew/dev-cmd/update-sponsors.rb: 1

55-55: Trivial · Functional Correctness · Quick win

Break ties in sponsor order by input position.

sort_by does not guarantee a stable order in Ruby. Sponsors with the same monthly_amount can be placed in an order the sort does not define. The groups recurring and one-time sponsors… example depends on that order. Three sponsors have amount 1000, and the spec expects Shared Sponsor before Gift Sponsor. An explicit index tie-breaker keeps the input order. This matches the expected output and makes the README order independent of the sort implementation.

♻️ Proposed fix
-          sponsors.sort_by { |s| -s[:monthly_amount] }.each do |s|
+          sponsors.sort_by.with_index { |s, index| [-s[:monthly_amount], index] }.each do |s|

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: 1c8c38d8-6ce6-4342-845e-0910dad500bb
Commits

Reviewing files that changed from the base of the PR and between 6f89a38 and 08dfffe.

Files selected for processing: 3
  • Library/Homebrew/dev-cmd/update-sponsors.rb
  • Library/Homebrew/test/dev-cmd/update-sponsors_spec.rb
  • README.md
Files skipped from review as they are similar to previous changes: 1
  • README.md

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

@MikeMcQuaid
MikeMcQuaid force-pushed the respect-existing-sponsor-tiers branch from 3480463 to 70c6337 Compare November 1, 2026 16:51

@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: 84df920e-7360-45e2-8f90-cec573b68608
Commits

Reviewing files that changed from the base of the PR and between 70c6337 and 8654253.

Files selected for processing: 3
  • README.md
  • docs/Manpage.md
  • manpages/brew.1
Files skipped from review as they are similar to previous changes: 1
  • README.md

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

Comment thread manpages/brew.1 Resolved
- Preserve retired tiers and contributions before 30 October 2026,
  with twelve months of recognition for eligible one-time gifts.
- Validate sponsorship amounts across all providers and gift types.
- Import Patreon and Open Collective sponsorships and profile images.
- List sponsors by platform with logo sponsors first, sorting each
  group by monthly contribution and linking names alongside logos.
- Remove static service acknowledgements from `README.md` and link
  other supporters to public sponsor lists or their platform page.
- Fetch origin before generating major/minor release notes and read
  sponsor acknowledgements from its README.
- Report provider failures after independent workflow updates finish.
- Document sponsorship recognition, funding and project spending.
@MikeMcQuaid
MikeMcQuaid force-pushed the respect-existing-sponsor-tiers branch from 8654253 to 1be79ba Compare November 1, 2026 17:14

@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.

Caution

Some comments are outside the diff and can’t be posted inline due to GitHub limitations.

⚠️ Outside diff range comments (1)

Minor · Do not expose one-time tiers to recurring sponsorship matching. · github.rb:457-458

Library/Homebrew/utils/github.rb:457-458
Minor · Data Integrity & Integration · Quick win

Do not expose one-time tiers to recurring sponsorship matching.

GitHub.sponsorships returns recurring sponsorships, but GitHub.sponsorship_tiers exposes one-time tiers at one-twelfth of their annual price. The matcher does not retain a one-time distinction. A recurring sponsorship can therefore match a one-time tier and receive benefits at the wrong amount. Sponsors.github_one_time already supplies the one-time gift's tier description separately, so exclude one-time tiers from this shared list.

Suggested fix
-  # Return published tiers with one-time prices expressed as monthly amounts.
+  # Return published recurring tiers.
...
-      next if tier.nil?
+      next if tier.nil? || tier["isOneTime"]

-      months = tier["isOneTime"] ? 12 : 1
-      { description: tier.fetch("description"), monthly_amount: tier.fetch("monthlyPriceInDollars") / months }
+      { description: tier.fetch("description"), monthly_amount: tier.fetch("monthlyPriceInDollars") }

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: 90f47293-6274-4fb7-a7e4-bf8b2572011b
Commits

Reviewing files that changed from the base of the PR and between 1be79ba and 94f6c9c.

Files selected for processing: 3
  • README.md
  • docs/Manpage.md
  • manpages/brew.1
Files skipped from review as they are similar to previous changes: 1
  • README.md

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

@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.

Good idea!

Comment thread README.md Resolved
@MikeMcQuaid
MikeMcQuaid added this pull request to the merge queue Nov 1, 2026
Merged via the queue into main with commit c1bf6e1 Nov 1, 2026
54 checks passed
@MikeMcQuaid
MikeMcQuaid deleted the respect-existing-sponsor-tiers branch November 1, 2026 19: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.

4 participants

⌂ 换网址