Skip to content

Fix brew bundle dump --global to respect XDG_CONFIG_HOME for initial Brewfile creation with backwards compatibility #20658

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

Closed
wants to merge 5 commits into from
Closed

Fix brew bundle dump --global to respect XDG_CONFIG_HOME for initial Brewfile creation with backwards compatibility #20658

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cb7dbba
Initial plan
Copilot Sep 9, 2025
fb65fa9
Fix brew bundle dump --global to respect XDG_CONFIG_HOME
Copilot Sep 9, 2025
3a35890
Address backwards compatibility concerns and use Pathname#mkpath
Copilot Sep 9, 2025
040fd9c
Address reviewer feedback: check XDG mode properly and make lazy
Copilot Sep 9, 2025
890e7ab
Finalize XDG support with proper backwards compatibility
Copilot Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Library/Homebrew/bundle/brewfile.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def self.path(dash_writes_to_stdout: false, global: false, file: nil)
else
raise "'HOMEBREW_BUNDLE_FILE' cannot be specified with '--global'" if env_bundle_file.present?

if user_config_home && File.exist?("#{user_config_home}/Brewfile")
if user_config_home
"#{user_config_home}/Brewfile"
else
Bundle.exchange_uid_if_needed! do
Expand Down
1 change: 1 addition & 0 deletions Library/Homebrew/bundle/dumper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ def self.brewfile_path(global: false, file: nil)
sig { params(file: Pathname, content: String).void }
def self.write_file(file, content)
Bundle.exchange_uid_if_needed! do
FileUtils.mkdir_p file.parent
file.open("w") { |io| io.write content }
end
end
Expand Down
9 changes: 9 additions & 0 deletions Library/Homebrew/test/bundle/brewfile_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# typed: strict
# frozen_string_literal: true

require "bundle"
Expand Down Expand Up @@ -171,6 +172,14 @@
expect(path).to eq(expected_pathname)
end
end

context "when HOMEBREW_USER_CONFIG_HOME is set but Brewfile does not exist" do
let(:config_dir_brewfile_exist) { false }

it "returns the XDG-compliant path when HOMEBREW_USER_CONFIG_HOME is set" do
expect(path).to eq(Pathname.new("#{env_user_config_home_value}/Brewfile"))
end
end
end

context "when HOMEBREW_BUNDLE_FILE has a value" do
Expand Down
Loading