Maintainer's guide
Where to push a bugfix? Where to push a feature? How to start a new feature set? How to publish a release candidate or a release?
The answers are here.
- Status of branches
- 1.10 is stopped
- 2.10 is on track
- 2.11 is on track
- 3.0 is on track
- 3.1 is in development
- Release cheatsheet
Tarantool evolves in several parallel tracks. A developer looks on it as on branches in git. A user sees releases, feature sets and release series.
Git branch | Feature set | Latest (pre)release |
---|---|---|
release/2.10 |
2.10 |
2.10.8 |
release/2.11 |
2.11 |
2.11.2 |
release/3.0 |
3.0 |
3.0.0 |
master |
3.1 |
not yet |
Once we released a particular set of features, we generally shouldn't extend it with new features. It gives the simple rule, what kind of patches should go to what branches:
Git branch | Low-risk bugfixes? | Bugfixes? | New features? | Breaking changes? |
---|---|---|---|---|
release/2.10 |
Yes | No | No | No |
release/2.11 |
Yes | Yes | No | No |
release/3.0 |
Yes | Yes | No | No |
master |
Yes | Yes | Yes | No |
Qualifying a bugfix as low-risk is in responsibility of CTO and the Product Team.
An exception is possible, but it requires explicit agreement of CTO and the Product Team.
Release 1.10.15 is planned as the last one.
We push low-risk bugfixes here after CTO and the Product Team approve.
We push bugfixes here.
We push bugfixes here.
Features and bugfixes go here.
No breaking changes.
Architecture
- Server architecture
- R tree index quick start and usage
- LuaJIT
- Vinyl
- Vinyl Architecture
- Vinyl Disk Layout
- Vinyl math
- Vinyl Cookbook
- Bullet1
- SQL
- Appserver modules
- Testing
- Performance
- Privileges and Access control
How To ...?
- ... update a third party library
- ... configure build system
- ... add new fuzzers
- ... build RPM or Deb package using packpack
- ... calculate memory size
- ... debug core dump of stripped tarantool
- ... debug core from different OS
- ... debug fuzzer
- ... generate new bootstrap snapshot
- ... use Address Sanitizer
- ... collect a coredump
- ... generate luacov report for builtin module
- ... verify modified lua files via luacheck
- ... verify Lua files in third_party?
- ... rerun failed jobs
- ... update a third party repository
- Fix wrong decimal indexing after upgrade to 2.10.1
- Caveats when upgrading a cluster on Tarantool 1.6
- Fix illegal field type in a space format when upgrading to 2.10.4
Useful links