Lothario
/
axmol
mirror of https://github.com/axmolengine/axmol.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
axmol/docs/RELEASING_RULES.md

6.1 KiB
Raw Blame History

How to release a new version of cocos2d-x

Releases Rules

Tagging

New releases must be tagged in github. The tag name must follow these rules:

cocos2d-x-Major.Minor[.Status]

or

cocos2d-x-Major.Minor.Revision[.Status]

Example of valid names:

  • cocos2d-x-3.0rc0
  • cocos2d-x-3.0
  • cocos2d-x-2.1.1
  • cocos2d-x-2.1.1rc0

See "Naming Conventions" below

Announcing

Only stable releases must be announced on:

All kind of releases (alpha,beta,rc, final) must be announced on:

Release Notes and Changelog

BEFORE releasing a new version (either stable or unstable), the following documents must be updated:

Documentation

BEFORE releasing a new Minor or Major stable release, the following tasks MUST be done:

  • All documentation MUST be updated to the new version. This includes:
    • API Reference
    • Programmers Guide

Backward compatibility

  • Minor versions MUST be backward compatible with previous minor versions. eg: v3.2 must be backward compatible with v3.1 and v3.0.
  • Major versions SHOULD be backward compatible with previous major versions. Breaking backward compatibility in Major versions is acceptable only if it is extremely well justified

Deprecated APIs

  • APIs introduced in a Major version MUST NOT be deprecated in the same Major version. eg: An API introduce in v3.1 MUST NOT be deprecated the following v3.x releases.
  • Deprecated APIs can be removed only after being deprecated for more than one complete Major cycle. eg: An API deprecated in v2.2 can only be removed in v4.0, but not before.
  • Deprecated APIs MUST give a compile-time warning. And MUST tell the user which is the new API that superceeds it.

Performance tests

  • Performance tests MUST be run before releasing a Release Candidate
  • If performance is worse than previous stable version, then the Release Candidate MUST NOT be released (See Naming Conventions below)
  • Results of the performance tests must be documented in this spreadsheet

Samples and tests

BEFORE releasing a new Minor or Major stable release, the following tasks MUST be done:

  • All the samples and tests must be updated to use the new version. This includes:

Naming conventions

Alpha

The product is unstable. It could have memory leaks, or crashes, or the API is unstable. The product contains little QA. Although the product is not ready for production, the product should be testable. Alpha versions might have Core functionality that has just been refactored, meaning that Core functionality might be unstable, but should work Ok.

As an example, for cocos2d-x, an Alpha version means:

  • Basic functionality works Ok (not great, but OK), like Sprites, Scenes, actions, etc. _* But it might have memory leaks, or crashes, or the recently added features might be unfinished. The documentation might not be updated.
  • As an example, the Renderer refactoring must be done in "alpha" versions (but not Beta versions).

Alpha versions are NOT feature freeze. New features might be added in future alpha and beta versions.

Beta

The product is more stable than Alpha. The product might crash, but not frequently. No major changes were made in core components. Smaller features could be refactored in Beta versions, but the core functionality is stable. The product has more QA. The only difference between Alpha and Beta, is that Beta is more stable than Alpha. And that in Beta versions no new major features will be added.

As an example, for cocos2d-x it means:

  • All the Core features (Sprites, Menu, Labels, Director, Transitions) are stable. Bug fixes could have been added into the Core functionality, but no major refactoring were done in the Core.
  • But perhaps new features like the new Particle Engine could be unfinished, or the Cocos Studio reader might crash.
  • Some cocos2d-x users might want to use a beta version for real games.

Beta versions are NOT feature freeze. Small new features might be added in future Beta versions. New BIG features that might affect the Core functionality must only be added in Alpha versions, and not in Beta versions.

Release Candidate

Release candidate means that, unless major bugs are found, the product is ready for release. The difference between Release Candidate_ and Final is that RC has less testing than the final version.

Many cocos2d-x users might want to try and use the RC releases for production.

RC versions ARE feature freeze. No new features, no matter how small they are, MUST be added in RC versions, because as the name implies, it is a Release Candiate.

Final

It is the new stable version.

Number conventions

major.minor [revision | status]

Major

The major number is increased when there are significant jumps in functionality such as changing the framework which could cause incompatibility with interfacing systems

Minor:

The minor number is incremented when only minor features or significant fixes have been added.

Revision:

The revision number is incremented when minor bugs are fixed.

Status:

The status could be: alphaN, betaN or rcN.

'N' is a number, and the first MUST always be 0.

Examples

v2.0-alpha0:

  • New major version of cocos2d-x.
  • Unstable

v2.1.3:

  • Stable version of cocos2d-x. It is the same as v2.1 plus some bug fixes.

v2.2-beta0:

  • Similar to v2.1.3, but some new features were added, but are not stable yet.

v2.2:

  • Similar to v2.1.3, but some small features were added. The new features are stable.