build-harness

(β˜… 368)

Collection of Makefiles to facilitate building Golang projects, Dockerfiles, Helm charts, and more

  • .dockerignore
  • .editorconfig
  • .gitignore
  • demo.tape
  • Dockerfile
  • Dockerfile.slim
  • LICENSE
  • Makefile
  • Makefile.helpers
  • README.md
  • README.yaml
  • shell.nix

# Installation Guide

1. Get the code
git clone https://github.com/cloudposse/build-harness

Downloads the entire project code from GitHub to your computer.

cd build-harness

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker/build Build docker image

Type this command into your terminal and run it.

docker/clean Cleanup docker. WARNING!!! IT WILL DELETE ALL UNUSED RESOURCES

Type this command into your terminal and run it.

docker/clean/containers Cleanup docker containers. WARNING!!! IT WILL DELETE ALL UNUSED CONTAINERS

Type this command into your terminal and run it.

docker/clean/images Cleanup docker images. WARNING!!! IT WILL DELETE ALL UNUSED IMAGES

Type this command into your terminal and run it.

docker/clean/images/all Cleanup docker images all. WARNING!!! IT WILL DELETE ALL IMAGES

Type this command into your terminal and run it.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make/lint Lint all makefiles

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation