For Developers: Changes to Our Public Repositories

  • We're changing the way we use our branches in all of our repositories, paving the way for an accelerated release cadence. These changes will become effective on Wednesday, February 19th, 2020. We highly recommend that you adjust your build processes, in particular all sorts of artifacts, to reflect these changes.

    The New Branch Schema

    Old branches have been tracked in version branches, such as 2.1 or 3.0, for a long time already. However, the current and next version have faced some inconsistencies over the past years, residing in different branches with sometimes unclear rules on when they are migrated into version branches. This has historically lead to some confusion with 3rd party developers that had issues tracking down the correct branch to apply and/or suggest their changes.


    The new schema puts up clear rules on this:

    • Stable version will always reside in version branches, regardless of their age.
    • master is always the development branch that eventually becomes the next stable version.
    • Upon reaching the stable version .0, the master branch is transfered into the appropriate version branch.
    • The next branch has become obsolete, as it is now represented by the master branch.

    Effective Changes: An Example

    The Core's repository (https://github.com/WoltLab/WCF/) will serve as an example for the aforementioned changes:


    TreeBeforeAfter
    Version 2.1.x2.12.1
    Version 3.0.x3.03.0
    Version 3.1.xmaster3.1
    Version 5.2.xnext5.2
    (Next version)---master

    Timeline

    These changes will enter into force on Wednesday, February 19th, 2020.

    Alexander Ebert
    Senior Developer WoltLab® GmbH

  • In preparation for the upcoming version 5.3, we'll be making some adjustments to our repositories on Wednesday, October 21st, 2020.

    Branches for the Legacy 2.x Series

    We're retiring the branches for the legacy 2.x series, namely the branches 2.0 and 2.1. Their HEAD will be tagged as 2.0.final and 2.1.final, afterwards the branches will be removed to clean up the repositories. If you do need these branches for anything special, please keep in mind that you can restore those branches in your local copy of the repository.

    Upcoming Changes

    TreeBeforeAfter
    Version 2.0.xBranch 2.0Tag 2.0.final
    Version 2.1.xBranch 2.1Tag 2.1.final
    Version 5.3masterBranch 5.3
    Version 5.4---master

    Timeline

    These changes will enter into force on Wednesday, October 21st, 2020.

    Alexander Ebert
    Senior Developer WoltLab® GmbH