aws / aws/aws-codebuild-docker-images

Better guidance for using `amazon/aws-codebuild-local`

Open
#252 6 comments 21 reactions 0 assignees View on GitHub
CodeBuild-local
Dominant language
Dockerfile
Stars
1.2k
Forks
971
Avg merge
2h 47m
Merged PRs (30d)
1

Description

I've been trying to use `amazon/aws-codebuild-local` to debug some build failures, and it's not clear at all how the environment variables are used. Some guidance and examples would be really welcome. In particular:

* `IMAGE` - Took a long time for me to realize I had to build my own local version of the codebuild images in order to specify a value here. I thought I could use the codebuild images (`aws/codebuild/standard:2.0`) but obviously doesn't work.
* `SOURCE` - Does codebuild expect to download my source from GitHub or similar, or can I just mount it into the container?
* aws credentials - Does the local container need my credentials for anything? How do I pass them along?

Finally, I'm on Windows and the fact that `codebuild_build.sh` is a bash script is painful. I've had to reverse engineer it to figure out how it is calling the `amazon/aws-codebuild-local` image.

Contributor guide

Open the contributing guide

Research direction

Start with the referenced codebuild_build.sh script and the amazon/aws-codebuild-local image invocation. Document how IMAGE, SOURCE, and AWS credentials are used, including mounting local source, and explain a practical Windows alternative to the Bash script; done means the guidance includes examples for each case.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, bash, docker
Domain
cloud, devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.