Merge pull request #2 from keaz/copilot/fix-ci-build-issue-macos

Fix macOS CI build by ensuring environment variables are available to cargo build

Author: keaz

.github/workflows/ci.yml

@@ -104,13 +104,24 @@ jobs:
         run: rustup target add ${{ matrix.target }}
 
       - name: Build with Cargo
+        env:
+          OPENSSL_DIR: ${{ env.OPENSSL_DIR }}
+          PKG_CONFIG_PATH: ${{ env.PKG_CONFIG_PATH }}
+          LDFLAGS: ${{ env.LDFLAGS }}
+          CPPFLAGS: ${{ env.CPPFLAGS }}
         run: |
           if [[ "${{ matrix.os }}" == "macos-latest" ]]; then
             # Set additional environment variables for macOS build
             export MACOSX_DEPLOYMENT_TARGET=10.15
             export CC=clang
             export CXX=clang++
             
+            # Debug: Print environment variables
+            echo "OPENSSL_DIR: $OPENSSL_DIR"
+            echo "PKG_CONFIG_PATH: $PKG_CONFIG_PATH"
+            echo "LDFLAGS: $LDFLAGS"
+            echo "CPPFLAGS: $CPPFLAGS"
+            
             # Build for x86_64 only for now to test the fix
             echo "Building for x86_64 macOS target..."
             cargo build --release --target ${{ matrix.target_x86 }}

CI_MACOS_FIX.md

@@ -0,0 +1,42 @@
+# macOS CI Build Fix
+
+## Problem
+The GitHub Actions CI workflow (`ci.yml`) was failing when building for macOS. The issue was that environment variables needed for building the rdkafka Rust crate with its native dependencies were not being properly propagated to the cargo build step.
+
+## Root Cause
+While the "Install dependencies on macOS" step correctly set environment variables like `OPENSSL_DIR`, `PKG_CONFIG_PATH`, `LDFLAGS`, and `CPPFLAGS` and added them to `$GITHUB_ENV`, these variables needed to be explicitly available during the cargo build process. The rdkafka-sys crate's build script requires these variables to locate OpenSSL and librdkafka during compilation.
+
+## Solution
+Added an explicit `env:` block to the "Build with Cargo" step that references the environment variables set in previous steps:
+
+```yaml
+- name: Build with Cargo
+  env:
+    OPENSSL_DIR: ${{ env.OPENSSL_DIR }}
+    PKG_CONFIG_PATH: ${{ env.PKG_CONFIG_PATH }}
+    LDFLAGS: ${{ env.LDFLAGS }}
+    CPPFLAGS: ${{ env.CPPFLAGS }}
+  run: |
+    # ... build commands
+```
+
+This ensures that:
+1. `OPENSSL_DIR` - Points to the OpenSSL installation (required by openssl-sys crate)
+2. `PKG_CONFIG_PATH` - Tells pkg-config where to find .pc files for OpenSSL, librdkafka, zstd, and lz4
+3. `LDFLAGS` - Tells the linker where to find the shared libraries
+4. `CPPFLAGS` - Tells the C compiler where to find header files
+
+## Additional Improvements
+Added debug output to print the environment variable values during the build, which will help with troubleshooting if similar issues arise in the future.
+
+## Testing
+The fix should be validated by running the CI workflow on a push to the main branch or by creating a tag. The workflow will:
+1. Install dependencies via Homebrew
+2. Set environment variables
+3. Verify dependencies are installed correctly
+4. Build the project with the environment variables properly set
+5. Create release artifacts
+
+## References
+- CLAUDE.md - Documents the required environment variables for macOS builds
+- `.github/workflows/ci.yml` - The updated CI workflow file