Skip to content

Conversation

@keynmol
Copy link
Contributor

@keynmol keynmol commented Nov 18, 2025

Fixes #2132

At the moment, the scala-cli docker image is built using a combination of mill tasks, scripts, and dockerfiles that require externally built binary. What's more, it's only built for x86.

With ARM64 runners on GHA being GA, I propose a simplification - a self-contained multi-stage dockerfile, with a custom Github Workflow that merges the images into a single manifest, meaning that docker will pull the correct image no matter the target platform.

Manifest merging and pushing is a complicated step, and Docker have been amending their docs with the example, which is what this workflow is based on.

I've been using this setup in multiple apps, e.g. Mimalyzer.


There are some aspects of the build I don't really understand – static, mostly static images, customisation for Linux x86, etc.

This proposal attempts to do the simplest possible thing, so that building a docker image is just docker build . -t VirtusLab/scala-cli.

Currently, it only publishes to ghcr.io to test out the workflows without disturbing the main image on docker hub. But additional publishing steps are easily added, of course

RUN ./mill -i copyTo --task 'cli[].base-image.nativeImage' --dest "./docker-out/scala-cli" 1>&2

FROM debian:stable-slim
RUN apt update && apt install build-essential libz-dev clang procps -y
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that I'm not sure if installing those dependencies in a base image is a good idea, or better left to downstream images. Even though I see the appeal of making native and native-image stuff work out of the box..

Main concern is the size
CleanShot 2025-11-19 at 09 38 47@2x

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, we definitely want Scala Native to build nicely with it, so clang is a must.
I'd like to keep them, I think.

Copy link
Contributor

@Gedochao Gedochao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tgodzik @zielinsky can you take a look as well? I think it'd be good to have another pair of eyes on this (or two)

group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

# Configures this workflow to run every time a change is pushed to the branch called `release`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...you mean like, v* tags and main, right?

RUN ./mill -i copyTo --task 'cli[].base-image.nativeImage' --dest "./docker-out/scala-cli" 1>&2

FROM debian:stable-slim
RUN apt update && apt install build-essential libz-dev clang procps -y
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean, we definitely want Scala Native to build nicely with it, so clang is a must.
I'd like to keep them, I think.

@Gedochao
Copy link
Contributor

There are some aspects of the build I don't really understand – static, mostly static images, customisation for Linux x86, etc.

Static and mostly static images are in the understanding of GraalVM, as per this doc: https://www.graalvm.org/21.3/reference-manual/native-image/StaticImages/index.html
The way they're built is based on the mill-native-image plugin: https://github.com/alexarchambault/mill-native-image

(...) customisation for Linux x86 (...)

What particular customisation for Linux x86 did you mean?

(...) etc.

Shoot away, I'll try to answer, or at least direct you in the direction of an answer.

What's there in this area was initially coded by @alexarchambault (who's also the author of mill-native-image). While I've tinkered with this here and there, most of it has been lying untouched for a long, long time, and I'm not all that familiar with it either.

Copy link
Member

@tgodzik tgodzik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know much about this, I only built basic docker images. Overall look ok as long as it work 😅

Copy link

@zielinsky zielinsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments from me 😅

Comment on lines 116 to 117
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
username: ${{ env.REGISTRY_LOGIN }}
password: ${{ env.REGISTRY_PASSWORD }}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@keynmol I reverted to unresolved, you changed it in only one place

@keynmol
Copy link
Contributor Author

keynmol commented Nov 21, 2025

@Gedochao

What particular customisation for Linux x86 did you mean?

This line threw me off

https://github.com/keynmol/scala-cli/blob/93079619648e0b475f874ee2676387b488d7a637/project/settings/package.mill.scala#L406

@Gedochao
Copy link
Contributor

Just to make sure.

We currently have the following images, which are updated with each Scala CLI release:

@keynmol your intention is to create a third one, yes?
smth like virtuslab/scala-cli-platform-native?

@Gedochao
Copy link
Contributor

Also, how can we safely test this?

@keynmol
Copy link
Contributor Author

keynmol commented Nov 21, 2025

Here's my plan:

  1. Merge this workflow as is, make sure it publishes a working ghcr.io/virtuslab/scala-cli image (similar to existing DockerHub virtuslab/scala-cli)
  2. Modify the workflow in a separate PR to build the slim image in the same way (similar to existing DockerHub virtuslab/scala-cli-slim)
  3. Add DockerHub publishing steps to both images
  4. Remove old docker publishing logic

Up to step 3, the existing docker images on DockerHub are safe and won't be touched, as we only publish to ghcr.io, using it as our testing area.

Steps 1-3 can be done in separate PRs as they won't affect existing dockerhub publishing steps.

In the end, we should have virtuslab/scala-cli and virtuslab/scala-cli-slim that have a manifest merging two platforms, so users automatically get the right image (see screenshot)
CleanShot 2025-11-21 at 10 05 06@2x

@Gedochao
Copy link
Contributor

Okay... sounds reasonable.
Let's get the CI green and do it one step at a time.

@Gedochao
Copy link
Contributor

Gedochao commented Nov 24, 2025

The CI is green.
@keynmol the workflow is still on Ubuntu 22.04, while the other workflows already rely on 24.04 (I left comments earlier).
Otherwise, we seem to be good to merge here (might want to rebase on main while you're at it)

@keynmol
Copy link
Contributor Author

keynmol commented Nov 24, 2025

I have responded to the Ubuntu version comment: #3962 (comment)

Actually scratch that, in this instance it won't have any effect, I will update

Copy link
Contributor

@Gedochao Gedochao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
@keynmol ready to merge?

@Gedochao
Copy link
Contributor

@zielinsky I will wait for your okay before clicking merge.

@keynmol
Copy link
Contributor Author

keynmol commented Nov 25, 2025

I think so, no doubt it will require more iterations when the work flow actually runs :)

Copy link

@zielinsky zielinsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question from me before approval.


env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't the name of the image have to be in lowercase letters? Currently github.repository will return "VirtusLab/scala-cli" (docs).

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Publish Arm64 Docker image

4 participants