feat(windows): build windows compressed file (#1860)

Author: sigilioso

.github/workflows/component_packages.yml

@@ -47,7 +47,8 @@ jobs:
           toolchain: ${{ env.RUST_VERSION }}
           targets: >-
             aarch64-unknown-linux-musl,
-            x86_64-unknown-linux-musl
+            x86_64-unknown-linux-musl,
+            x86_64-pc-windows-msvc
 
       - name: cargo generate-lockfile
         if: hashFiles('Cargo.lock') == ''
@@ -70,6 +71,14 @@ jobs:
         run: |
           cargo install --locked cargo-zigbuild --force
 
+      - name: Install Windows cross-compilation dependencies
+        run: |
+          sudo apt-get install -y llvm
+
+      - name: Install cargo-xwin
+        run: |
+          cargo install --locked cargo-xwin --force
+
       - name: Set tag and skip_upload=false for pre-release
         if: ${{ inputs.pre-release}}
         run: |
@@ -83,12 +92,12 @@ jobs:
         if: ${{ ! inputs.pre-release }}
         run: |
           git tag ${{ inputs.tag_name }}
-          echo SKIP_UPLOAD=--skip=publish >> $GITHUB_ENV 
-      
+          echo SKIP_UPLOAD="--skip=publish" >> $GITHUB_ENV
+
       - name: Skip packages sign
         if: ${{ inputs.skip_sign }}
         run: |
-          echo SKIP_SIGN=--skip=sign >> $GITHUB_ENV 
+          echo SKIP_SIGN="--skip=sign" >> $GITHUB_ENV
 
       - name: Release packages with GoReleaser
         uses: goreleaser/goreleaser-action@v6

.goreleaser.yml

@@ -6,8 +6,10 @@ env:
   - NEWRELIC_INFRA_AGENT_VERSION=1.71.1
   - NR_OTEL_COLLECTOR_VERSION=1.5.0
 builds:
-  - id: newrelic-agent-control
+  # Linux builds using cargo zigbuild
+  - id: newrelic-agent-control-linux
     builder: rust
+    command: zigbuild
     binary: newrelic-agent-control
     targets:
       - x86_64-unknown-linux-musl
@@ -29,8 +31,28 @@ builds:
         - cmd: ./build/scripts/download_collector_config.sh
           env:
             - NR_OTEL_COLLECTOR_VERSION={{ .Env.NR_OTEL_COLLECTOR_VERSION }}
-  - id: newrelic-agent-control-cli
+
+  # Windows builds using cargo xwin
+  - id: newrelic-agent-control-windows
+    builder: rust
+    binary: newrelic-agent-control
+    tool: cargo-xwin
+    command: build
+    targets:
+      - x86_64-pc-windows-msvc
+    flags:
+      - --release
+      - --package=newrelic_agent_control
+      - --bin=newrelic-agent-control
+    env:
+      - AGENT_CONTROL_VERSION={{ .Version }}
+      - NEWRELIC_INFRA_AGENT_VERSION={{ .Env.NEWRELIC_INFRA_AGENT_VERSION }}
+      - NR_OTEL_COLLECTOR_VERSION={{ .Env.NR_OTEL_COLLECTOR_VERSION }}
+
+  # Linux builds for CLI
+  - id: newrelic-agent-control-cli-linux
     builder: rust
+    command: zigbuild
     binary: newrelic-agent-control-cli
     targets:
       - x86_64-unknown-linux-musl
@@ -42,14 +64,31 @@ builds:
     env:
       - AGENT_CONTROL_VERSION={{ .Version }}
 
+  # Windows builds for CLI using cargo xwin
+  - id: newrelic-agent-control-cli-windows
+    builder: rust
+    binary: newrelic-agent-control-cli
+    tool: cargo-xwin
+    command: build
+    targets:
+      - x86_64-pc-windows-msvc
+    flags:
+      - --release
+      - --package=newrelic_agent_control
+      - --bin=newrelic-agent-control-cli
+    env:
+      - AGENT_CONTROL_VERSION={{ .Version }}
+    hooks:
+      pre:
+        # Wait for newrelic-agent-control to be ready (parallel executions of cargo-xwin can be problematic)
+        - cmd: sh -c 'while [ ! -f target/x86_64-pc-windows-msvc/release/newrelic-agent-control.exe ]; do echo "Waiting for newrelic-agent-control-windows build to complete..."; sleep 5; done'
+          output: true
+
 archives:
   - formats: tar.gz
     name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
-    ids:
-      - newrelic-agent-control
-      - newrelic-agent-control-cli
 
-nfpms:
+nfpms: # deb and rpm are only built for linux targets
   - package_name: newrelic-agent-control
 
     # Replace arch for rpm from amd64 to x86_64 to be consistent with our rpm repo.
@@ -165,8 +204,8 @@ nfpms:
 
     id: newrelic-agent-control
     ids:
-      - newrelic-agent-control
-      - newrelic-agent-control-cli
+      - newrelic-agent-control-linux
+      - newrelic-agent-control-cli-linux
     formats:
       - deb
       - rpm

docs/DEVELOPMENT.md

@@ -53,6 +53,28 @@ To compile and run locally:
 
 8. Execute the binary with the config file with `sudo ./target/debug/newrelic-agent-control`
 
+#### Cross-compilation for Windows
+
+The steps below work for the `x86_64-pc-windows-msvc` target only. It is also possible to compile the project for the `x86_64-pc-windows-gnu` target using `cargo-zigbuild`.
+
+1. Install the [Rust toolchain](https://www.rust-lang.org/tools/install): `rustup target add x86_64-pc-windows-msvc`
+2. Install [cargo-xwin](https://github.com/rust-cross/cargo-xwin) and dependencies.
+   Example for macOs:
+
+   ```bash
+   ❯ brew install cmake ninja llvm
+   ❯ cargo install --locked cargo-xwin
+   ```
+
+3. Compile agent-control:
+
+   ```bash
+   ❯ cargo xwin build --bin newrelic-agent-control --target x86_64-pc-windows-msvc --release
+   ```
+
+   ⚠️ This method doesn't work for building debug binaries (`--release` is required). As `cargo-xwin` doesn't provide `msvcrtd.lib` (the debug version of the C runtime library).
+
+
 #### Filesystem layout and persistence
 
 The following shows the directory structure used by Agent Control, assuming an existing sub-agent with the ID `newrelic-infra`: