From 8f2ef6a57de373cdeb5fb2236dbfd233bb57a15f Mon Sep 17 00:00:00 2001
From: Kristoffer Dalby <kradalby@kradalby.no>
Date: Wed, 27 Oct 2021 06:40:39 +0000
Subject: [PATCH] Prepare for checking in generated code

---
 .dockerignore |  1 -
 .gitignore    |  3 ---
 Dockerfile    | 12 +-----------
 Makefile      |  7 +++++++
 README.md     | 11 +++++------
 5 files changed, 13 insertions(+), 21 deletions(-)

diff --git a/.dockerignore b/.dockerignore
index b7a5c8a8..33f9aea2 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -14,4 +14,3 @@ docker-compose*
 README.md
 LICENSE
 .vscode
-gen/
diff --git a/.gitignore b/.gitignore
index f45c47a5..610550b9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,6 +25,3 @@ config.yaml
 .idea
 
 test_output/ 
-
-# Protobuf generated code
-gen/
diff --git a/Dockerfile b/Dockerfile
index ba248d35..9590070b 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -2,23 +2,13 @@ FROM bufbuild/buf:1.0.0-rc6 as buf
 
 FROM golang:1.17.1-bullseye AS build
 ENV GOPATH /go
-
-COPY --from=buf /usr/local/bin/buf /usr/local/bin/buf
+WORKDIR /go/src/headscale
 
 COPY go.mod go.sum /go/src/headscale/
-WORKDIR /go/src/headscale
 RUN go mod download
 
 COPY . .
 
-RUN go install \
-    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
-    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
-    google.golang.org/protobuf/cmd/protoc-gen-go \
-    google.golang.org/grpc/cmd/protoc-gen-go-grpc
-
-RUN buf generate proto
-
 RUN go install -a -ldflags="-extldflags=-static" -tags netgo,sqlite_omit_load_extension ./cmd/headscale
 RUN test -e /go/bin/headscale
 
diff --git a/Makefile b/Makefile
index 4c1d6134..3ce7025c 100644
--- a/Makefile
+++ b/Makefile
@@ -28,3 +28,10 @@ compress: build
 generate:
 	rm -rf gen
 	buf generate proto
+
+install-protobuf-plugins:
+	go install \
+		github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
+		github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
+		google.golang.org/protobuf/cmd/protoc-gen-go \
+		google.golang.org/grpc/cmd/protoc-gen-go-grpc
diff --git a/README.md b/README.md
index 4e373315..060824b9 100644
--- a/README.md
+++ b/README.md
@@ -71,18 +71,17 @@ To contribute to Headscale you would need the lastest version of [Go](golang.org
 - Protobuf tools:
 
 ```shell 
-go install \
-    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
-    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
-    google.golang.org/protobuf/cmd/protoc-gen-go \
-    google.golang.org/grpc/cmd/protoc-gen-go-grpc
+make install-protobuf-plugins
 ```
 
-Building the project requires the generation of Go code from Protobuf (in `proto/`) and it can be (re-)generated with:
+### Testing and building
+
+Some parts of the project requires the generation of Go code from Protobuf (if changes is made in `proto/`) and it must be (re-)generated with:
 
 ```shell
 make generate
 ```
+**Note**: Please check in changes from `gen/` in a separate commit to make it easier to review.
 
 To run the tests: