Page Comparison

...

This guide will assume you are planning to develop with Bazel, which is the new build system for Cockroach. make is currently deprecated but if the version of cockroach you’re building is v21.2 or earlier you will probably want to use make. In that case, see the “Building “Building with make" ” section below.

1. Install homebrew.

2. Install XCode Command Line Tools, using

   Code Block
   xcode-select --install

3. Install XCode from the Mac App store and open it at least once so the developer tools can initialize. This will take a while. After installing, switch to the active developer directory:

   Code Block
   sudo xcode-select -switch /Applications/Xcode.app && sudo xcodebuild -license accept

4. Install the following brew packages:

   Code Block
   brew install git autoconf cmake bazelisk make gpatch

5. OS X ships with a git, but it's old. Once you install git via brew, relaunch your terminal to make sure your git version is up to date. You can confirm this by comparing the output of

   Code Block
   which git

   to the output of

   Code Block
   language bash
   echo $(brew --prefix)/bin/git

   If they match, you're using brew's git! You also need to use brew’s make. brew installs make in a special directory, so you need to update your PATH to look for it. On MacOS, you will need to add the following line to either ~/.zshrc, ~/.bashrc, or ~/.bash_profile depending on which shell you use.

   Code Block
   export PATH="$(brew --prefix)/opt/make/libexec/gnubin:$PATH"

   Restart your shell, and confirm this directory is being used.

   Code Block
   language bash
   which make

6. Install Go. (Note this is not technically a requirement if all you want to do is run builds and tests via Bazel, but generally you will also want to have a toolchain installed for development.) Options include:

   1. Official installer via clicking (don't do this)

   2. Official installer via brew install --cask go (it's ok)

   3. homebrew via brew install go (it's ok)

   4. from source (you already know what you're doing, right?)

7. Clone the repo using git and navigate into it

   Code Block
   mkdir -p $(go env GOPATH)/src/github.com/cockroachdb cd $(go env GOPATH)/src/github.com/cockroachdb git clone https://github.com/cockroachdb/cockroach cd cockroach

8. Add your fork as a remote (assuming you forked cockroach on GitHub)
   git remote add yourgithubusername git@github.com:yourgithubusername/cockroach.git

9. You should be good to start developing. Begin by running ./dev doctor and following its suggestions to configure your workspace. When the doctor says you’re ready, you can run ./dev build to build the Cockroach binary, or ./dev build short to build the same Cockroach binary without the DB Console, which is faster to compile. See the Developing with Bazel Wiki page for more info.

...