Understanding Ansel’s releases

Ansel channels

Ansel development and release path follows 3 channels :

  1. A production channel :
    1. linked to the Git master branch,
    2. contains tested code supposed to work reliably for daily use,
    3. contains features found under the Done column, in the project management board.
  2. A pre-release channel :
    1. backward-compatible with the production channel (so you can switch from one to another without breaking your image edits),
    2. linked to the Git candidate branch,
    3. contains code to test before integration in production channel but still relatively safe to use,
    4. contains features found under the Testing column, in the project management board.
  3. An experimental channel :
    1. non-backward-compatible with either the production or pre-release channels,
    2. linked to the Git dev branch,
    3. contains features found under the In progress column, in the project management board,
    4. This channel needs to be used aside of the production install since it contains prototypes of new modules, new versions of old modules, and other features that will upgrade the version of the Ansel database, making it incompatible with previous versions. It can also contain prototypes that will never make it in production.

At all time, the project management Kanban board will show what changes are being currently worked on in the non-production channels, with links to their pull request and issue, to help traceability of changes and bug reports.

Ansel versioning

The production channel is versioned as follow :

  1. All versions having the same major version number (0.x, 1.x, 2.x) produce editing histories that are compatible with each other and use the same internal database version. Major version numbers are upgraded every time changes are introduced that break this property, such as new modules, database structure changes, or new versions of old modules.
  2. Minor version numbers (x.0, x.1, x.2) are upgraded every time new changes are made that don’t break compatibility within the major version, like GUI refactorings and bug fixes.
  3. The major version 0.x is compatible with darktable 4.0 and 4.0.1 image editing histories, which means it is also compatible with edits made with any darktable version earlier than 4.0. Ansel will not maintain compatibility with upstream darktable for future versions after 0.x, since darktable 4.2 will introduce nonsensical changes that will stay the burden of the darktable team only.
  4. Versions are tested snapshots of the production channel. This channel will keep getting changes in-between versions, notably from the pre-release channel, supposed to be safe between versions.

Ansel testing

Tests are important because I develop and use Ansel on Linux Fedora, and I have no way of knowing how it works on other OS. A continuous integration bot automatically tests building and basic execution (processing a test picture through the CLI variant of the software), on Windows 10, Linux Ubuntu 20.04 and 22.04 and Mac OS 11.7 and 12.6. On each OS, the CI bot builds using GCC 9 to GCC 12 and Clang 12 to 14.

But those continuous integration tests are not enough as they don’t encompass a real desktop use with a graphical interface and will not show runtime errors. The different channels are meant to gradually push changes to production.

graph TD; master[/Stable/]; candidate[/Pre-release/]; dev[/Experimental/]; master2[/Stable/]; master3[/Stable/]; master --> m1((Merge)); master --> m2((Merge)); master --> dev; dev --> c3[fa:fa-code Make unsafe changes]; c3 --> t3[fa:fa-clock Testing]; t3 --> r3{Bugs ?}; r3 -- no ---> m2; r3 -- yes --> f3[Fix]; f3 --> t3; m2 --> p3([fa:fa-tag Tag new major version]); p3 --> master2; master --> candidate; candidate --> c1[fa:fa-code Make safe changes]; c1 --> t1[fa:fa-clock Testing]; t1 --> r1{Bugs ?}; r1 -- no -----> m1; r1 -- yes --> f1[Fix]; m1 --> p1([fa:fa-tag Tag new minor version]); f1 ---> t1; p1 --> master2; master2 --> t2[fa:fa-clock Testing]; t2 --> r2{Bugs ?}; r2 -- no ---> p2([fa:fa-tag Tag new maintenance version]) r2 -- yes --> f2[Fix]; f2 --> t2; p2 --> master3;

This graph shows how tests are dispatched in the general development workflow. Pre-built “nightly” packages are provided for all 3 channels (stable, pre-release and experimental) for all the platforms (Linux, Windows, Mac OS) and can be tested directly by anyone.

After some time without bug reports, the pre-release and experimental channels are successively merged into the stable channel, letting some time between both merges.

After some time with no bug report in the stable channel, a new maintenance release gets tagged. This means that the x.0.0 major versions are less tested than the x.0.1 and x.1.0, and should be avoided in environments where stability is the priority.

Release schedule

The production channel is updated in a rolling-release fashion. Each change triggers automatic builds on Linux, Windows and Mac OS, producing “nightly” packages that can be directly downloaded and installed on each platform. You can subscribe to these nightly builds to update Ansel in a rolling-release fashion.

Major, minor and maintenance versions are released when they are ready.

Ugrading between major releases

Major releases are defined by the fact that the Ansel database structure will be upgraded and therefore will not be usable by previous major releases. Before the ugrading process starts, Ansel automatically backs up the database in the configuration folder, appending the new version number to the database filename.

The configuration folder of Ansel is located by default at :

  • $HOME/.config/ansel for Mac OS and Linux
  • C:\%LOCALAPPDATA%\ansel on Windows.

In this configuration folder, the image editing histories are stored in the file library.db and the presets, styles, and other preferences are stored in the file data.db.

If you upgrade, for example, from version 2.6 to 3.0, both files are backed up under the respective names library.db-pre-3.0 and data.db-pre-3.0. If, for some reason, you want to go back to the previous 2.6 version after having upgraded to 3.0, you just need to remove the pre-3.0 suffixes from the file names to restore your back-ups. Any editing you may have done with the 3.0 version will be lost without a chance of being recovered in that case, unless you manually back up library.db and data.db for a future where you will use the 3.0 version.