kingchenc
b06ce2678a
## Problem
Plain `go get` + `go build` of the Go binding never worked **as a dependency**:
- cgo `CFLAGS` pointed at `${SRCDIR}/../c/include` — the parent dir is **outside** the Go module, so a proxy-fetched module has no header.
- the library under `./lib` was git-ignored and never shipped; the README told users to `cargo build` it from the workspace, which only works inside a clone, not from the read-only module cache.
cgo has no build hook and Go has no registry, so the only way a consumer's `go get`+build can find the lib is for it to be committed **inside the module the consumer pulls**. Per the design decision, that module is a separate **`wickra-go`** repo (keeps this repo free of committed binaries), populated by the release pipeline — this PR is the in-repo restructure that makes that possible.
## Changes
- **Vendor the header** at `bindings/go/include/wickra.h` (committed copy of `bindings/c/include/wickra.h`); `CFLAGS` → `-I${SRCDIR}/include`. A **CI drift check** fails if the copy goes stale.
- **Per-platform libraries**: cgo `LDFLAGS` become per `GOOS`/`GOARCH`, linking `${SRCDIR}/lib/<goos>_<goarch>/`.
- **CI** stages the host library into `lib/<goos>_<goarch>/` (`RUNNER_OS`/`RUNNER_ARCH` — note `macos-latest` is arm64) and exports `WICKRA_GO_LIBDIR` for the Windows PATH; libraries stay git-ignored here.
- **README**: install via the `wickra-go` module + a contributor build section.
## Validation
- Local **windows/amd64**: `gofmt` clean, `go vet`, `go build`, `go test` all green against the staged library + vendored header.
- Linux/macOS arches → the 3-OS `Go on …` CI job.
Follow-up (Stage 2, separate): create `wickra-lib/wickra-go` + a `release.yml` mirror job (source + 6 platform libs → `lib/<goos>_<goarch>/`, commit + tag), and point the docs at the new import path. Part of the self-contained gap (`todo-11`).
35 lines
1.4 KiB
Plaintext
35 lines
1.4 KiB
Plaintext
# Shell scripts must keep LF line endings so they run on Linux/macOS CI and
|
|
# local shells regardless of the committer's platform autocrlf setting.
|
|
*.sh text eol=lf
|
|
|
|
# The cbindgen-generated C header is committed; pin it to LF so its CI drift
|
|
# check (regenerate + `git diff`) never trips on a CRLF normalization.
|
|
bindings/c/include/wickra.h text eol=lf
|
|
|
|
# C# sources (including the generated binding) are pinned to LF so the committed
|
|
# files stay stable regardless of the committer's autocrlf setting.
|
|
*.cs text eol=lf
|
|
|
|
# Go sources (including the generated binding) are pinned to LF so gofmt's CI
|
|
# check never trips on a CRLF checkout on Windows. The vendored C ABI header is
|
|
# a committed copy of bindings/c/include/wickra.h (the parent dir is outside the
|
|
# Go module), pinned to LF so the drift check never trips on CRLF.
|
|
*.go text eol=lf
|
|
go.mod text eol=lf
|
|
go.sum text eol=lf
|
|
bindings/go/include/wickra.h text eol=lf
|
|
|
|
# Java sources (including the generated binding) are pinned to LF so the
|
|
# committed files stay stable regardless of the committer's autocrlf setting.
|
|
*.java text eol=lf
|
|
|
|
# R binding: `R CMD check` requires LF in sources, Makevars and shell scripts.
|
|
*.R text eol=lf
|
|
*.Rd text eol=lf
|
|
bindings/r/configure text eol=lf
|
|
bindings/r/configure.win text eol=lf
|
|
bindings/r/src/Makevars.in text eol=lf
|
|
bindings/r/src/Makevars.win text eol=lf
|
|
bindings/r/src/wickra.c text eol=lf
|
|
|