Add docker release to the full release process

.changes/unreleased/Under the Hood-20240402-232851.yaml

@@ -0,0 +1,6 @@
+kind: Under the Hood
+body: Automate the Docker release as part of the PyPI release
+time: 2024-04-02T23:28:51.524626-04:00
+custom:
+  Author: mikealfare
+  Issue: "963"

.github/dependabot.yml

@@ -6,3 +6,8 @@ updates:
     schedule:
       interval: "daily"
     rebase-strategy: "disabled"
+  - package-ecosystem: "docker"
+    directory: "/docker"
+    schedule:
+      interval: "weekly"
+    rebase-strategy: "disabled"

.github/workflows/release.yml

@@ -13,7 +13,8 @@
 #
 # **when?**
 # This workflow can be run manually on demand or can be called by other workflows
-name: Release to GitHub and PyPI
+name: "Release to GitHub, PyPI & Docker"
+run-name: "Release ${{ inputs.version_number }} to GitHub, PyPI & Docker"
 
 on:
   workflow_dispatch:
@@ -208,6 +209,31 @@ jobs:
       PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
       TEST_PYPI_API_TOKEN: ${{ secrets.TEST_PYPI_API_TOKEN }}
 
+  is-docker-release:
+    name: "Is Docker Release"
+    runs-on: ubuntu-latest
+    needs: [pypi-release]
+    outputs:
+      is-docker-release: ${{ steps.semver.outputs.is-pre-release == 0 }}
+    steps:
+      - name: "Audit version to determine if it is a pre-release"
+        id: semver
+        uses: dbt-labs/actions/[email protected]
+        with:
+          version: ${{ inputs.version_number }}
+
+  docker-release:
+    name: "Docker Release"
+    needs: [is-docker-release]
+    if: ${{ needs.is-docker-release.outputs.is-docker-release }}
+    permissions:
+      packages: write
+    uses: dbt-labs/dbt-release/.github/workflows/release-docker.yml@main
+    with:
+      package: "dbt-snowflake"
+      version_number: ${{ inputs.version_number }}
+      test_run: ${{ inputs.test_run }}
+
   slack-notification:
     name: Slack Notification
     if: ${{ failure() && (!inputs.test_run || inputs.nightly_release) }}
@@ -218,6 +244,7 @@ jobs:
         build-test-package,
         github-release,
         pypi-release,
+        docker-release,
       ]
 
     uses: dbt-labs/dbt-release/.github/workflows/slack-post-notification.yml@main

Makefile

@@ -66,32 +66,27 @@ help: ## Show this help message.
 	@echo 'targets:'
 	@grep -E '^[7+a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
+.PHONY: ubuntu
+ubuntu:
+	docker build -f docker/Dockerfile -t dbt-snowflake-dev .
+	docker run --rm -it --name dbt-snowflake-dev -v $(shell pwd):/opt/code dbt-snowflake-dev
+
 .PHONY: ubuntu-py38
 ubuntu-py38:
-	docker build -f docker_dev/ubuntu.Dockerfile -t dbt-snowflake-ubuntu-py38 . --build-arg version=3.8
-	docker run --rm -it --name dbt-snowflake-ubuntu-py38 -v $(shell pwd):/opt/code dbt-snowflake-ubuntu-py38
+	docker build -f docker/Dockerfile -t dbt-snowflake-dev . --build-arg py_version=3.8
+	docker run --rm -it --name dbt-snowflake-dev -v $(shell pwd):/opt/code dbt-snowflake-dev
 
 .PHONY: ubuntu-py39
 ubuntu-py39:
-	docker build -f docker_dev/ubuntu.Dockerfile -t dbt-snowflake-ubuntu-py39 . --build-arg version=3.9
-	docker run --rm -it --name dbt-snowflake-ubuntu-py39 -v $(shell pwd):/opt/code dbt-snowflake-ubuntu-py39
+	docker build -f docker/Dockerfile -t dbt-snowflake-dev . --build-arg py_version=3.9
+	docker run --rm -it --name dbt-snowflake-dev -v $(shell pwd):/opt/code dbt-snowflake-dev
 
 .PHONY: ubuntu-py310
 ubuntu-py310:
-	docker build -f docker_dev/ubuntu.Dockerfile -t dbt-snowflake-ubuntu-py310 . --build-arg version=3.10
-	docker run --rm -it --name dbt-snowflake-ubuntu-py310 -v $(shell pwd):/opt/code dbt-snowflake-ubuntu-py310
+	docker build -f docker/Dockerfile -t dbt-snowflake-dev . --build-arg py_version=3.10
+	docker run --rm -it --name dbt-snowflake-dev -v $(shell pwd):/opt/code dbt-snowflake-dev
 
 .PHONY: ubuntu-py311
 ubuntu-py311:
-	docker build -f docker_dev/ubuntu.Dockerfile -t dbt-snowflake-ubuntu-py311 . --build-arg version=3.11
-	docker run --rm -it --name dbt-snowflake-ubuntu-py311 -v $(shell pwd):/opt/code dbt-snowflake-ubuntu-py311
-
-.PHONY: debian-py38
-debian-py38:
-	docker build -f docker/debian-py38.Dockerfile -t dbt-snowflake-debian-py38 . --build-arg version=3.8.15
-	docker run --rm -it --name dbt-snowflake-debian-py38 -v $(shell pwd):/opt/code dbt-snowflake-debian-py38
-
-.PHONY: dev-env-default
-dev-env-default:
-	docker build -f docker/dev-env-default.Dockerfile -t dbt-snowflake-dev-env-default .
-	docker run --rm -it --name dbt-snowflake-dev-env-default -v $(shell pwd):/opt/code dbt-snowflake-dev-env-default
+	docker build -f docker/Dockerfile -t dbt-snowflake-dev . --build-arg py_version=3.11
+	docker run --rm -it --name dbt-snowflake-dev -v $(shell pwd):/opt/code dbt-snowflake-dev

