Make formula install-step var bases explicit - #23372
Merged
Merged
Conversation
MikeMcQuaid
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Homebrew’s formula install-steps documentation to make var-relative paths explicit (base: :var) while keeping a temporary runtime fallback for compatibility, and records the intended migration sequence.
Changes:
- Update
Formula-Cookbookexamples to pass explicitbase:forvar-relative paths. - Clarify install-step API documentation/plan around base resolution and migration phases.
- Add an internal TODO noting the temporary
default_base: :varcompatibility fallback.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| Library/Homebrew/json_api_postinstall_preflight_postflight_plan.md | Adjusts plan text to reflect explicit base: usage and documents the staged migration/removal sequence. |
| Library/Homebrew/formula.rb | Adds a TODO comment explaining the temporary default_base: :var compatibility default in post_install_steps. |
| docs/Formula-Cookbook.md | Updates cookbook guidance and examples to specify base: :var (and other bases) explicitly in install-step calls. |
Suppressed comments (1)
Library/Homebrew/json_api_postinstall_preflight_postflight_plan.md:322
- PR 2 is marked complete, but these “Notes for implementation” now say the implementation should require explicit
base: :var. Since the runtime still carries a compatibility default (as noted elsewhere in this PR), this wording is misleading. Consider framing it as a documentation/desired-usage requirement rather than a runtime requirement.
Notes for implementation: require `mkdir`/`touch` and other single-path
steps to specify `base: :var` explicitly and default source/target paths to
`prefix`; expose the ordered array through `FormulaStruct`; make
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
8 tasks
MikeMcQuaid
force-pushed
the
install-step-explicit-var-compat
branch
2 times, most recently
from
July 31, 2026 16:17
e5678e4 to
1ba2c48
Compare
- Stop documenting the temporary implicit `var` base for formula steps. - Update examples to specify their intended path base. - Record the official-tap migration, RuboCop enforcement and runtime default removal as separate follow-up changes.
MikeMcQuaid
force-pushed
the
install-step-explicit-var-compat
branch
from
July 31, 2026 19:32
1ba2c48 to
dbee8fb
Compare
MikeMcQuaid
marked this pull request as ready for review
July 31, 2026 19:52
MikeMcQuaid
enabled auto-merge
August 1, 2026 13:30
p-linnane
approved these changes
Aug 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Formula install steps currently default relative paths to
var. Retain that behaviour temporarily for compatibility while removing it from the documented API.AI disclosure: using OpenAI Codex 5.6 Sol max with local review and testing.