mart-w/kanidm
1
0
Fork 0
mirror of https://github.com/kanidm/kanidm.git synced 2025-02-23 20:47:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
kanidm/project_docs/RELEASE_AND_SUPPORT.md
James Hodgkinson b8dcb47f93
Spell checking and stuff (#1314) 
* codespell run and spelling fixes
* some clippying
* minor fmt fix
* making yamllint happy
* adding codespell github action
2023-01-10 13:50:53 +10:00

1.8 KiB
Raw Blame History

Release Schedule

Kanidm is released on a 3 month (quarterly) basis.

  • February 1st
  • May 1st
  • August 1st
  • November 1st

Releases will be tagged and branched in git.

1.2.0 will be released as the first supported version once the project believes the project is in a maintainable longterm state, without requiring backward breaking changes. There is no current estimated date for 1.2.0.

Support

Releases during alpha will receive limited fixes once released. Specifically we will resolve:

  • Moderate security issues and above
  • Flaws leading to dataloss or corruption
  • Other quality fixes at the discrestion of the project team

These will be backported to the latest stable branch only.

API stability

There are a number of "surfaces" that can be considered as "API" in Kanidm.

  • JSON HTTP end points of kanidmd
  • unix domain socket API of kanidm_unixd resolver
  • LDAP interface of kanidm
  • CLI interface of kanidm admin command
  • Many other interaction surfaces

During the Alpha, there is no guarantee that any of these APIs named here or not named will remain stable. Only elements from "the same release" are guaranteed to work with each other.

Once an official release is made, only the JSON API and LDAP interface will be declared stable.

The unix domain socket API is internal and will never be "stable".

The CLI is not an API and can change with the interest of human interaction during any release.

Python module

The python module will typically trail changes in functionality of the core Rust code, and will be developed as we it for our own needs - please feel free to add functionality or improvements, or ask for them in a Github issue!

All code changes will include full type-casting wherever possible.