[nix] Install protobuf codegen binaries in the dev shell (#3829)

Author: maru-ava

.github/workflows/buf-push.yml

@@ -21,4 +21,5 @@ jobs:
           # Breaking changes are managed by the rpcchainvm protocol version.
           breaking: false
           token: ${{ secrets.BUF_TOKEN }}
+          # This version should match the version installed in the nix dev shell
           version: 1.47.2

.github/workflows/ci.yml

@@ -150,18 +150,17 @@ jobs:
           # which is never desirable for this job. The buf-push job is
           # responsible for pushes.
           push: false
+          # This version should match the version installed in the nix dev shell
           version: 1.47.2
   check_generated_protobuf:
     name: Up-to-date protobuf
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup-go-for-project
-      - uses: bufbuild/buf-action@1b8e0a0e793562b7850d7e6ff0228b5c0b16111c #v1.1.0
-        with:
-          setup_only: true
-          version: 1.47.2
-      - shell: bash
+      # Use the dev shell instead of bufbuild/buf-action to ensure the dev shell provides the expected versions
+      - uses: ./.github/actions/install-nix
+      - shell: nix develop --command bash -x {0}
         run: scripts/protobuf_codegen.sh
       - shell: bash
         run: .github/workflows/check-clean-branch.sh

flake.lock

@@ -8,7 +8,7 @@
 
   # Flake inputs
   inputs = {
-    nixpkgs.url = "https://flakehub.com/f/NixOS/nixpkgs/0.2405.*.tar.gz";
+    nixpkgs.url = "https://flakehub.com/f/NixOS/nixpkgs/0.2411.*.tar.gz";
   };
 
   # Flake outputs
@@ -45,6 +45,11 @@
 
             # Linters
             shellcheck
+
+            # Protobuf
+            buf
+            protoc-gen-go
+            protoc-gen-go-grpc
           ] ++ lib.optionals stdenv.isDarwin [
             # macOS-specific frameworks
             darwin.apple_sdk.frameworks.Security

flake.nix

@@ -9,10 +9,10 @@ breaking:
   use:
     - FILE
 deps:
-  - buf.build/prometheus/client-model 
+  - buf.build/prometheus/client-model
 lint:
   use:
-    - DEFAULT
+    - STANDARD
   except:
     - SERVICE_SUFFIX # service requirement of <name>+Service
     - RPC_REQUEST_STANDARD_NAME # explicit <rpc>+Request naming
@@ -24,7 +24,7 @@ lint:
     - aliasreader/aliasreader.proto
     - net/conn/conn.proto
   # allows RPC requests or responses to be google.protobuf.Empty messages. This can be set if you
-  # want to allow messages to be void forever, that is they will never take any parameters. 
+  # want to allow messages to be void forever, that is they will never take any parameters.
   rpc_allow_google_protobuf_empty_requests: true
   rpc_allow_google_protobuf_empty_responses: true
   # allows the same message type to be used for a single RPC's request and response type.

proto/buf.yaml

@@ -7,27 +7,25 @@ if ! [[ "$0" =~ scripts/protobuf_codegen.sh ]]; then
   exit 255
 fi
 
+# the versions here should match those of the binaries installed in the nix dev shell
+
 ## ensure the correct version of "buf" is installed
 BUF_VERSION='1.47.2'
 if [[ $(buf --version | cut -f2 -d' ') != "${BUF_VERSION}" ]]; then
   echo "could not find buf ${BUF_VERSION}, is it installed + in PATH?"
   exit 255
 fi
 
-## install "protoc-gen-go"
+## ensure the correct version of "protoc-gen-go" is installed
 PROTOC_GEN_GO_VERSION='v1.35.1'
-go install -v google.golang.org/protobuf/cmd/protoc-gen-go@${PROTOC_GEN_GO_VERSION}
 if [[ $(protoc-gen-go --version | cut -f2 -d' ') != "${PROTOC_GEN_GO_VERSION}" ]]; then
-  # e.g., protoc-gen-go v1.28.1
   echo "could not find protoc-gen-go ${PROTOC_GEN_GO_VERSION}, is it installed + in PATH?"
   exit 255
 fi
 
-### install "protoc-gen-go-grpc"
+## ensure the correct version of "protoc-gen-go-grpc" is installed
 PROTOC_GEN_GO_GRPC_VERSION='1.3.0'
-go install -v google.golang.org/grpc/cmd/protoc-gen-go-grpc@v${PROTOC_GEN_GO_GRPC_VERSION}
 if [[ $(protoc-gen-go-grpc --version | cut -f2 -d' ') != "${PROTOC_GEN_GO_GRPC_VERSION}" ]]; then
-  # e.g., protoc-gen-go-grpc 1.3.0
   echo "could not find protoc-gen-go-grpc ${PROTOC_GEN_GO_GRPC_VERSION}, is it installed + in PATH?"
   exit 255
 fi