Shared library builds fails, if header file is missing,

[jkroepke]

In my case I'm building a c-shared artifact which does not generate a .h file. I can reproduce that with a simple go build -buildmode=c-shared. No header files are present.

However, in go releaser they seems mandatory.

Downloading https://github.com/goreleaser/goreleaser/releases/download/v2.12.6/goreleaser_Linux_x86_64.tar.gz
Extracting GoReleaser
/usr/bin/tar xz --warning=no-unknown-keyword --overwrite -C /home/runner/work/_temp/9f87a455-98b0-462d-9797-7ed92693958b -f /home/runner/work/_temp/9dfd4dd3-3eb2-4fca-8a9b-abfcf49d47d3
GoReleaser v2.12.6 installed successfully
/opt/hostedtoolcache/goreleaser-action/2.12.6/x64/goreleaser release --snapshot
  • skipping announce, publish, and validate...
  • loading environment variables
  • getting and validating git state
    • git state                                      commit=d1a9b42111c47f73d7103bd9e1db65fc3a695288 branch=HEAD current_tag=v1.26.2 previous_tag=v1.26.1 dirty=false
    • pipe skipped or partially skipped              reason=disabled during snapshot mode
  • parsing tag
  • setting defaults
  • snapshotting
    • building snapshot...                           version=1.26.2-SNAPSHOT-d1a9b42
  • running before hooks
    • running                                        hook=rm -rf 3rdpartylicenses
    • running                                        hook=make 3rdpartylicenses
      • took: 9s
  • ensuring distribution directory
  • setting up metadata
  • writing release metadata
  • loading go mod information
  • build prerequisites
  • checking go.mod
  • building binaries
    • building                                       binary=dist/openvpn-auth-oauth2_freebsd_arm64_v8.0/openvpn-auth-oauth2
    • building                                       binary=dist/openvpn-auth-oauth2_freebsd_amd64_v1/openvpn-auth-oauth2
    • building                                       binary=dist/openvpn-auth-oauth2_linux_amd64_v1/openvpn-auth-oauth2
    • building                                       binary=dist/openvpn-auth-oauth2_linux_arm64_v8.0/openvpn-auth-oauth2
    • building                                       binary=dist/openvpn-auth-oauth2_openbsd_amd64_v1/openvpn-auth-oauth2
    • building                                       binary=dist/openvpn-auth-oauth2_openbsd_arm64_v8.0/openvpn-auth-oauth2
    • building                                       binary=dist/lib-openvpn-auth-oauth2_linux_amd64_v1/openvpn-auth-oauth2-linux-amd64.so
    • building                                       binary=dist/lib-openvpn-auth-oauth2_linux_arm64_v8.0/openvpn-auth-oauth2-linux-arm64.so
      • took: 1m19s
  • archives
    • archiving                                      name=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_freebsd_arm64.tar.xz
    • archiving                                      name=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_arm64.tar.xz
    • archiving                                      name=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_openbsd_arm64.tar.xz
    • archiving                                      name=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_openbsd_amd64.tar.xz
    • archiving                                      name=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_freebsd_amd64.tar.xz
    • archiving                                      name=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_amd64.tar.xz
  • linux packages
    • creating                                       package=openvpn-auth-oauth2 format=deb arch=arm64v8.0 file=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_arm64.deb
    • creating                                       package=openvpn-auth-oauth2 format=deb arch=amd64v1 file=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_amd64.deb
    • creating                                       package=openvpn-auth-oauth2 format=rpm arch=arm64v8.0 file=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_arm64.rpm
    • creating                                       package=openvpn-auth-oauth2 format=rpm arch=amd64v1 file=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_amd64.rpm
  • cataloging artifacts
    • cataloging                                     cmd=syft artifact=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_freebsd_arm64.tar.xz sbom=[openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_freebsd_arm64.tar.xz.sbom.json]
    • cataloging                                     cmd=syft artifact=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_arm64.tar.xz sbom=[openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_arm64.tar.xz.sbom.json]
    • cataloging                                     cmd=syft artifact=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_openbsd_arm64.tar.xz sbom=[openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_openbsd_arm64.tar.xz.sbom.json]
    • cataloging                                     cmd=syft artifact=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_openbsd_amd64.tar.xz sbom=[openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_openbsd_amd64.tar.xz.sbom.json]
    • cataloging                                     cmd=syft artifact=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_freebsd_amd64.tar.xz sbom=[openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_freebsd_amd64.tar.xz.sbom.json]
    • cataloging                                     cmd=syft artifact=dist/openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_amd64.tar.xz sbom=[openvpn-auth-oauth2_1.26.2-SNAPSHOT-d1a9b42_linux_amd64.tar.xz.sbom.json]
      • took: 11s
  • calculating checksums
  • size reports
    • 9.938MiB                                       path=dist/openvpn-auth-oauth2_freebsd_arm64_v8.0/openvpn-auth-oauth2
    • 10.67MiB                                       path=dist/openvpn-auth-oauth2_freebsd_amd64_v1/openvpn-auth-oauth2
    • 10.71MiB                                       path=dist/openvpn-auth-oauth2_linux_amd64_v1/openvpn-auth-oauth2
  ⨯ release failed after 1m44s                       error=stat dist/lib-openvpn-auth-oauth2_linux_amd64_v1/openvpn-auth-oauth2-linux-amd64.h: no such file or directory

Config: https://github.com/jkroepke/openvpn-auth-oauth2/blob/f4922018c377c64bb4989ca90131b7e681b3b323/.goreleaser.yaml

[calico32]

I'm also having this issue that prevents me from using goreleaser in my project—in my case, it doesn't make sense to publish a header with the shared library because it's irrelevant to end users. I couldn't figure out a way to skip adding the header or skip uploading it to release.

https://github.com/calico32/waybar-niri-windows/blob/1f4b4d470c1d0081b58496e0f62a07bbf2358c09/.goreleaser.yaml

[caarlos0]

Problem seems to be here:

goreleaser/internal/builders/golang/build.go

Lines 285 to 292 in 9e21891

	if build.Buildmode == "c-archive" {
	a.Type = artifact.CArchive
	ctx.Artifacts.Add(getHeaderArtifactForLibrary(build, options))
	}
	if build.Buildmode == "c-shared" && !strings.Contains(t.Target, "wasm") {
	a.Type = artifact.CShared
	ctx.Artifacts.Add(getHeaderArtifactForLibrary(build, options))
	}

When is it correct to actually also add the header? 🤔 Or maybe we should simply check if such file exists before adding it? 🤔

[calico32]

From my testing I believe the header is only generated if there are cgo //export comments in the main package. Go doesn't generate a header if they are in a different module that is imported into the main module, as in:

// cgo-test/lib/lib.go
package lib

import "C"

//export foo
func foo() C.int {
	return C.int(42)
}

// cgo-test/main.go
package main

import _ "cgo-test/lib"
import "C"

func main() {}

Running go build -buildmode=c-shared -o cgo-test.so . on this doesn't create a header file.

[jkroepke]

Can confirm this.

[caarlos0]

so, probably, the most correct fix is to verify if the file exists before adding it to the context. 🤔

[caarlos0]

can you try #6254

[calico32]

👍 That does the trick for me!