Quick overview intended to help to know where to commit to right now in most situations. See Branches section below for more detailed explanations.
- Automatic merging is ongoing (a.k.a. Semi-automatic merging period)
- For example if you want to make a fix to 15.x LTS, please commit the fix to 18.x first (if applicable) then backport to 17.x, and then to 15.x. For more details, see the table below.
- During this period, changes to trunk increase the risks of merge conflicts. To minimize this risk, non-functional changes (e.g. code formatting, code documentation and other refactoring) which are not specific to trunk only and which can be postponed should be avoided. In particular, automated code reformatting in batch (many files at once) should be postponed.
- Upcoming releases:
- 18.0, 17.2, 15.6 LTS and 12.13 LTS will be the next versions released.
Commit status and order for each open branch:
|I want to commit to:||What is allowed:||Commit first to:||Afterwards , backport to:|
|trunk (future 19x)||Functional enhancements and new features||trunk||nothing else|
|18x||Fixes, doc (including remarks, tooltips, etc), labels and translations only||18.x|
|15x||Fixes only LTS||18.x||17.x, 15.x|
|12x||Critical fixes only LTS||18.x||17.x, 15.x, 12.x|
The other branches are closed, and no releases are planned. So there is no point in committing there.
|Dev||trunk (will become 19.x branch in future)||Most development (new features) happens here. New features, need to be functional, but don’t need to be complete. In theory, should be releasable at any time. This is the place for refactoring. Cosmetic code changes should be done here after the Semi-automatic merging period has ended. Also: Update language stringsIf you must change the English version (but are not changing the meaning and so the translations are still valid, please use mass spelling correction. If you can’t use that, just add to pending text corrections. . If you commit to trunk, and after you want to commit to a stable branch, please see how to merge a commit from trunk.|
|Stable||branches/18.x||Fixes only until after 18.0 Auto-merge to trunk.|
|Stable||branches/17.x||Fixes only. Backport from 18.x.|
|Stable LTS||branches/15.x||Security and bug fixes. Backport from 17.x.|
|Previous Stable LTS||branches/12.x||Only security fixes and translations. Backport from 15.x.|
|Experimental branches||many||All developments for things that are not stable enough yet or just intended as proof of concept before the real work starts. These branches will never become a released branch directly, the author of the experimental branch must move the functionality in the Dev branch when it’s ready.|
- The “security-only” of the LTS period is intended for security fixes, but could include a few bug fixes as well.
- We will review security vulnerabilities reported to the Security Team
- Publish a fix or a way to deactivate the feature.
- If the included code doesn’t have a patch for that version
- What if a security vulnerability requires major code changes, that are not suitable for LTS?
- We’ll disable the feature via System Configuration so you can can choose to use it knowing the risks, decide not to use it, or upgrade.
- The documentation at doc.tiki.org is kept up to date for more recent versions, so expect to see there some documentation about features not available in your Tiki.
- Commits to LTS must have been developed and tested previously on higher branches (at least trunk) unless they do not apply there (for example, a fix to a feature that was removed later). See here for more info.
- The community will handle merges from stable to dev, with help from a merging script during Semi-automatic merging period
- On stable branches, try to avoid any changes to the database as this complicates things and increases possibilities for errors. If you must, please see: Database Schema Upgrade
- If you must change the English version (but are not changing the meaning and so the translations are still valid, please use mass spelling correction. If you can’t use that, just add to Pending text corrections
- If we are close to a release, and you have a change with a risk of regression, try to consult the release manager.
- There are some things that are black and white and there are many shades of gray. In case of doubt, ask on the Dev Mailing List
There are no more planned releases of versions prior to 12, as well as versions 13, 14 and 16. If you are running one and commit a fix , please merge manually your fix to the appropriate branch.[+]