59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
<!-- file: docs/DELTA_WORKFLOW.md -->
|
|
<!-- version: 1 -->
|
|
|
|
# Workflow delta
|
|
|
|
Après le squelette initial, les livraisons doivent être faites sous forme de zip delta.
|
|
|
|
## Nommage des zips
|
|
|
|
Un delta qui touche la racine du workspace ou plusieurs modules doit utiliser :
|
|
|
|
```text
|
|
khadhroony-bot2_vX.Y.Z-pre.abc.zip
|
|
```
|
|
|
|
Un delta qui ne touche qu'un seul module Rust doit utiliser :
|
|
|
|
```text
|
|
kb_modulename_vX.Y.Z-pre.abc.zip
|
|
```
|
|
|
|
Exemples :
|
|
|
|
```text
|
|
khadhroony-bot2_v0.1.0-pre.001.zip
|
|
kb_logging_v0.1.0-pre.002.zip
|
|
```
|
|
|
|
## Fichier `delta.md`
|
|
|
|
Chaque zip delta doit contenir un fichier `delta.md` non versionné à la racine du zip.
|
|
|
|
`delta.md` doit indiquer :
|
|
|
|
- les fichiers ajoutés ;
|
|
- les fichiers modifiés ;
|
|
- les fichiers à supprimer manuellement ;
|
|
- les validations exécutées ;
|
|
- les validations non exécutées ;
|
|
- les remarques de compatibilité ou d'application du delta.
|
|
|
|
## Contenu d'un delta
|
|
|
|
Un delta contient uniquement :
|
|
|
|
- les fichiers ajoutés ;
|
|
- les fichiers modifiés ;
|
|
- `delta.md`.
|
|
|
|
Il ne doit pas contenir de fichiers inchangés.
|
|
|
|
## Règles
|
|
|
|
- Ne pas renvoyer un zip complet sauf demande explicite.
|
|
- Ne pas modifier `CHANGELOG.md` avant validation d'une version.
|
|
- Placer les évolutions prévues dans `ROADMAP.md`.
|
|
- Garder `README.md` descriptif.
|
|
- Documenter les suppressions dans `delta.md`, car un zip ne supprime pas les anciens fichiers à l'extraction.
|