Files
ObsiGate/docs/DEVELOPMENT_AND_RELEASES.md
T
bruno d3299166bb
CI / lint (push) Successful in 1m11s
CI / security (push) Successful in 43s
CI / test (push) Successful in 2m22s
CI / build (push) Successful in 1m41s
CI / e2e (push) Successful in 10m50s
Desktop Build / build-windows (push) Canceled after 0s
Desktop Build / build-linux (push) Canceled after 0s
feat(desktop): signature updater Tauri + wizard persistant + protocole E2E (#77)
- Signature des mises a jour Tauri : paire de cles minisign generee, cle publique dans tauri.conf.json, createUpdaterArtifacts actif, secrets CI exposes (repli build non signe si secret absent).

- Wizard 1er lancement : etat persistant wizard_done cote Rust (get_wizard_state/complete_wizard) pour ne plus reafficher la banniere, retro-compatible.

- Protocole des 6 tests E2E manuels : docs/DESKTOP_E2E_CHECKLIST.md.

- CI : desktop.test.mjs ajoute au job lint.

- Docs : ROADMAP, fiche desktop-tauri, CHANGELOG, README desktop, guide releases.

- fix(build): retirer les libs WeasyPrint inutiles du stage builder Docker.
2026-09-12 09:29:47 -04:00

211 lines
7.3 KiB
Markdown

# Guide de Développement, Build Local & Publication des Releases Gitea — ObsiGate
Ce guide décrit la procédure pas-à-pas pour **tester**, **compiler localement** l'application Desktop (Windows et Linux), **effectuer les commits & pushs**, puis **publier les binaires** sur la section **Releases / Publications** de Gitea (`https://git.dracodev.net/Projets/ObsiGate/releases`).
---
## 1. Tests et Prévisualisation Locale
### A. Backend & Frontend (Tests unitaires & Linting)
```powershell
# Tests backend Python (FastAPI)
.\.venv\Scripts\python.exe -m pytest tests/
# Linting backend (ruff & mypy)
.\.venv\Scripts\python.exe -m ruff check backend/
.\.venv\Scripts\python.exe -m mypy backend/ --ignore-missing-imports
# Validation & tests unitaires frontend
node tests/frontend/validate-imports.mjs
node tests/frontend/unit.test.mjs
```
### B. Mode Développement Desktop (Tauri 2 Live Preview)
Pour développer l'application desktop avec rechargement à chaud (Hot Reload) :
```powershell
cd desktop
cargo tauri dev
```
*Le backend Python et l'interface WebView Tauri démarreront automatiquement sur `http://127.0.0.1:17890`.*
---
## 2. Compilation Locale de l'Application Desktop
### A. Windows (Installeur `.exe` NSIS et Paquet `.msi`)
1. Ouvrez un terminal PowerShell ou CMD sur votre machine Windows.
2. Déplacez-vous dans le dossier `desktop/` et exécutez le script :
```powershell
cd desktop
.\build-windows.bat
```
3. **Binaires générés dans** `desktop/target/x86_64-pc-windows-msvc/release/bundle/` :
- `ObsiGate_x.y.z_x64-setup.exe` (Installeur utilisateur NSIS)
- `ObsiGate_x.y.z_x64_en-US.msi` (Paquet d'installation MSI)
### B. Linux (Exécutable `.AppImage` et Paquet `.deb`)
1. Ouvrez un terminal Bash (Machine Linux ou WSL2 / Conteneur Docker).
2. Déplacez-vous dans le dossier `desktop/` et exécutez le script :
```bash
cd desktop
chmod +x build-linux.sh
./build-linux.sh
```
3. **Binaires générés dans** `desktop/target/x86_64-unknown-linux-gnu/release/bundle/` :
- `ObsiGate_x.y.z_amd64.AppImage` (Exécutable portable Linux)
- `obsigate_x.y.z_amd64.deb` (Paquet Debian/Ubuntu)
---
## 2bis. Signature des mises à jour (updater Tauri)
La signature de l'auto-update Tauri est **indépendante** de la signature de code
Windows et **gratuite**. Elle garantit qu'une mise à jour téléchargée provient bien
de vous. Elle repose sur une paire de clés `minisign` :
- La **clé publique** est embarquée dans `desktop/tauri.conf.json`
(`plugins.updater.pubkey`).
- La **clé privée** signe les artefacts au build. Elle ne doit **jamais** être
commitée (ignorée par `.gitignore`).
### A. Générer la paire de clés (une seule fois)
```bash
cd desktop
cargo tauri signer generate -w obsigate-updater.key
# La clé publique s'affiche et est écrite dans obsigate-updater.key.pub
```
> ⚠️ Conservez la clé privée en lieu sûr (gestionnaire de secrets). Si vous la
> perdez, les mises à jour ne pourront plus être signées. Pour la protéger par mot
> de passe : ajoutez `-p "<mot de passe>"`.
Copiez le contenu de `obsigate-updater.key.pub` dans
`desktop/tauri.conf.json` → `plugins.updater.pubkey`.
### B. Build local signé
```powershell
# Windows PowerShell
$env:TAURI_SIGNING_PRIVATE_KEY = Get-Content -Raw .\obsigate-updater.key
# $env:TAURI_SIGNING_PRIVATE_KEY_PASSWORD = "<mot de passe>" # si la clé en a un
cargo tauri build --bundles nsis,msi
```
```bash
# Linux / Bash
export TAURI_SIGNING_PRIVATE_KEY="$(cat obsigate-updater.key)"
# export TAURI_SIGNING_PRIVATE_KEY_PASSWORD="<mot de passe>"
cargo tauri build --bundles appimage,deb
```
Le CLI produit des fichiers `.sig` à côté de chaque artefact
(`*.exe.sig`, `*.msi.sig`, `*.AppImage.sig`, `*.deb.sig`).
> Sans clé définie, `createUpdaterArtifacts` est actif et le build échoue : dans
> le CI, l'étape désactive automatiquement les artefacts de mise à jour si le
> secret est absent.
### C. Secrets CI (Gitea)
Dans **Dépôt → Paramètres → Actions → Secrets**, créez :
| Secret | Valeur |
|---|---|
| `TAURI_SIGNING_PRIVATE_KEY` | contenu **intégral** du fichier `.key` |
| `TAURI_SIGNING_PRIVATE_KEY_PASSWORD` | mot de passe de la clé (vide si aucun) |
Le workflow `.gitea/workflows/desktop-build.yml` les expose aux étapes de build ;
les fichiers `.sig` sont uploadés comme artefacts.
### D. Manifeste de mise à jour (`latest.json`)
Le CLI Tauri génère les `.sig` mais **pas** le manifeste JSON consommé par
l'updater. L'endpoint configuré
(`.../releases/latest`) doit servir un document de la forme :
```json
{
"version": "2.3.0",
"notes": "…",
"pub_date": "2026-09-12T00:00:00Z",
"platforms": {
"windows-x86_64": { "signature": "<contenu .msi.sig>", "url": "<URL du .msi>" },
"linux-x86_64": { "signature": "<contenu .AppImage.sig>", "url": "<URL .AppImage>" }
}
}
```
Sans ce manifeste, l'updater ne détecte aucune mise à jour (la signature, elle,
est déjà opérationnelle).
---
## 3. Commit, Push & Tagging Git
Une fois les modifications testées et validées :
1. **Commit et Push du code source** :
```bash
git add .
git commit -m "feat: préparation release v2.0.0"
git push origin main
```
*Ceci déclenchera la vérification CI standard sur Gitea (lint, tests unitaires, build Docker).*
2. **Création du Tag de Version** :
```bash
git tag -a v2.0.0 -m "Release v2.0.0"
git push origin v2.0.0
```
---
## 4. Publication des Binaires sur Gitea Releases
Un script automatisé (`scripts/publish_release.py`) se charge de téléverser vos binaires compilés localement et de générer l'empreinte cryptographique `checksums.txt` (SHA256).
### A. Obtenir un Jeton d'Accès Gitea (Une seule fois)
1. Connectez-vous sur votre instance Gitea : `https://git.dracodev.net`.
2. Cliquez sur votre **Profil** $\rightarrow$ **Paramètres** $\rightarrow$ **Applications**.
3. Dans **Gérer les jetons d'accès personnels**, entrez le nom `ObsiGate-Release` et cochez le jeton avec accès en écriture sur les dépôts (`repo`).
4. Copiez le jeton généré.
### B. Exécution de la Publication
**Option 1 — Définir la variable d'environnement (Recommandé) :**
- **Windows PowerShell** :
```powershell
$env:GITEA_TOKEN="votre_jeton_gitea_ici"
.\.venv\Scripts\python.exe scripts/publish_release.py --tag v2.0.0
```
- **Linux / Bash** :
```bash
export GITEA_TOKEN="votre_jeton_gitea_ici"
python3 scripts/publish_release.py --tag v2.0.0
```
**Option 2 — Utiliser l'option `--token` :**
```powershell
.\.venv\Scripts\python.exe scripts/publish_release.py --tag v2.0.0 --token "votre_jeton_gitea_ici"
```
**Option 3 — Tester à blanc avec `--dry-run` (Sans modifier Gitea) :**
```powershell
.\.venv\Scripts\python.exe scripts/publish_release.py --tag v2.0.0 --dry-run
```
---
## 5. Résultat Attendu dans Gitea
Une fois le script exécuté, visitez la page [ObsiGate Releases](https://git.dracodev.net/Projets/ObsiGate/releases).
Vous y trouverez la section de publication officielle contenant :
- 📦 `ObsiGate_2.0.0_x64-setup.exe` (Installeur Windows)
- 📦 `ObsiGate_2.0.0_x64_en-US.msi` (Package MSI Windows)
- 📦 `ObsiGate_2.0.0_amd64.AppImage` (Executable autonome Linux)
- 📦 `obsigate_2.0.0_amd64.deb` (Paquet Debian/Ubuntu)
- 🔐 `checksums.txt` (Empreintes de sécurité SHA-256)
- 📄 Code source `.zip` / `.tar.gz` (générés automatiquement)