Skip to content

Document install step interpolation - #23347

Merged
MikeMcQuaid merged 1 commit into
mainfrom
document-install-step-interpolation
Jul 29, 2026
Merged

Document install step interpolation#23347
MikeMcQuaid merged 1 commit into
mainfrom
document-install-step-interpolation

Conversation

@MikeMcQuaid

@MikeMcQuaid MikeMcQuaid commented Jul 29, 2026

Copy link
Copy Markdown
Member
  • Distinguish Ruby interpolation from install-time tokens that survive JSON serialisation.
  • Keep token-producing compatibility helpers valid while rejecting arbitrary interpolation.
  • Emit explicit install-time tokens from formula autocorrections.

As requested by @SMillerDev

  • AI was used to generate or assist with generating this PR.

OpenAI Codex GPT 5.6 Sol max with local review.


Copilot AI review requested due to automatic review settings July 29, 2026 08:36

Copilot AI 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.

Pull request overview

Updates Homebrew documentation to clarify how Ruby interpolation (#{...}) differs from install-time {{...}} tokens inside structured install-step blocks, helping authors write steps that survive JSON serialisation and expand correctly at install time.

Changes:

  • Adds an “Interpolation in steps blocks” subsection to the Formula cookbook’s steps documentation.
  • Adds the same clarification to the Cask cookbook’s steps documentation.
  • Refines examples to recommend explicit {{...}} tokens (and base:/source_base:/target_base: where applicable) for install-time expansion.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
docs/Formula-Cookbook.md Documents Ruby vs {{...}} token expansion semantics for formula structured steps.
docs/Cask-Cookbook.md Documents Ruby vs {{...}} token expansion semantics for cask structured steps.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/Formula-Cookbook.md Outdated
Comment thread docs/Cask-Cookbook.md Outdated

@SMillerDev SMillerDev 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 Mike!

@MikeMcQuaid
MikeMcQuaid force-pushed the document-install-step-interpolation branch from 6bef1fa to 7a846e3 Compare July 29, 2026 09:52
@MikeMcQuaid
MikeMcQuaid marked this pull request as draft July 29, 2026 16:18
@MikeMcQuaid
MikeMcQuaid force-pushed the document-install-step-interpolation branch from 7a846e3 to 3ab7457 Compare July 29, 2026 16:26
- Distinguish Ruby interpolation from install-time tokens that survive
  JSON serialisation.
- Keep token-producing compatibility helpers valid while rejecting
  arbitrary interpolation.
- Emit explicit install-time tokens from formula autocorrections.
@MikeMcQuaid
MikeMcQuaid force-pushed the document-install-step-interpolation branch from 3ab7457 to 095b9ce Compare July 29, 2026 16:59
@MikeMcQuaid
MikeMcQuaid marked this pull request as ready for review July 29, 2026 17:18
@MikeMcQuaid
MikeMcQuaid added this pull request to the merge queue Jul 29, 2026
Merged via the queue into main with commit 3550b83 Jul 29, 2026
45 of 46 checks passed
@MikeMcQuaid
MikeMcQuaid deleted the document-install-step-interpolation branch July 29, 2026 17:36
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