Merge pull request #781 from strukturag/keep-generated-files

Keep generated files in the repository.

.github/workflows/generated.yml

@@ -0,0 +1,48 @@
+name: generated
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - '.github/workflows/generated.yml'
+      - 'api*.go'
+      - '*_easyjson.go'
+      - '*.pb.go'
+      - '*.proto'
+      - 'go.*'
+  pull_request:
+    branches: [ master ]
+    paths:
+      - '.github/workflows/generated.yml'
+      - 'api*.go'
+      - '*_easyjson.go'
+      - '*.pb.go'
+      - '*.proto'
+      - 'go.*'
+
+permissions:
+  contents: read
+
+jobs:
+  check-generated:
+    name: check-generated
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "stable"
+
+      - name: Install dependencies
+        run: |
+          sudo apt -y update && sudo apt -y install protobuf-compiler
+
+      - name: Generate files
+        run: |
+          make common
+
+      - name: Check generated files
+        run: |
+          git add *.go
+          git diff --cached --exit-code *.go

.github/workflows/govuln.yml

@@ -34,11 +34,6 @@ jobs:
 
     - run: date
 
-    - name: Install dependencies
-      run: |
-        sudo apt -y update && sudo apt -y install protobuf-compiler
-        make common
-
     - name: Install and run govulncheck
       run: |
         set -euo pipefail

.github/workflows/licensecheck.yml

@@ -39,7 +39,7 @@ jobs:
 
       - name: Check for missing licenses
         run: |
-          MISSING=$(echo "$CHECK_RESULT" | grep UNKNOWN || true)
+          MISSING=$(echo "$CHECK_RESULT" | grep -v "_easyjson.go" | grep UNKNOWN || true)
           if [ -n "$MISSING" ]; then \
             echo "$MISSING"; \
             exit 1; \

.github/workflows/lint.yml

@@ -30,11 +30,6 @@ jobs:
         with:
           go-version: "1.21"
 
-      - name: Install dependencies
-        run: |
-          sudo apt -y update && sudo apt -y install protobuf-compiler
-          make common
-
       - name: lint
         uses: golangci/[email protected]
         with:

.github/workflows/tarball.yml

@@ -33,10 +33,6 @@ jobs:
       with:
         go-version: ${{ matrix.go-version }}
 
-    - name: Install dependencies
-      run: |
-        sudo apt -y update && sudo apt -y install protobuf-compiler
-
     - name: Create tarball
       run: |
         echo "Building with $(nproc) threads"
@@ -61,10 +57,6 @@ jobs:
       with:
         go-version: ${{ matrix.go-version }}
 
-    - name: Install dependencies
-      run: |
-        sudo apt -y update && sudo apt -y install protobuf-compiler
-
     - name: Download tarball
       uses: actions/download-artifact@v4
       with:

.github/workflows/test.yml

@@ -36,10 +36,6 @@ jobs:
       with:
         go-version: ${{ matrix.go-version }}
 
-    - name: Install dependencies
-      run: |
-        sudo apt -y update && sudo apt -y install protobuf-compiler
-
     - name: Build applications
       run: |
         echo "Building with $(nproc) threads"

.gitignore

@@ -1,9 +1,7 @@
 bin/
 vendor/
 
-*_easyjson.go
 *.pem
-*.pb.go
 *.prof
 *.socket
 *.tar.gz

Makefile

@@ -95,20 +95,20 @@ get:
 fmt: hook | $(PROTO_GO_FILES)
 	$(GOFMT) -s -w *.go client proxy server
 
-vet: common
+vet:
 	$(GO) vet $(ALL_PACKAGES)
 
-test: vet common
+test: vet
 	$(GO) test -timeout $(TIMEOUT) $(TESTARGS) $(ALL_PACKAGES)
 
-cover: vet common
+cover: vet
 	rm -f cover.out && \
 	$(GO) test -timeout $(TIMEOUT) -coverprofile cover.out $(ALL_PACKAGES) && \
 	sed -i "/_easyjson/d" cover.out && \
 	sed -i "/\.pb\.go/d" cover.out && \
 	$(GO) tool cover -func=cover.out
 
-coverhtml: vet common
+coverhtml: vet
 	rm -f cover.out && \
 	$(GO) test -timeout $(TIMEOUT) -coverprofile cover.out $(ALL_PACKAGES) && \
 	sed -i "/_easyjson/d" cover.out && \
@@ -123,34 +123,34 @@ coverhtml: vet common
 	PATH="$(GODIR)":"$(GOPATHBIN)":$(PATH) protoc \
 		--go_out=. --go_opt=paths=source_relative \
 		$*.proto
+	sed -i -e '1h;2,$$H;$$!d;g' -re 's|// versions.+// source:|// source:|' $*.pb.go
 
 %_grpc.pb.go: %.proto $(GOPATHBIN)/protoc-gen-go $(GOPATHBIN)/protoc-gen-go-grpc
 	PATH="$(GODIR)":"$(GOPATHBIN)":$(PATH) protoc \
 		--go-grpc_out=. --go-grpc_opt=paths=source_relative \
 		$*.proto
+	sed -i -e '1h;2,$$H;$$!d;g' -re 's|// versions.+// source:|// source:|' $*_grpc.pb.go
 
 common: $(EASYJSON_GO_FILES) $(PROTO_GO_FILES)
 
 $(BINDIR):
 	mkdir -p "$(BINDIR)"
 
-client: common $(BINDIR)
+client: $(BINDIR)
 	$(GO) build $(BUILDARGS) -ldflags '$(INTERNALLDFLAGS)' -o "$(BINDIR)/client" ./client/...
 
-server: common $(BINDIR)
+server: $(BINDIR)
 	$(GO) build $(BUILDARGS) -ldflags '$(INTERNALLDFLAGS)' -o "$(BINDIR)/signaling" ./server/...
 
-proxy: common $(BINDIR)
+proxy: $(BINDIR)
 	$(GO) build $(BUILDARGS) -ldflags '$(INTERNALLDFLAGS)' -o "$(BINDIR)/proxy" ./proxy/...
 
 clean:
-	rm -f $(EASYJSON_GO_FILES)
 	rm -f easyjson-bootstrap*.go
-	rm -f $(PROTO_GO_FILES)
 
 build: server proxy
 
-vendor: go.mod go.sum common
+vendor: go.mod go.sum
 	set -e ;\
 	rm -rf $(VENDORDIR)
 	$(GO) mod vendor

README.md

@@ -19,11 +19,14 @@ The following tools are required for building the signaling server.
 - git
 - go >= 1.21
 - make
-- protobuf-compiler >= 3
 
 Usually the last two versions of Go are supported. This follows the release
 policy of Go: https://go.dev/doc/devel/release#policy
 
+These additional tools are required to generate code from `.proto` files.
+
+- protobuf-compiler >= 3
+
 All other dependencies are fetched automatically while building.
 
     $ make build