Merge pull request #2 from basecamp/updates-to-ruby-build

Updates to ruby build

Author: fschueller

Goopfile.lock

@@ -1,6 +1,6 @@
 github.com/BurntSushi/toml #3012a1dbe2e4bd1391d42b32f0577cb7bbc7f005
 github.com/cpuguy83/go-md2man #eda4fa589184806b8720ea3b9146491209877a10
-github.com/docker/docker #28b645755a6bbfd26dac73d9cb7200394828f47d
+github.com/docker/docker #6f4fbef82718212e593626419182f31a9f604316
 github.com/docker/go-units #519db1ee28dcc9fd2474ae59fca29a810482bfb1
 github.com/fsouza/go-dockerclient #a958d2e31b6c581391fe589cf11c2d208ae03e9f
 github.com/google/uuid/uuid #c2e93f3ae59f2904160ceaab466009f965df46d6

Makefile

@@ -2,14 +2,14 @@ all: assets
 	GO111MODULE=off $(GOPATH)/bin/goop go build -o bin/build_ruby
 
 setup:
-	go get -u github.com/jteeuwen/go-bindata/go-bindata...
-	go get -u github.com/karmakaze/goop
+	brew install go-bindata
+	go install github.com/karmakaze/goop@latest
 
 test: assets
-	$(GOPATH)/bin/goop go test
+	$GOPATH/bin/goop go test
 
 assets:
-	${GOPATH}/bin/go-bindata data/...
+	go-bindata data/...
 
 clean:
 	rm -f bin/*

README.md

@@ -8,15 +8,31 @@
 
 #### 1.1 Linux
 
-[Follow the instructions here](http://docs.docker.io/installation/)
+[Follow the instructions here to install Docker](http://docs.docker.io/installation/)
+[Follow the instructions here to install Go if necessary](https://go.dev/doc/install)
 
 #### 1.2 OS X
 
-Follow [this page](https://docs.docker.com/engine/installation/mac/) to install Docker for mac.
+[Follow the instructions here to install Docker](https://docs.docker.com/engine/installation/mac/) to install Docker for Mac.
 
-You can now run docker commands locally on your mac.
+If you need to install `go` on your Mac, best install it through Homebrew:
 
-#### 1.3 Install pre-requisite tools and dependencies
+```
+brew install go
+go version
+```
+Please note that in newer installations of Go, `GOPATH` is assumed at your $HOME/go. For this repository to build however, you'll still need to explicitly set the GOPATH variable to run `make`.
+
+```
+echo 'export GOPATH=$HOME/go' >> ~/.bash_profile
+source ~/.bash_profile
+```
+
+#### 1.3 Install work
+
+Follow the [README](https://github.com/basecamp/work#first-time-setup) in order to install `work`.
+
+#### 1.4 Install pre-requisite tools and dependencies
 
     $ make setup
     $ make deps
@@ -25,8 +41,7 @@ You can now run docker commands locally on your mac.
 
 ### 2. Clone and build this repo
 
-    $ git clone [email protected]:wjessop/build_ruby.git
-    $ cd build_ruby
+    $ work cd build_ruby
     $ make
 
 ## Usage
@@ -68,10 +83,15 @@ See the Makefile for more functions.
 
 Make sure you ran ````export DOCKER_HOST=tcp://localhost:4243```` in the terminal you are trying to use docker/build_ruby from
 
+## Errors while running `make`
+
+This repository collects its internal dependencies in `Goopfile.lock`. If you run into issues while running `make`, try upgrading a problematic package to a newer commit SHA. So far, that has helped solve cryptic nested dependency issues.
+
 ## Todo
 
 * Test that a package test is actually created, perhaps requiring Docker to be running
 * Support Other Linux distros/package types
+* Migrate out of `goop` dependency management
 
 ## How to contribute
 
@@ -98,7 +118,7 @@ Take a look at the TODO list or known issues for some inspiration if you need it
 * [The Docker API docs](http://docs.docker.io/reference/api/docker_remote_api_v1.10/)
 * [The Ruby download page](http://docs.docker.io/reference/api/docker_remote_api_v1.10/)
 * [The go-dockerclient lib](https://github.com/fsouza/go-dockerclient)
-* [go-bindata Github page](github.com/jteeuwen/go-bindata)
+* [go-bindata Github page](https://github.com/kevinburke/go-bindata)
 
 ## LICENSE