Skip to content

Refactor docker/Makefile to push images directly to registry #395

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
straight-shoota merged 11 commits into from
Dec 8, 2025
Merged

Refactor docker/Makefile to push images directly to registry #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
861ca66
Refactor builds
straight-shoota Nov 24, 2025
b7c568c
Drop `$(OUTPUT_DIR)
straight-shoota Nov 24, 2025
c695b42
push
straight-shoota Nov 24, 2025
ab6d1c6
Drop `-runtime` suffix
straight-shoota Nov 24, 2025
374464d
Unify build recipe
straight-shoota Nov 24, 2025
c1f72f6
Improve docs
straight-shoota Dec 1, 2025
0fb9cb8
Simplify variables
straight-shoota Dec 2, 2025
e755d9b
Expand `build-%` rules
straight-shoota Dec 2, 2025
cc1c4e5
Use `$(TAG)` in `%-84codes` recipes
straight-shoota Dec 8, 2025
74bc140
fixup
straight-shoota Dec 8, 2025
6b708d3
Do not require build on push
straight-shoota Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 49 additions & 48 deletions docker/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,73 +1,75 @@
# Recipies for this Makefile
# Recipes for this Makefile

## Build all docker images
## $ make DOCKER_TAG=nightly CRYSTAL_VERSION=0.xy.z
## Build ubuntu64 docker images
## $ make ubuntu64 DOCKER_TAG=nightly CRYSTAL_VERSION=0.xy.z
## Build alpine docker images
## $ make alpine DOCKER_TAG=nightly CRYSTAL_VERSION=0.xy.z
## $ make VERSION=1.18.2
## Build specific docker images
## $ make build-ubuntu VERSION=1.18.2
## $ make build-alpine-build VERSION=1.18.2
##
## Push all docker images to registry
## $ make push VERSION=1.18.2
## Push a specific docker image to registry
## $ make push-ubuntu VERSION=1.18.2
## $ make push-alpine-build VERSION=1.18.2
##
## Run smoke tests
## $ make smoke-all
## $ make smoke-ubuntu-build
## $ make smoke-alpine-runtime

CRYSTAL_VERSION ?= ## How the binaries should be branded
TARBALLS ?= tarballs## Path to folder which contains the Crystal tarballs to install in docker images.

DOCKER_TAG ?= $(CRYSTAL_VERSION)## How to tag the docker image (examples: `0.27.2`, `nightly20190307`). `-build` will be appended for build images.
DOCKER_REPOSITORY ?= crystallang/crystal## Docker hub repository to commit image
VERSION ?= ## Version name of the source tarballs
TARBALLS ?= ./tarballs## Path to folder which contains the Crystal tarballs to install in docker images.

OUTPUT_DIR := build
BUILD_CONTEXT := build-context
DOCKER_TAG_UBUNTU := $(DOCKER_REPOSITORY):$(DOCKER_TAG)
DOCKER_TAG_ALPINE := $(DOCKER_REPOSITORY):$(DOCKER_TAG)-alpine
BUILD_CONTEXT := ./build-context
TAG := crystallang/crystal:$(VERSION)## Base tag of the docker image. Classifiers like `-ubuntu` and `-build` will be appended.

.PHONY: all64
all64: ubuntu64 alpine ## Build all x86_64 images
PLATFORMS := linux/amd64
PLATFORM_TARBALLS := $(patsubst linux/%,$(BUILD_CONTEXT)/crystal-%.tar.gz,$(PLATFORMS))

.PHONY: all_ubuntu
all_ubuntu: ubuntu64 ## Build all ubuntu images
.PHONY: all
all: ## Build all images
all: build-ubuntu
all: build-ubuntu-build
all: build-alpine
all: build-alpine-build

.PHONY: ubuntu64
ubuntu64: ## Build ubuntu x86_64 images
ubuntu64: $(OUTPUT_DIR)/docker-$(CRYSTAL_VERSION)-ubuntu-x86_64.tar.gz
ubuntu64: $(OUTPUT_DIR)/docker-$(CRYSTAL_VERSION)-ubuntu-x86_64-build.tar.gz
.PHONY: push
push: ## Push all images to the registry
push: push-ubuntu
push: push-ubuntu-build
push: push-alpine
push: push-alpine-build

.PHONY: alpine
alpine: ## Build alpine images
alpine: $(OUTPUT_DIR)/docker-$(CRYSTAL_VERSION)-alpine.tar.gz
alpine: $(OUTPUT_DIR)/docker-$(CRYSTAL_VERSION)-alpine-build.tar.gz
push-%:
docker push $(TAG)$(subst -ubuntu,,-$*)

$(BUILD_CONTEXT)/crystal-amd64.tar.gz: $(TARBALLS)/crystal-$(CRYSTAL_VERSION)-1-linux-x86_64.tar.gz | $(BUILD_CONTEXT)
$(BUILD_CONTEXT)/crystal-amd64.tar.gz: $(TARBALLS)/crystal-$(VERSION)-1-linux-x86_64.tar.gz | $(BUILD_CONTEXT)
cp $< $@

$(OUTPUT_DIR) $(BUILD_CONTEXT):
$(BUILD_CONTEXT):
mkdir -p $@

# Ubuntu x86_64
$(OUTPUT_DIR)/docker-$(CRYSTAL_VERSION)-ubuntu-x86_64.tar.gz: ubuntu.Dockerfile $(BUILD_CONTEXT)/crystal-amd64.tar.gz $(OUTPUT_DIR)
docker build --file ubuntu.Dockerfile -t $(DOCKER_TAG_UBUNTU) --target runtime $(BUILD_CONTEXT)
docker save $(DOCKER_TAG_UBUNTU) | gzip > $@
.PHONY: build-alpine
build-alpine: alpine.Dockerfile $(PLATFORM_TARBALLS)
docker build --file alpine.Dockerfile -t $(TAG)-alpine --target runtime $(BUILD_CONTEXT)

$(OUTPUT_DIR)/docker-$(CRYSTAL_VERSION)-ubuntu-x86_64-build.tar.gz: ubuntu.Dockerfile $(BUILD_CONTEXT)/crystal-amd64.tar.gz $(OUTPUT_DIR)
docker build --file ubuntu.Dockerfile -t $(DOCKER_TAG_UBUNTU)-build --target build $(BUILD_CONTEXT)
docker save $(DOCKER_TAG_UBUNTU)-build | gzip > $@
.PHONY: build-alpine-build
build-alpine-build: alpine.Dockerfile $(PLATFORM_TARBALLS)
docker build --file alpine.Dockerfile -t $(TAG)-alpine-build --target build $(BUILD_CONTEXT)

# Alpine x86_64
$(OUTPUT_DIR)/docker-$(CRYSTAL_VERSION)-alpine.tar.gz: alpine.Dockerfile $(BUILD_CONTEXT)/crystal-amd64.tar.gz $(OUTPUT_DIR)
docker build --file alpine.Dockerfile -t $(DOCKER_TAG_ALPINE) --target runtime $(BUILD_CONTEXT)
docker save $(DOCKER_TAG_ALPINE) | gzip > $@
.PHONY: build-ubuntu
build-ubuntu: ubuntu.Dockerfile $(PLATFORM_TARBALLS)
docker build --file ubuntu.Dockerfile -t $(TAG) --target runtime $(BUILD_CONTEXT)

$(OUTPUT_DIR)/docker-$(CRYSTAL_VERSION)-alpine-build.tar.gz: alpine.Dockerfile $(BUILD_CONTEXT)/crystal-amd64.tar.gz $(OUTPUT_DIR)
docker build --file alpine.Dockerfile -t $(DOCKER_TAG_ALPINE)-build --target build $(BUILD_CONTEXT)
docker save $(DOCKER_TAG_ALPINE)-build | gzip > $@
.PHONY: build-ubuntu-build
build-ubuntu-build: ubuntu.Dockerfile $(PLATFORM_TARBALLS)
docker build --file ubuntu.Dockerfile -t $(TAG)-build --target build $(BUILD_CONTEXT)

alpine-84codes: ## Build and push docker build images based on the base images from 84codes
docker buildx build --build-arg crystal_version=$(CRYSTAL_VERSION) -f alpine-84codes.Dockerfile --platform linux/amd64,linux/arm64 --tag crystallang/crystal:$(CRYSTAL_VERSION)-alpine-84codes-build --push .
docker buildx build --build-arg crystal_version=$(VERSION) -f alpine-84codes.Dockerfile --platform linux/amd64,linux/arm64 --tag $(TAG)-alpine-84codes-build --push .

ubuntu-84codes: ## Build and push docker build images based on the base images from 84codes
docker buildx build --build-arg crystal_version=$(CRYSTAL_VERSION) -f ubuntu-84codes.Dockerfile --platform linux/amd64,linux/arm64 --tag crystallang/crystal:$(CRYSTAL_VERSION)-ubuntu-84codes-build --push .
docker buildx build --build-arg crystal_version=$(VERSION) -f ubuntu-84codes.Dockerfile --platform linux/amd64,linux/arm64 --tag $(TAG)-ubuntu-84codes-build --push .

.PHONY: smoke-all
smoke-all: ## Run smoke tests on all docker images
Expand All @@ -78,11 +80,10 @@ smoke-all: smoke-ubuntu-build

.PHONY: smoke-%
smoke-%: # Run smoke tests on docker images
docker run --rm -v $(CURDIR)/smoke.sh:/smoke.sh -e CRYSTAL_VERSION=$(CRYSTAL_VERSION) $(DOCKER_REPOSITORY):$(DOCKER_TAG)$(subst -ubuntu,,-$*) /smoke.sh $*
docker run --rm -v $(CURDIR)/smoke.sh:/smoke.sh -e VERSION=$(VERSION) $(TAG)$(subst -ubuntu,,-$*) /smoke.sh $*

.PHONY: clean
clean: ## Clean up build and output directories
rm -Rf $(OUTPUT_DIR)
clean: ## Clean up build context
rm -Rf $(BUILD_CONTEXT)

.PHONY: help
Expand Down
6 changes: 3 additions & 3 deletions docker/smoke.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

set -eux

if [[ "$CRYSTAL_VERSION" =~ "^[0-9]+(\.[0-9]+)*$" ]]; then
crystal --version | grep -q "${CRYSTAL_VERSION}"
if [[ "$VERSION" =~ "^[0-9]+(\.[0-9]+)*$" ]]; then
crystal --version | grep -q "${VERSION}"
else
# $CRYSTAL_VERSION is not a version number on maintenance builds
# $VERSION is not a version number on maintenance builds
crystal --version | grep -q "Crystal"
fi

Expand Down