Skip to content
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

Add notes about required tools for macOS #1470

Merged
merged 1 commit into from
May 1, 2024
Merged

Add notes about required tools for macOS #1470

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions content/docs/contributing/building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,21 @@ You should install the following tools before you start developing cert-manager:
- `docker` (or `podman`, see [Container Engines](#container-engines) below)
- `Go` (optional; see [Go Versions](#go-versions) below)

### Notes for macOS

cert-manager supports being developed on macOS, but there are a couple of extra requirements to note:

1. cert-manager's Makefile setup uses `bash`, and the system version of bash is prehistoric on macOS. We recommend installing bash from
[homebrew](https://formulae.brew.sh/formula/bash); if you don't, you might see very poor performance in Makefiles
2. As mentioned above, GNU Coreutils are required and can be installed via [homebrew](https://formulae.brew.sh/formula/coreutils)
3. `make` is also very old on macOS; we recommend installing a newer version from [homebrew](https://formulae.brew.sh/formula/make)

In summary, we recommend the following for all developers using macOS:

```console
brew install make bash git jq coreutils
```

## Getting Started

The vast majority of commands which you're likely to need to use are documented via `make help`. That's probably the first place to start if you're
Expand Down