Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

We define a set of rules on what changes are allowed, both in minor (point) releases and separately in major releases.

This policy applies to the external API for Totara TXP and Totara Cloud. It doesn't apply to the Ajax API for Totara Cloud, as we can introduce breaking changes to this API because it is not used by third-party plugins.

Minor release policy

  • We will not make breaking changes to an API in minor releases, unless:
    • The feature is explicitly marked as 'beta' or 'experimental', indicating it is not yet fully production ready and therefore subject to modification
    • In exceptional circumstances when required to fix a bug in the stable branch
  • We will not deprecate API functionality in minor releases, unless:
    • The feature is explicitly marked as 'beta' or 'experimental', indicating it is not yet fully production ready and therefore subject to modification
    • In exceptional circumstances when required to fix a bug in the stable branch
  • We may make non-breaking changes to APIs in minor releases
  • We will document all API changes (breaking and non-breaking) in minor release changelogs

...