BuildMethod: makefile not passing Version parameter

[kaihendry]

Description:

https://github.com/kaihendry/aws-sam-gateway-example/blob/master/Makefile#L14 does not appear to embed Version set by

VERSION = $(shell git rev-parse --abbrev-ref HEAD)-$(shell git rev-parse --short HEAD)

Steps to reproduce:

1. git clone https://github.com/kaihendry/aws-sam-gateway-example.git
2. edit Makefile with your AWS PROFILE
3. make

Observed result:

Version appears unset

Expected result:

 go build -ldflags "-X main.Version=foobar" -o foo
 PORT=3000 ./foo &
 curl -s localhost:3000 | grep Version
 <h1>Version: foobar</h1>

Additional environment details (Ex: Arch Linux)

1. OS: I use Arch btw
2. If using SAM CLI, SAM CLI, version 1.27.2
3. AWS region: ap-souteast-1

Add --debug flag to any SAM CLI commands you are running

2021-08-10 10:50:07,209 | Running workflow 'CustomMakeBuilder'
2021-08-10 10:50:07,209 | Running CustomMakeBuilder:CopySource
2021-08-10 10:50:07,217 | CustomMakeBuilder:CopySource succeeded
2021-08-10 10:50:07,217 | Running CustomMakeBuilder:MakeBuild
2021-08-10 10:50:07,217 | Current Artifacts Directory : /home/hendry/tmp/aws-sam-gateway-example/.aws-sam/build/MainFunction
2021-08-10 10:50:07,218 | executing Make: ['make', '--makefile', '/home/hendry/tmp/aws-sam-gateway-example/Makefile', 'build-MainFunction']
2021-08-10 10:50:07,835 | CustomMakeBuilder:MakeBuild succeeded

[xazhao]

Hey @kaihendry, thanks for posting this issue. I was able to reproduce the issue. I tried to hard-code version number by assign the value directly or using shell echo and the version is showing correctly. I don't think it is a bug of SAM. It might be related to how makefile is executed.

[kaihendry]

When I run make with the VERSION, it works. I think it's got to do something with the way make is executed by sam?

for example, no problem locally with make main:

main:
	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "-X main.Version=$(VERSION)" -o ./main

Which leads me to think that when sam-build is run, it's not properly running GNU Make and evaluating the $(shell).

For example "-X main.Version=$(shell git rev-parse --short HEAD)" doesn't work!

[xazhao]

Looked into the code and found the cause. When we added makefile build method feature we want to build it in isolation. So we're copying it to a temporary directory and building it there. This is why git commands won't work here (if you use shell pwd you can see where it is excuted).
The solution would be using $(shell git --git-dir your_repo). I verified it on my side and I can see the version.

[kaihendry]

I'm not sure how you can reliably set your_repo, given this can be cloned out anywhere? I don't want to have to edit the Makefile with the PWD. Or am I missing something??

[kaihendry]

Is there some env I can rely upon?

[xazhao]

Using --git-dir is a walkaround I can think of. There is no env variable as far as I know.

I will sync up with the team and post updates here.

[super132]

#3349

[joshriverscambia2019]

A variant of the following worked as a workaround for me:

VERSION = $(shell git --git-dir ${PWD}/.git rev-parse --abbrev-ref HEAD)-$(shell git --git-dir ${PWD}/.git rev-parse --short HEAD)

[kaihendry]

@xazhao ideally the go build happens with the .git directory, so that runtime/debug works. I noticed debug.ReadBuildInfo() is broken in SAM / makefile built go deployments. 🤦