oxen-io/oxen-core

Installing dependencies on macOS produces a Brewfile.lock.json which is untracked

martin-braun opened this issue · 0 comments

Describe the bug
Instructions say to run

brew update && brew bundle --file=contrib/brew/Brewfile

to install build dependencies on macOS, but it will produce contrib/brew/Brewfile.lock.json which is untracked in the version control

To Reproduce
Steps to reproduce the behavior:

Just run brew update && brew bundle --file=contrib/brew/Brewfile on macOS.

Expected behaviour
What is the expected behaviour if the steps above are followed:
No Brewfile.lock.json should be created. Homebrew does not support local packages, so having a lock file might be inefficient for the whole system in favor of oxen-core. The current behavior is already right, but the docs should actually suggest to run

update && brew bundle --file=contrib/brew/Brewfile --no-lock

to prevent the file from being created.

Current Behaviour
What is the current behaviour if the steps to reproduce are followed:
contrib/brew/Brewfile.lock.json will be created and it will be untracked.