Merge pull request #26 from x1unix/feat/arm64

feat: Windows on ARM support

Author: x1unix

.dockerignore

@@ -1,6 +1,7 @@
 .gitignore
 .idea
 .vscode
+.github
 Makefile
 README.md
 tools

.github/workflows/release.yml

@@ -5,8 +5,6 @@ on:
   release:
     types:
       - created
-  repository_dispatch:
-    types: manual-deploy
 jobs:
   build:
     name: Build image

.gitignore

@@ -1,3 +1,3 @@
 .vscode
 .idea
-
+.DS_Store

Dockerfile

@@ -1,11 +1,25 @@
-ARG GO_VERSION=1.15
-FROM golang:${GO_VERSION}-bullseye
+ARG GO_VERSION=1.20
+FROM golang:${GO_VERSION}-bookworm as builder
+ARG GO_VERSION
+ARG LLVM_MINGW64_VER=20240606
+ARG LLVM_MINGW64_SRC="https://github.com/mstorsjo/llvm-mingw/releases/download"
+ENV LLVM_MINGW64_VER="${LLVM_MINGW64_VER}"
+ENV LLVM_MINGW64_SRC="$LLVM_MINGW64_SRC"
+
+WORKDIR /tmp
+COPY --chmod=0755 scripts/setup-llvm-mingw64.sh /tmp/
+RUN /tmp/setup-llvm-mingw64.sh
+
+ARG GO_VERSION
+FROM golang:${GO_VERSION}-bookworm
 
 RUN apt update &&\
     apt install \
     make mingw-w64 bash --yes
-ADD docker-entrypoint.sh /usr/bin/docker-entrypoint.sh
-RUN chmod +x /usr/bin/docker-entrypoint.sh
+COPY --chmod=0755 scripts/docker-entrypoint.sh /usr/bin/docker-entrypoint.sh
+COPY --chmod=0755 scripts/install-llvm-mingw64.sh /tmp/install-llvm-mingw64.sh 
+COPY --from=builder /tmp/llvm-mingw64 /tmp/llvm-mingw64
+RUN /tmp/install-llvm-mingw64.sh /tmp/llvm-mingw64
 ENV PATH=/go/bin:$PATH \
     CGO_ENABLED=1 \
     GOOS=windows

Makefile

@@ -1,7 +1,8 @@
 IMG_NAME = x1unix/go-mingw-test
+DOCKER_OUT_TYPE=docker
 
 .PHONY: image
 image:
 	@if [ -z $(GO_VERSION) ]; then echo "usage: 'make image GO_VERSION=[GO VERSION NUMBER]'" && exit 1; fi; \
 	echo ":: Building image..." &&\
-	docker build -t $(IMG_NAME):$(GO_VERSION) -f Dockerfile . --build-arg GO_VERSION=$(GO_VERSION)
+	docker build --output=type=$(DOCKER_OUT_TYPE) -t $(IMG_NAME):$(GO_VERSION) -f Dockerfile . --build-arg GO_VERSION=$(GO_VERSION)

README.md

@@ -7,6 +7,17 @@ Docker image for building Go binaries for **Windows** with MinGW-w64 toolchain b
 
 Image provides simple cross-compilation environment for windows 32 and 64bit builds.
 
+**Supports Windows on Arm!**
+
+## Supported Architectures
+
+Here is a list of supported host and target architectures:
+
+| Host Architecture   | Win x86 | Win x86-64 | Win Arm |
+| ------------------- | ------- | ---------- | ------- |
+| **arm64 / aarch64** | ✅      |  ✅        | ✅      |
+| **amd64**           | ✅      |  ✅        | ✅      |
+
 ## Usage
 
 You can pull Docker image with desired Go version from Docker Hub:
@@ -16,7 +27,7 @@ docker pull x1unix/go-mingw:latest # or "1.21" for specific Go version
 ```
 
 > [!TIP]
-> Please take a look at [full project build example](example/sqlite-app) before starting to work.
+> Please take a look at [examples](example/) before starting to work.
 
 ### Building Go applications inside container
 
@@ -30,7 +41,17 @@ docker run --rm -it -v /YourPackageSrc:/go/work \
 
 You will get compiled Windows binary.
 
-**For 32-bit toolchain**
+#### Windows On Arm
+
+Set `GOARCH=arm64` to build ARM Windows binary:
+
+```shell
+docker run --rm -it -e GOARCH=arm64 -v /YourPackageSrc:/go/work \
+    -w /go/work \
+    x1unix/go-mingw go build .
+```
+
+#### For 32-bit toolchain
 
 To build a 32-bit executable, set `GOARCH=386` variable:
 
@@ -41,7 +62,7 @@ docker run --rm -it -e GOARCH=386 -v /YourPackageSrc:/go/work \
 ```
 
 > [!TIP]
-> See full project build example [here](example/sqlite-app).
+> See check project build examples [here](example).
 
 ### Go linker flags override
 
@@ -124,3 +145,8 @@ make image GO_VERSION=1.20
 > [!IMPORTANT]
 > Replace `1.20` with desired Go version.
 
+## Credits
+
+* [llvm-mingw](https://github.com/mstorsjo/llvm-mingw) for Windows on Arm support.
+* [mingw-w64](https://www.mingw-w64.org/) - for Windows on x86 and amd64 support.
+* The Go maintainers.

example/README.md

@@ -0,0 +1,6 @@
+# Examples
+
+This directory contains various examples of Go projects with CGO and cross-compilation scripts that use this Docker image.
+
+* [hello](hello) - Simple app that uses CGO with WinAPI.
+* [sqlite-app](sqlite-app) - Example that uses CGO for SQLite driver.

example/hello/.gitignore

@@ -0,0 +1,4 @@
+.vscode
+.idea
+*.exe
+*.db

example/hello/Makefile

@@ -0,0 +1,31 @@
+GO_VERSION := 1.21 # or "latest" for bleeding-edge Go version
+GO_BUILD_FLAGS := -x
+GOCACHE ?= $(shell go env GOCACHE)
+GOPATH ?= $(shell go env GOPATH)
+
+define docker_build
+@echo ":: Building for $(1) in MinGW container..."
+docker run --rm -it \
+	-e GOCACHE=/go/.cache \
+	-e GOARCH=$(1) \
+	-v "$(GOCACHE)":/go/.cache \
+	-v "$(GOPATH)/src":/go/src \
+	-v "$(GOPATH)/pkg":/go/pkg \
+	-v "$(PWD)":/go/work \
+	-w /go/work \
+	x1unix/go-mingw:$(GO_VERSION) \
+	go build $(GO_BUILD_FLAGS) -o hello-$(1).exe .
+endef
+
+.PHONY:all
+all: build-amd64 build-i386 build-arm64
+
+.PHONY: build-amd64 build-i386 build-arm64
+build-amd64:
+	$(call docker_build,amd64)
+
+build-i386:
+	$(call docker_build,386)
+
+build-arm64:
+	$(call docker_build,arm64)

example/hello/README.md

@@ -0,0 +1,7 @@
+# CGO Hello World
+
+![demo](demo.png)
+
+This is a simple app with CGO and invokes `MessageBox` function from WinAPI.
+
+Run `make` to cross-compile program.