Skip to content

Preparing a new release based on a new Ubuntu codename

David Hewitt edited this page Oct 28, 2023 · 21 revisions

To rebase elementary OS on a new Ubuntu release, use the following process:

We will use a switch from Ubuntu jammy to Ubuntu lunar as an example.

Setting up Metapackage builds

  1. Clone https://github.com/elementary/metapackages
    1. Create a new branch for the new Ubuntu release (e.g. lunar) from the previous Ubuntu release branch (e.g. jammy)
    2. In the new branch, in update.cfg replace instances of previous Ubuntu release with the new one.
    3. Commit and push new branch to repo
  2. Clone https://github.com/elementary/seeds
    1. Create a new branch for the new Ubuntu release (e.g. lunar) from the previous Ubuntu release branch (e.g. jammy)
    2. In the new branch, in .github/workflows/update.yml replace instances of previous Ubuntu release with the new one.
    3. You may also need to change the container image that the workflow uses if the current one (usually rolling) doesn't point to a version that is the same or newer than the Ubuntu release we're trying to build against.
    4. Update the instances of the previous Ubuntu release with the new one in STRUCTURE
    5. Commit and push new branch to repo
  3. Clone https://github.com/elementary/platform
    1. Create a new branch for the new Ubuntu release (e.g lunar) from the previous Ubuntu release branch (e.g jammy)
    2. In the new branch, in .github/workflows/update.yml replace instances of previous Ubuntu release with the new one.
    3. You may also need to change the container image that the workflow uses if the current one (usually rolling) doesn't point to a version that is the same or newer than the Ubuntu release we're trying to build against.
    4. Commit and push new branch to repo
  4. Wait for the GitHub actions runs to complete on both repositories.
  5. The new branch of https://github.com/elementary/metapackages should be committed to by the GitHub actions.
    1. Take note of any removed packages from these commits. This forms the list of packages that need to be built in Launchpad for the new codename. (e.g. https://github.com/elementary/metapackages/commit/bc133fb5d22a36574a00ec9d999e6ae7afc5e135)
  6. Force an import of the metapackages repository on Launchpad: https://code.launchpad.net/~elementary-os/elementaryos/+git/metapackages
  7. Create a new recipe from this repository pointing to the new codename branch, this should be named like seed-metapackages-lunar-daily
  8. Enable the new codename for the overlay package and request a build: https://code.launchpad.net/~elementary-os/+recipe/os-patches-enabler
  9. Enable the new codename for the icons package and request a build: https://code.launchpad.net/~elementary-os/+recipe/icons-daily
  10. Wait for the builds to complete and publish! 🍵

Building the Docker container

  1. Once the Launchpad builds above are completed, clone https://github.com/elementary/docker
  2. Copy the previous unstable (horus-unstable) folder to a new codename (e.g. ubuntu-lunar-unstable)
  3. Modify the Dockerfile in the new folder, replacing the old codename with new jammy -> lunar
  4. Do a test build of the Docker image with:
docker build .
  1. If there are no failures, add the new folder name to the lists in .github/workflows/ci.yml and .github/workflows/test.yml
  2. Push the changes to the repository

Note: Once some of the packages have been built against this codename as per below, you may optionally symlink development-target to have the GitHub CI workflows run against the new codename.

Building the important packages

Next is juggling package dependencies to get things published to the PPA in the right order. You may wish to locally run the Docker container created above and test these packages build against new library versions before enabling the Launchpad recipes.

  1. Enable the new codename for the granite7 package, and request a build: https://code.launchpad.net/~elementary-os/+recipe/granite-7-daily
  2. If the GTK3 version of granite is still relevant at the time of reading, enable the new codename and request a build: https://code.launchpad.net/~elementary-os/+recipe/granite-daily
  3. Wait for the granite packages to build and publish before continuing 🍵
  4. Enable the new codename for the gala package, and request a build: https://code.launchpad.net/~elementary-os/+recipe/gala-daily
  5. Wait for gala to build and publish before continuing 🍵
  6. Enable the new codename for the wingpanel package, and request a build: https://code.launchpad.net/~elementary-os/+recipe/wingpanel-daily
  7. Enable the new codename for the switchboard package, and request a build: https://code.launchpad.net/~elementary-os/+recipe/switchboard-daily
  8. NB: At the time of reading, the switchboard package may have been replaced by the GTK4 settings package, so enable the new codename for that and build it too: https://code.launchpad.net/~elementary-os/+recipe/settings-daily

Other packages

Once the above important packages have been built and published, it should be possible to enable the new codename for all other packages without bumping into too many dependency issues. Here's a (possibly incomplete/outdated) list: