Containarize application

Provide a multi-stage dockerfile capable of caching dependencies
and producing a live image and a development image to help with the
development setup, and others.

This also comes with a new CI step to validate the (expected) final
image can be built.

Author: siryur

.github/workflows/push.yml

@@ -51,3 +51,14 @@ jobs:
             git status --porcelain
             exit 1
           fi
+
+  container_build:
+    name: "build container image"
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: "Fetch source code"
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: "Build container image"
+        run: |
+          docker build --output type=docker -t terraform-config-inspect:ci-${{ github.run_id }}-${{ github.run_number }} -f build/Dockerfile .

README.md

@@ -139,6 +139,20 @@ $ terraform-config-inspect --json path/to/module
 }
 ```
 
+## Containarized
+
+One can build a container version of this application with the following
+oneliner:
+`docker build -t terraform-config-inspect:latest -f build/Dockerfile .`
+
+Feel free to use our development stage to debug or when contributing to this
+project by including the `--target dev` in the container build phase.
+
+Example:
+- How to use the generated image if you current context is the module you want
+  to analyize:
+  `docker run -it -v $(pwd):/$(pwd) -w $(pwd) terraform-config-inspect:latest`
+
 ## Contributing
 
 This library and tool are intentionally focused on only extracting simple

build/Dockerfile

@@ -0,0 +1,65 @@
+ARG BUILD_GO_IMAGE=golang:1.18-alpine
+ARG LIVE_GO_IMAGE=scratch
+
+###
+### Setup
+###
+
+### Setup Build
+FROM ${BUILD_GO_IMAGE} AS setup-build
+
+ARG GOARCH
+ARG GOOS=linux
+
+ENV GOARCH=${GOARCH}
+ENV GOBIN=${GOPATH}/bin
+ENV GOOS=${GOOS}
+
+WORKDIR /usr/local/src
+
+# Ease the debugging and development build by adding the go
+# installed binaries to the PATH
+ENV PATH=${PATH}:${GOBIN}
+
+# Copy go.mod and go.sum files seperatly to allow caching
+# of dependencies
+COPY go.* ./
+# Download dependencies
+RUN go mod download
+
+COPY . .
+
+### Setup Live Image
+FROM ${LIVE_GO_IMAGE} AS setup-live
+
+COPY --from=setup-build /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
+
+###
+### Build
+###
+FROM setup-build AS build
+
+# Build the application binary
+RUN CGO_ENABLED=0 GOOS=${GOOS} GOARCH=${GOARCH} go build -o ${GOBIN}/terraform-config-inspect .
+
+###
+### Final Images
+###
+
+### Dev
+# This stage is used for development and debugging purposes,
+# but it can also be used for CI-related tasks, and others.
+FROM setup-build AS dev
+
+# Install delve debugger (the delve version shouldn't be a concern 🤷‍♂️)
+RUN go install github.com/go-delve/delve/cmd/dlv@latest
+
+# Explicitly not overriding the entrypoint of the source image
+# ENTRYPOINT [ "" ]
+
+### Live
+FROM setup-live AS live
+
+COPY --from=build /go/bin/terraform-config-inspect /
+
+ENTRYPOINT ["/terraform-config-inspect"]