Publish Codespace docker image with release #3653

safoinme · 2025-05-08T08:50:53Z

Describe changes

This adds Github action and Dockerfile to build and push docker image for the codespace with release. This image builds on top of zenml lates docker image and add code-server dependency

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
IMPORTANT: I made sure that my changes are reflected properly in the following resources:
- ZenML Docs
- Dashboard: Needs to be communicated to the frontend team.
- Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
- Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2025-05-08T08:51:01Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2025-05-08T08:52:36Z

Documentation Link Check Results

✅ Absolute links check passed
✅ Relative links check passed
_{Last checked: 2025-05-16 08:53:17 UTC}

schustmi · 2025-05-13T07:38:25Z

docker/zenml-codespace.Dockerfile

+FROM zenmldocker/zenml:latest as base
+
+# Set user to root for installations
+USER root


This never gets changed back.

schustmi · 2025-05-13T07:39:02Z

docker/zenml-codespace.Dockerfile

+# Expose the default code-server port (optional, for documentation)
+EXPOSE 8080
+
+# Default command - using dumb-init is often good practice with containers


To me it feels like this entire image is just a copy of some modal example? Wouldn't it be easier to simply use their image and install zenml in it?

schustmi · 2025-05-13T07:41:33Z

.github/workflows/release.yml

@@ -89,9 +89,16 @@ jobs:
    needs: wait-for-package-release
    uses: ./.github/workflows/publish_docker_image.yml
    secrets: inherit
-  publish-helm-chart:
+  publish-codespace-image:


I'm not sure why this needs to happen before the helm chart necessarily? As this doesn't actually block the OSS release, I would have this at the end of the GH action somewhere, where it failing doesn't actually cause some crucial release actions to not start.

schustmi · 2025-05-13T07:43:13Z

.github/workflows/publish_codespace_image.yml

+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version tag (leave empty for latest)'


If I leave this empty, the tag will never be latest

schustmi · 2025-05-13T07:44:25Z

.github/workflows/publish_codespace_image.yml

+      - main
+      - develop


I don't think we need this action to trigger automatically anywhere. It should build the image at release, and if anything there should be another option to trigger it manually I think

schustmi · 2025-05-13T07:45:12Z

.github/workflows/publish_codespace_image.yml

+        with:
+          context: .
+          file: ./docker/zenml-codespace.Dockerfile
+          push: ${{ github.event_name != 'pull_request' }}


So if it's a PR event, it should just build the docker image but not push it? 🤔

schustmi · 2025-05-13T07:46:13Z

.github/workflows/publish_codespace_image.yml

+          push: ${{ github.event_name != 'pull_request' }}
+          tags: |
+            zenmldocker/zenml-codespace:${{ env.VERSION }}
+            ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' && 'zenmldocker/zenml-codespace:latest' || '' }}


A push to main should not overwrite the latest image, this should happen only on release.

… integrations

bcdurak · 2025-06-03T07:58:31Z

@safoinme just had an idea about this. I haven't taken a deep look at this, but if this pushes a set of Docker images with every release, you can possibly add this to the cloudbuild configuration.

safoinme added 2 commits May 8, 2025 10:37

Add GitHub Actions workflow to publish ZenML Codespace Docker image

ed5f68d

Rename workflow job to publish Codespace image and adjust dependencies

234b797

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels May 8, 2025

schustmi requested changes May 13, 2025

View reviewed changes

Update Dockerfile to create 'coder' user and install ZenML with cloud…

c489dc3

… integrations

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Publish Codespace docker image with release #3653

Publish Codespace docker image with release #3653

Uh oh!

safoinme commented May 8, 2025

Uh oh!

coderabbitai bot commented May 8, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented May 8, 2025 •

edited

Loading

Uh oh!

schustmi May 13, 2025

Uh oh!

schustmi May 13, 2025

Uh oh!

schustmi May 13, 2025

Uh oh!

schustmi May 13, 2025

Uh oh!

schustmi May 13, 2025

Uh oh!

schustmi May 13, 2025

Uh oh!

schustmi May 13, 2025

Uh oh!

bcdurak commented Jun 3, 2025

Uh oh!

Uh oh!

Publish Codespace docker image with release #3653

Are you sure you want to change the base?

Publish Codespace docker image with release #3653

Uh oh!

Conversation

safoinme commented May 8, 2025

Describe changes

Pre-requisites

Types of changes

Uh oh!

coderabbitai bot commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

github-actions bot commented May 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Link Check Results

Uh oh!

schustmi May 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi May 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi May 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi May 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi May 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi May 13, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi May 13, 2025

Choose a reason for hiding this comment

Uh oh!

bcdurak commented Jun 3, 2025

Uh oh!

Uh oh!

coderabbitai bot commented May 8, 2025 •

edited

Loading

github-actions bot commented May 8, 2025 •

edited

Loading