Release Practices

This guide describes the Release Practices and Release Cadence for the UR Code SDKs.

Overview and Goals

FaceTec's Primary Goals:

  • Provide a secure, stable, and reliable library that achieves high Security, Usability, & Success Rates.  

  • Safely improve the UR Code Software.

  • Ensure that the developer experience is stable and predictable.

For optimal Security and Usability, always use the Latest Version of the UR Code SDKs.

Downloading the Latest UR Code SDKs

To stay up-to-date with the best security protocols, as well as to ensure the best user experience, we only provide the latest UR Code SDKs to download. We recommend that developers always upgrade their UR Code SDKs to the latest versions, as we are constantly adding improvements and new features.

Versioning

UR Code Versioning can be used to assess the general level of changes for a given release. UR Code Versions are denoted with major.minor.patch parts.

Major Versions

UR Code Major Versions indicate changes that:

  • Generally involve large changes to the libraries.

  • May require you to update APIs, refactor code, and/or learn new APIs.

  • May contain new, required security or usability features.

  • May require you to re-test your core, UR Code Functionality.

Minor Versions

UR Code Minor Versions indicate changes that:

  • Generally involve medium-sized changes to the libraries.

  • Are not breaking, unless documented in the Release Notes.

  • Do not change behavior unless documented in the Release Notes.

  • Will often include underlying algorithm accuracy improvements.

  • Will often include underlying performance and compatibility improvements.

  • May include API additions, deprecations, or removals. If they do, they will be documented in the Release Notes.


Patch Versions

UR Code Patch Versions indicate changes that:

  • Generally involve small, incremental changes to the libraries.

  • Are not breaking, unless documented in the Release Notes.

  • Do not change behavior unless documented in the Release Notes.

  • Will often include underlying algorithm accuracy improvements.

  • Will often include underlying performance and compatibility improvements.

  • May include API additions, deprecations, or removals. If they do, they will be documented in the Release Notes.

Release Cadence

FaceTec releases updates to the UR Code SDKs, in general, every 1-3 weeks.

Deprecations, Removals, and Breaking Changes

In general, FaceTec uses platform deprecation features to notify developers of upcoming changes to the platform. We will also add this in the Release Notes to notify of upcoming changes.

FaceTec will make its best effort to remove deprecated APIs from the platform in minor version revisions, but due to our policies and reasoning around Keeping Up-to-Date, FaceTec may choose to deprecate or remove deprecated APIs in any release.