From 204b790012c1071d36691a633c3726d32331932c Mon Sep 17 00:00:00 2001 From: Christopher Angelo Phillips <32073428+spiffcs@users.noreply.github.com> Date: Mon, 17 Jul 2023 14:19:21 -0400 Subject: [PATCH] docs: update docs with new docker specific instructions (#1941) * docs: update docs with new docker specific instructions --------- Signed-off-by: Christopher Phillips Former-commit-id: c67c76e84df84e3e24aa307637d884ca8b7e3eea --- DEVELOPING.md | 19 +++++++++++++++++++ Makefile | 3 ++- build.REMOVED.git-id | 1 + 3 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 build.REMOVED.git-id diff --git a/DEVELOPING.md b/DEVELOPING.md index 7d915b7a3..af13293f2 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -7,6 +7,25 @@ In order to test and develop in this repo you will need the following dependenci - docker - make +### Docker settings for getting started +Make sure you've updated your docker settings so the default docker socket path is available. + +Go to: + +docker -> settings -> advanced + +Make sure: + +``` +Allow the default Docker socket to be used +``` + +is checked. + +Also double check that the docker context being used is the default context. If it is not, run: + +`docker context use default` + After cloning the following step can help you get setup: 1. run `make bootstrap` to download go mod dependencies, create the `/.tmp` dir, and download helper utilities. 2. run `make` to view the selection of developer commands in the Makefile diff --git a/Makefile b/Makefile index 5e2d700a0..c40e152c5 100644 --- a/Makefile +++ b/Makefile @@ -313,7 +313,8 @@ generate-license-list: ## Generate an updated spdx license list ## Build-related targets ################################# .PHONY: build -build: $(SNAPSHOT_DIR) ## Build release snapshot binaries and packages +build: + CGO_ENABLED=0 go build -trimpath -ldflags "$(LDFLAGS)" -o $@ ./cmd/syft $(SNAPSHOT_DIR): ## Build snapshot release binaries and packages $(call title,Building snapshot artifacts) diff --git a/build.REMOVED.git-id b/build.REMOVED.git-id new file mode 100644 index 000000000..0c4587c84 --- /dev/null +++ b/build.REMOVED.git-id @@ -0,0 +1 @@ +ab24f7f8cbf320cf498fcf0ca9b926ed93d4475a \ No newline at end of file