add comment for CGO flags setting

.github/workflows/build-test-release.yml

@@ -41,7 +41,7 @@ jobs:
           go-version: 1.18
       - run: go test -v -timeout 10m -race ./...
         env:
-          CGO_CFLAGS: "-O -D__BLST_PORTABLE__"
+          CGO_CFLAGS: "-O -D__BLST_PORTABLE__" # Set the CGO flags to use the portable version of BLST
   e2e_test:
     name: e2e tests
     runs-on: ubuntu-latest

.goreleaser.yml

@@ -15,7 +15,7 @@ builds:
       - arm64
     env:
       - CGO_ENABLED=1
-      - CGO_CFLAGS=-O -D__BLST_PORTABLE__
+      - CGO_CFLAGS=-O -D__BLST_PORTABLE__ # Set the CGO flags to use the portable version of BLST
     overrides:
       - goos: linux
         goarch: arm64

scripts/build.sh

@@ -15,5 +15,10 @@ else
     OUTPUT=$1
 fi
 
+# Set the CGO flags to use the portable version of BLST
+#
+# We use "export" here instead of just setting a bash variable because we need
+# to pass this flag to all child processes spawned by the shell.
 export CGO_CFLAGS="-O -D__BLST_PORTABLE__"
+
 go build -v -ldflags="-X 'github.com/ava-labs/avalanche-network-runner/cmd.Version=$VERSION'" -o $OUTPUT/avalanche-network-runner

scripts/tests.e2e.sh

@@ -131,10 +131,15 @@ fi
 echo "building runner"
 ./scripts/build.sh
 
+# Set the CGO flags to use the portable version of BLST
+#
+# We use "export" here instead of just setting a bash variable because we need
+# to pass this flag to all child processes spawned by the shell.
+export CGO_CFLAGS="-O -D__BLST_PORTABLE__"
+
 echo "building e2e.test"
 # to install the ginkgo binary (required for test build and run)
 go install -v github.com/onsi/ginkgo/v2/[email protected]
-export CGO_CFLAGS="-O -D__BLST_PORTABLE__"
 ACK_GINKGO_RC=true ginkgo build ./tests/e2e
 ./tests/e2e/e2e.test --help