Table of Contents

🇬🇧 English version

Voir aussi : Retour Ă  l'index

Politique de stabilité et de versionnement

Orkeon suit le versionnement sémantique 2.0. La version vit dans src/Directory.Build.props et nulle part ailleurs. Cette page dit ce que la ligne 1.x garantit ; la procédure côté contributeur est dans CONTRIBUTING.

Ce qu'une version peut changer

Version Peut changer Ne peut pas changer
Correctif (1.x.y) Corrections de bogues, documentation, code interne, performances. Un membre public hors [Experimental] ; le comportement documenté.
Mineure (1.x) Ajoute des membres publics, des outils, des fournisseurs, des options et des réglages ; déprécie des membres avec [Obsolete] ; modifie tout ce qui est hors engagement (ci-dessous). Retire un membre de la surface figée ou en change la signature, sauf sous la clause des bibliothèques tierces (ci-dessous).
Majeure (2.0) Retire ce qui était déprécié ; casse la surface figée. —

Tout changement cassant est annoncé dans le CHANGELOG.md avec une note de migration.

La surface figée

L'engagement est consigné dans le dépôt, pas en prose : tout membre public listé dans le PublicAPI.Shipped.txt d'un paquet publié est figé pour toute la ligne 1.x. Microsoft.CodeAnalysis.PublicApiAnalyzers le vérifie à la compilation, et un changement public non déclaré fait échouer le build (RS0016 et RS0017 sont des erreurs).

  • Un retrait ou un changement de signature attend la 2.0. Modifier ou retirer une ligne de PublicAPI.Shipped.txt est, par dĂ©finition, un changement cassant.
  • Les ajouts passent par PublicAPI.Unshipped.txt. Un nouveau membre public y est dĂ©clarĂ© ; Ă  la publication, les entrĂ©es passent dans PublicAPI.Shipped.txt et sont dès lors figĂ©es. scripts/check-release-readiness.py refuse une publication tant qu'un fichier Unshipped contient une entrĂ©e ou que la section [Unreleased] du CHANGELOG n'est pas vide.

Types d'une bibliothèque tierce

Quelques membres publics portent dans leur signature un type d'une bibliothèque sur laquelle Orkeon s'appuie :

  • Jint, le moteur de scripts : les membres qu'atteignent les scripts sur les objets d'exĂ©cution de Orkeon.Scripting et de Orkeon.Cli.Commands.Scripting (un paramètre JsValue, par exemple) ;
  • TreeSitter.DotNet : ILanguageAdapter, le point d'extension d'un nouveau langage, et les adaptateurs fournis par Orkeon.Analysis, qui reçoivent un TreeSitter.Node ;
  • Terminal.Gui : les vues de Orkeon.Cli.TerminalGui, qui dĂ©rivent de sa View.

Un tel membre suit la version majeure de cette bibliothèque, pas celle d'Orkeon : quand Orkeon passe à une nouvelle majeure de la dépendance, le membre peut changer dans une mineure d'Orkeon, et le CHANGELOG le dit avec une note de migration. Tout membre dont la signature ne porte aucun type de ce genre reste sous l'engagement ci-dessus.

Hors engagement

  • APIs expĂ©rimentales : les types marquĂ©s [Experimental] peuvent changer ou disparaĂ®tre dans n'importe quelle version, mineures comprises. Les rĂ©fĂ©rencer est une erreur de compilation portant leur id, Ă  supprimer pour s'inscrire (voir APIs expĂ©rimentales).

    ID Domaine
    ORKEXP001 A2A (protocole agent Ă  agent)
    ORKEXP002 Orchestration autonome
    ORKEXP003 RAG correctif
    ORKEXP004 Intégration MCP
    ORKEXP005 Capacités par modèle
    ORKEXP006 Sécurité HTTP de l'hôte
    ORKEXP007 Ports d'historique des exécutions
  • Types internes : tout ce qui n'est listĂ© dans aucun PublicAPI.Shipped.txt.

  • Le protocole d'Ă©vĂ©nements d'exĂ©cution (--events jsonl) est un protocole versionnĂ© : chaque ligne porte sa version de protocole dans v (voir Le bus d'Ă©vĂ©nements d'exĂ©cution). Il est versionnĂ© Ă  part, indĂ©pendamment des versions des paquets.

Dépréciation

Un membre public appelé à disparaître est marqué [Obsolete], avec son remplaçant nommé dans le message, dans une version mineure, et n'est retiré au plus tôt qu'à la majeure suivante.

Versions prises en charge

La dernière mineure 1.x reçoit les correctifs. Les correctifs de sécurité suivent le tableau de SECURITY.fr.md.