Feature request: Build in source

[torresxb1]

Describe your idea/feature/enhancement

When building certain runtimes (Java, NodeJS, Python, Ruby, provided/custom), SAM CLI copies the source code and builds in another directory.

However, there are limitations with this approach, some of the main ones being:

• local dependencies with relative paths
  • when we copy the source to another directory to build, relative paths are broken
  • example issue
• build speed
  • the native ability of package managers or other tooling to do build caching and incremental builds can be lost when building in another directory
  • doing extra copy operations could be slow for big projects

Proposal

Adding an option to allow building directly in the source code directory instead.

Additional Details

Runtimes that already build directly in the source code directory: Go, .NET.

Related Issues:

• [sam build/Feature] Turn off use of temp directory, allow to build in current folder #2655
• sam build does not recognise local nodejs projects outside CodeUri #2064
• With Runtime: provided, sam build copies source to a temp dir, breaking builds that use relative paths #2077
• Error: NodejsNpmEsbuildBuilder:EsbuildBundle - Esbuild Failed: X [ERROR] Could not resolve "/opt/nodejs/... #4424
• Custom builder should not copy source files to temp folder aws-lambda-builders#328
• Can we remove the CustomMakeBuilder:CopySource from custom_make workflow? aws-lambda-builders#308
• sam build very slow #3371

[torresxb1]

We're currently working on this feature, prioritizing the provided/custom (Makefile) and NodeJS runtimes first.
We're also seeking feedback for the NodeJS implementation: #4537

[kirilgorbachov]

Hi @torresxb1, Are there any updates?

prioritizing the provided/custom (Makefile) and NodeJS runtimes first

Makefile is already supported, but it does not solve the problems that would be resolved by providing the capability to build in the source code directory. This coping should be optional.

[torresxb1]

Hi @kirilgorbachov, we are still working on the implementation. I unfortunately can't give a timeline, but I will definitely post an update here once it's ready.

The option to build in the source code directory will certainly be optional and the current defaults will be maintained.

[jeremyplichtafc]

A pretty poor workaround for now could be to just change directory back to the original in the makefile and build it. Example with gradle (could be modified to golang or others)

build-SearchHandler:
	bash -c "cd ${OLDPWD} && gradle clean build && cp -rf ./build/classes/* $(ARTIFACTS_DIR)/"

[joshuat]

@kirilgorbachov can you elaborate on this - "Makefile is already supported"? I'm not seeing where building in the source directory is supported for Makefile runtimes.

Also @torresxb1 - is there any update you're able to share with us?

[lucashuy]

Hi all, sorry about the delay in responses. The good news is that building projects in source is now released as of SAM CLI v1.104.0! Build your Node.js projects (including esbuild building methods) and Makefile projects with the new --build-in-source flag for sam build and sam sync.

Closing this issue as complete, please feel free to create a new issue or feature request if you'd like to help improve SAM CLI.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.