Deprecation Process

When we announce that support for an API, platform, database or framework is deprecated, it means that we intend to end support for it in future. We recommend that you stop using it now.

Deprecations of APIs are rare and only happen in exceptional circumstances, for example:

  • there's no longer a use case for it
  • it's been replaced by something better
  • it was an experimental feature that we've stopped developing
  • the support costs outweigh the benefits to users

We may also deprecate support for platforms, databases or frameworks for similar reasons.

How the process works

  1. Initial announcement
  2. We'll add details of what's being deprecated to the current list of deprecations. Deprecated items will only become unsupported in a future major release version, but we'll always give you at least six months notice before a deprecated item becomes unsupported. We'll also tag deprecated items in the API Reference.

    If we plan to end support for a certain platform, we'll confirm this by email at least six months in advance.

  3. Opportunity for you to make changes and send feedback
  4. If there's an item on the list that's in your current codebase, you should remove it as soon as possible. Where relevant, the list will recommend alternative options to help you. This is also your opportunity to contact us if you think ending support will have a significant effect on your KeyLines implementation.

  5. End of support
  6. In the release notes for each major version, we'll announce which deprecated items are now unsupported and undocumented.