overhangio
Ulmo Sandbox and Release Preparation
This issue is for tracking the items to prepare https://github.com/overhangio/openedx-release-demo for Ulmo cutoff and eventually Ulmo release.
Ulmo cutoff is expected to take place on ~October 9, 2025~ ~October 23, 2025~ October 30, 2025. Once the branches are out upstream, the community will be looking forward to the sandbox provided by Edly. Tutor and tutor plugins will require ulmo branches with appropriate changes for the sandbox to complete.
A note: once the branches are created, any changes to main would need to be manually added to the ulmo branch. Therefore, a rebase on main whenever main changes would be required to ensure the ulmo branch is always up-to-date
This issue is meant for tracking the statuses of various repositories needed for sandbox and the release. It will act as a todo list to ensure that tutor and its plugins have ulmo branches created from main before the cutoff date (even though there will be potential failures on CI against it) and have a PR against release.
For sanity checks, make sure to run main image build and init task on local tutor <local/dev> do init --limit=pluginnname.
The sandbox script expects the branches to be available on the actual repository, not the fork. If you are assigned a repository but cannot push to it directly, please get in touch with @ahmed-arb or the maintainer of the repository with git patch file so that they can create the PR in the appropriate repository with your provided changes
Tutor & Plugins Todo List
Available on launch
- [ ] Tutor ulmo PR ( https://github.com/overhangio/tutor/pull/1289 by @ahmed-arb )
- [x] Is main local image build working?
- [x] Is init working?
- [ ] tutor-mfe ulmo PR ( https://github.com/overhangio/tutor-mfe/pull/274 @ahmed-arb )
- [x] Is main local image build working?
- [x] Is init working?
Available within a week
- [ ] tutor-discovery ulmo PR ( https://github.com/overhangio/tutor-discovery/pull/105 by @mlabeeb03 )
- [x] Is main local image build working?
- [x] Is init working?
- [ ] tutor-credentials ulmo PR ( https://github.com/overhangio/tutor-credentials/pull/59 by @mlabeeb03 )
- [x] Is main local image build working?
- [x] Is init working?
- [ ] tutor-forums ulmo PR ( https://github.com/overhangio/tutor-forum/pull/72 by @Abdul-Muqadim-Arbisoft )
- [ ] Is main local image build working? -- N/A, there is no forum image after the release for v2
- [ ] Is init working?
- [ ] tutor-notes ulmo PR ( https://github.com/overhangio/tutor-notes/pull/51 by @jfavellar90)
- [x] Is main local image build working?
- [x] Is init working?
- [ ] tutor-xqueue ulmo PR ( https://github.com/overhangio/tutor-xqueue/pull/43 by @jfavellar90)
- [x] Is main local image build working?
- [x] Is init working?
- [ ] tutor-jupyter ulmo PR ( https://github.com/overhangio/tutor-jupyter/pull/33 by @Abdul-Muqadim-Arbisoft )
- [x] Is main local image build working?
- [x] Is init working?
- [ ] tutor-minio ulmo PR ( https://github.com/overhangio/tutor-minio/pull/67 by @rehmansheikh222 )
- [x] Is init working?
- [ ] tutor-android ulmo PR ( https://github.com/overhangio/tutor-android/pull/45 by @Abdul-Muqadim-Arbisoft )
- [x] Is main local image build working?
- [x] Is init working?
- [ ] tutor-contrib-codejail PR ( https://github.com/eduNEXT/tutor-contrib-codejail/pull/70 by @MoisesGSalas)
- [x] Is main local image build working?
- [x] Is init working?
- [x] tutor-contrib-aspects ( https://github.com/openedx/tutor-contrib-aspects/tree/ulmo-dev @bmtcril )
Not needed for sandbox
- [ ] tutor-cairn ulmo PR ( https://github.com/overhangio/tutor-cairn/pull/71 by @eemaanamir )
- [ ] Is main local image build working?
- [ ] Is init working?
- [ ] tutor-deck ulmo PR ( https://github.com/overhangio/tutor-deck/pull/21 by @mlabeeb03 )
- [ ] tutor-indigo ulmo PR ( https://github.com/overhangio/tutor-indigo/pull/179/files by @HammadYousaf01 )
- [x] Is main local image build working?
- [x] Is init working?
Sandbox Repo Todo List
- [ ] PR 1 ()
- [ ] ...
Context/Steps
Every six months, Tutor maintainers sync up with the Build/Test/Release working group to create the next version, both of Open edX and Tutor.
In the scenario below, we are upgrading Open edX from fictional “Delta” to “Epsilon”. Tutor will upgrade from v4 to v5 (“d”=4, “e”=5).
(these instructions are pulled and adapted from this old discussion topic)
Create New Release Branches
In Tutor core and all plugins, we must create “epsilon” branches off of the main branches. For each repo, this looks like the following:
git checkout main
git pull
git checkout -b epsilon
Push the created “epsilon” branch to the upstream repo: git push
Upgrade Tutor core and plugins
- Modify about.py:
- bump the version number to 5.0.0.
- in Tutor core, set the version_suffix to an empty string.
- In plugins’ pyproject.toml, bump the version of the “tutor” package that the plugin depends on:
dependencies=["tutor>=5.0.0,<6.0.0"],
optional-dependencies={"dev": ["tutor[dev]>=5.0.0,<6.0.0"]},
- Create a changelog entry with make changelog-entry: "💥[Feature] Upgrade to Epsilon. (by @YOURGITHUBUSERNAME)"
- Replace all instances of “[dD]elta” that make sense (i.e: not in the CHANGELOG.md!)
- Go through the Dockerfile templates and manually upgrade all the 3rd-party requirements that you can find (dockerize, ipdb, etc.). Sometimes it’s not desirable to upgrade some pieces of software: for instance node and python are expected to run a specific version. Those required version numbers are specified in the edx/configuration 5 repo. (look for SERVICENAME_VERSION variables)
- Make sure that the plugin images (if any) are built correctly: tutor images build all.
- Make sure that the plugin can be correctly initialized: tutor local do init --limit=pluginnname.
- If you need to make some changes to the docker-compose*.yml files and patches, make sure to backport these changes to the k8s-* patches, for compatibility with Kubernetes.
- Make sure that the plugins work correctly by doing some basic usage testing. Pay close attention to any log (warning or error) that come out of the plugin containers as well as the lms container.
- git commit -a -m v5.0.0
- Push the created “epsilon” branch to the upstream repo: git push
The release branches should be updated regularly to take into account the latest changes from the main branch. During the release process, it is frequent that changes are pushed to the release and main branches, and the latest “espilon” branch must have those changes as well. Be prepared to push --force the “epsilon” branches frequently.
:warning: Plugin tests will fail in the release branches, because the plugins can’t find tutor>=5.0.0 on pypi. To resolve that, we should update the test scripts to install tutor from source (pip install -e --config-settings editable_mode=compat https://github.com/overhangio/tutor@epsilon#egg=tutor). But it’s inconvenient to do that for each and every plugin. So maybe we should consider migrating to a centralized “tutor-test-plugin” GitHub action. This action would be versioned according to the Tutor major version (@5).
Pull Requests Checklist
When the PRs are created from ulmo against release branch, it is important to add some checklists on the PRs. Those checklists must be completed before the merge. Therefore, when you create the PR, please add the checklist in PR description. This is only applicable to plugins under Overhangio GitHub organization.
Tutor Core
v21.0.0 ulmo release
### Todos before merge
- [ ] Ensure **changelog-entry** exists for ulmo upgrade
- [ ] Ensure changelog exists for v21
- [ ] Ensure CI/Tests are working as expected
- [ ] Ensure ulmo branch is up-to-date with main (updated as of <date>)
- [ ] Ensure OPENEDX_COMMON_VERSION is pointing to correct tag release/ulmo.1
### Merge Option
- [ ] Ensure "Merge Commit" option is used to merge the branch into release (Responsible: @ahmed-arb). This is needed to ensure the commit history when release is merged back into main
Note: In Tutor core, we won't have release/ulmo.1 available until the actual release in December. Therefore, until December, OPENEDX_COMMON_VERSION should be pointed to release/ulmo.master and this should be changed to release/ulmo.1 before release
Tutor Plugins
v21.0.0 ulmo release
### Todos before merge
- [ ] Ensure **changelog-entry** exists for ulmo upgrade
- [ ] Ensure changelog exists for v21
- [ ] Ensure CI/Tests are working as expected
- [ ] Ensure ulmo branch is up-to-date with main (updated as of <date>)
### Merge Option
- [ ] Ensure "Merge Commit" option is used to merge the branch into release (Responsible: @ahmed-arb). This is needed to ensure the commit history when release is merged back into main
Hi @jfavellar90 and @MoisesGSalas, As the Ulmo cutoff is approaching, we’re starting to prepare the release branches for the Tutor sandbox. Could you please let us know if you’re available to help with the preparations? Your contributions would be greatly appreciated.
tutor-mfe ulmo PR https://github.com/overhangio/tutor-mfe/pull/274 is up.
- [x] Is main local image build working?
- [x] Is init working?
tutor ulmo PR https://github.com/overhangio/tutor/pull/1289 is up
- [x] Is main local image build working?
- [x] Is init working?
@ahmed-arb Hi, early next week I'll put aside some time to work on this. Is it OK for you to have the PR's ready by next Tuesday?
@ahmed-arb Hi, early next week I'll put aside some time to work on this. Is it OK for you to have the PR's ready by next Tuesday?
Yes, sure. Cutoff is delayed till Tuesday next week, so we have some time.
tutor-cairn ulmo PR https://github.com/overhangio/tutor-cairn/pull/71 is up.
- [x] Is main local image build working?
- [x] Is init working?
Hi, early next week I'll put aside some time to work on this. Is it OK for you to have the PR's ready by next Tuesday?
Hi @jfavellar90, a friendly reminder for your sandbox contributions.
Hello @MoisesGSalas, if you wouldn't be able to help with the release PRs, please let me know. I'll re-route this request accordingly.
@ahmed-arb, hello. I've been on vacation for the last few weeks, so today is when I'm catching up with all the notifications.
I can work on the Ulmo branches for the codejail plugin, but it would probably be ready by the middle of next week.
@MoisesGSalas, Welcome back. Sure, the middle of next week would be fine.
@ahmed-arb I realized that the xqueue repo was not Ulmo-cut (it does not have a release/ulmo branch). There's an ongoing deprecation plan, but I'm not 100% sure of its current status. I left a comment asking for clarification so we can proceed accordingly
Okay, thanks for the update. Let's get all the plugins enabled on the sandbox by next week.
@rehmansheikh222 local launch isn't working with minio enabled. I had to disable it to unblock sandbox setup. Could you please look into that? You can check the error trace in the action logs here:
https://github.com/overhangio/openedx-release-demo/actions/runs/19033378109/job/54351815304
@ahmed-arb
tutor-contrib-codejail PR (https://github.com/eduNEXT/tutor-contrib-codejail/pull/70)
- [x] Is main local image build working?
- [x] Is init working?
tutor-notes ulmo PR (https://github.com/overhangio/tutor-notes/pull/51)
- [x] Is main local image build working?
- [x] Is init working?
tutor-xqueue ulmo PR (https://github.com/overhangio/tutor-xqueue/pull/43)
- [x] Is main local image build working?
- [x] Is init working?
Note about xqueue: It is confirmed that xqueue won't be deprecated in Ulmo release. Since the xqueue repository is lacking the release/ulmo branch, I tested with XQUEUE_REPOSITORY_VERSION: master.
tutor-cairn ulmo PR https://github.com/overhangio/tutor-forum/pull/72 is up.
-
[x] Is main local image build working?
-
[x] Is init working?
tutor-android ulmo PR https://github.com/overhangio/tutor-android/pull/45 is up.
-
[x] Is main local image build working?
-
[x] Is init working?
tutor-cairn ulmo PR https://github.com/overhangio/tutor-jupyter/pull/33 is up.
-
[x] Is main local image build working?
-
[x] Is init working?
@ahmed-arb do you think there's still room for a short PR for Tutor in the Ulmo branch? The change I would like to apply is in this commit. Basically, it removes a warning displayed by the kustomize tool. More details about the warning here
@ahmed-arb do you think there's still room for a short PR for Tutor in the Ulmo branch? The change I would like to apply is in this commit. Basically, it removes a warning displayed by the kustomize tool. More details about the warning here
@jfavellar90 Yes, sure. You could make a PR against master and Ulmo branch will rebase from it on Monday.