docker/Dockerfile

@@ -0,0 +1,61 @@
+ARG build_for=linux/amd64
+ARG py_version=3.10.7
+ARG dbt_snowflake_ref=dbt-snowflake@main
+
+
+FROM --platform=$build_for python:$py_version-slim-bullseye as base
+
+RUN apt-get update \
+  && apt-get dist-upgrade -y \
+  && apt-get install -y --no-install-recommends \
+    git \
+    ssh-client \
+    software-properties-common \
+    make \
+    build-essential \
+    ca-certificates \
+    libpq-dev \
+  && apt-get clean \
+  && rm -rf \
+    /var/lib/apt/lists/* \
+    /tmp/* \
+    /var/tmp/*
+
+ENV PYTHONIOENCODING=utf-8
+ENV LANG=C.UTF-8
+
+RUN python -m pip install --upgrade pip setuptools wheel --no-cache-dir
+
+
+FROM base as dbt-snowflake
+
+WORKDIR /usr/app/dbt/
+ENTRYPOINT ["dbt"]
+
+RUN python -m pip install --no-cache-dir "dbt-snowflake @ git+https://github.com/dbt-labs/${dbt_snowflake_ref}"
+
+
+FROM base as dbt-snowflake-dev
+
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends \
+        git-all \
+        libbz2-dev \
+        libffi-dev \
+        libgdbm-dev \
+        libncurses5-dev \
+        libnss3-dev \
+        libreadline-dev \
+        libsqlite3-dev \
+        libssl-dev \
+        wget \
+        zlib1g-dev
+
+# setup mount for local code
+WORKDIR /opt/code
+VOLUME /opt/code
+
+ENTRYPOINT python -m pip install --no-cache-dir -e . -r dev-requirements.txt \
+  && pre-commit install
+
+ENV PYTHONUNBUFFERED=1

docker/README.md

@@ -0,0 +1,70 @@
+# Docker for dbt
+This docker file is suitable for building dbt Docker images locally or using with CI/CD to automate populating a container registry.
+
+
+## Building an image:
+This Dockerfile can create images for the following target: `dbt-snowflake`
+
+In order to build a new image, run the following docker command.
+```shell
+docker build --tag <your_image_name> --target dbt-snowflake <path/to/dockerfile>
+```
+---
+> **Note:**  Docker must be configured to use [BuildKit](https://docs.docker.com/develop/develop-images/build_enhancements/) in order for images to build properly!
+
+---
+
+By default the images will be populated with the most recent release of `dbt-snowflake`.  If you need to use a different version you can specify it by git ref using the `--build-arg` flag:
+```shell
+docker build --tag <your_image_name> \
+  --target dbt-snowflake \
+  --build-arg dbt_snowflake_ref=<git_ref> \
+  <path/to/dockerfile>
+```
+
+### Examples:
+To build an image named "my-dbt" that supports Snowflake using the latest releases:
+```shell
+cd dbt-core/docker
+docker build --tag my-dbt --target dbt-snowflake .
+```
+
+To build an image named "my-other-dbt" that supports Snowflake using the adapter version 1.0.0b1:
+```shell
+cd dbt-core/docker
+docker build \
+  --tag my-other-dbt \
+  --target dbt-snowflake \
+  --build-arg [email protected] \
+ .
+```
+
+## Special cases
+There are a few special cases worth noting:
+
+* If you need to build against another architecture (linux/arm64 in this example) you can override the `build_for` build arg:
+```shell
+docker build --tag my_dbt \
+  --target dbt-snowflake \
+  --build-arg build_for=linux/arm64 \
+  <path/to/dockerfile>
+```
+
+Supported architectures can be found in the python docker [dockerhub page](https://hub.docker.com/_/python).
+
+## Running an image in a container:
+The `ENTRYPOINT` for this Dockerfile is the command `dbt` so you can bind-mount your project to `/usr/app` and use dbt as normal:
+```shell
+docker run \
+  --network=host \
+  --mount type=bind,source=path/to/project,target=/usr/app \
+  --mount type=bind,source=path/to/profiles.yml,target=/root/.dbt/profiles.yml \
+  my-dbt \
+  ls
+```
+---
+**Notes:**
+* Bind-mount sources _must_ be an absolute path
+* You may need to make adjustments to the docker networking setting depending on the specifics of your data warehouse/database host.
+
+---

docker/test.sh

@@ -0,0 +1,22 @@
+# - VERY rudimentary test script to run latest + specific branch image builds and test them all by running `--version`
+# TODO: create a real test suite
+
+clear \
+&& echo "\n\n"\
+"########################################\n"\
+"##### Testing dbt-snowflake latest #####\n"\
+"########################################\n"\
+&& docker build --tag dbt-snowflake \
+  --target dbt-snowflake \
+  docker \
+&& docker run dbt-snowflake --version \
+\
+&& echo "\n\n"\
+"#########################################\n"\
+"##### Testing dbt-snowflake-1.0.0b1 #####\n"\
+"#########################################\n"\
+&& docker build --tag dbt-snowflake-1.0.0b1 \
+  --target dbt-snowflake \
+  --build-arg [email protected] \
+  docker \
+&& docker run dbt-snowflake-1.0.0b1 --version