feat: Implement automated versioning system with PowerShell build script and centralized version management
- Add version.properties file as single source of truth for VERSION_NAME and VERSION_CODE - Create build.ps1 script with automated version bumping (Major/Minor/Patch/None) and build orchestration - Update app/build.gradle.kts to read version from version.properties instead of hardcoded values - Display dynamic version info in Settings screen using BuildConfig.VERSION_NAME and VERSION_CODE - Add
This commit is contained in:
+132
-5
@@ -42,24 +42,104 @@ keyPassword=votre_mot_de_passe_cle
|
||||
|
||||
## Build Release
|
||||
|
||||
### Debug build (pour tester):
|
||||
### Méthode 1: Script PowerShell `build.ps1` (recommandé)
|
||||
|
||||
Le script `build.ps1` automatise le versioning et le build. Il gère automatiquement l'incrémentation de la version dans `version.properties` et lance le build approprié.
|
||||
|
||||
**Syntaxe de base:**
|
||||
```powershell
|
||||
.\build.ps1 [-Type Debug|Release] [-Bump Major|Minor|Patch|None] [-OutputFormat APK|AAB] [-Clean]
|
||||
```
|
||||
|
||||
**Paramètres:**
|
||||
- `-Type`: Type de build (`Debug` par défaut, `Release` pour la production)
|
||||
- `-Bump`: Type d'incrémentation de version (`Patch` par défaut)
|
||||
- `-OutputFormat`: Format de sortie (`APK` par défaut, `AAB` pour Google Play Store)
|
||||
- `-Clean`: Effectue un clean avant le build (optionnel)
|
||||
|
||||
**Exemples d'utilisation:**
|
||||
|
||||
1. **Build Debug avec incrément de Patch (le plus courant):**
|
||||
```powershell
|
||||
.\build.ps1
|
||||
# Résultat: version 1.0.1 → 1.0.2, build Debug APK
|
||||
```
|
||||
|
||||
2. **Build Release APK avec incrément de Minor (nouvelle fonctionnalité):**
|
||||
```powershell
|
||||
.\build.ps1 -Type Release -Bump Minor
|
||||
# Résultat: version 1.0.2 → 1.1.0, build Release APK
|
||||
```
|
||||
|
||||
3. **Build Release AAB pour Google Play Store:**
|
||||
```powershell
|
||||
.\build.ps1 -Type Release -Bump Minor -OutputFormat AAB
|
||||
# Résultat: version 1.0.2 → 1.1.0, build Release AAB
|
||||
```
|
||||
|
||||
4. **Build Release avec incrément de Major (version majeure):**
|
||||
```powershell
|
||||
.\build.ps1 -Type Release -Bump Major -Clean
|
||||
# Résultat: version 1.1.0 → 2.0.0, build Release APK avec clean
|
||||
```
|
||||
|
||||
5. **Build Debug sans changer la version (pour tests rapides):**
|
||||
```powershell
|
||||
.\build.ps1 -Type Debug -Bump None
|
||||
# Résultat: version inchangée, recompilation Debug APK
|
||||
```
|
||||
|
||||
6. **Build Release AAB pour hotfix (patch uniquement):**
|
||||
```powershell
|
||||
.\build.ps1 -Type Release -Bump Patch -OutputFormat AAB
|
||||
# Résultat: version 1.0.2 → 1.0.3, build Release AAB
|
||||
```
|
||||
|
||||
7. **Build complet avec clean et version majeure:**
|
||||
```powershell
|
||||
.\build.ps1 -Type Release -Bump Major -OutputFormat AAB -Clean
|
||||
# Résultat: version 1.1.0 → 2.0.0, build Release AAB avec clean complet
|
||||
```
|
||||
|
||||
**Fichiers générés (avec renommage automatique):**
|
||||
- **Debug APK**: `app/build/outputs/apk/debug/ShaarIt-debug-x.x.x.apk`
|
||||
- **Release APK**: `app/build/outputs/apk/release/ShaarIt-x.x.x.apk`
|
||||
- **Release AAB**: `app/build/outputs/bundle/release/ShaarIt-x.x.x.aab` (pour Google Play Store)
|
||||
|
||||
**Format de nommage:**
|
||||
- Debug: `ShaarIt-debug-{VERSION_NAME}.apk`
|
||||
- Release APK: `ShaarIt-{VERSION_NAME}.apk`
|
||||
- Release AAB: `ShaarIt-{VERSION_NAME}.aab`
|
||||
|
||||
**Note:** Le format AAB n'est disponible que pour les builds Release. Les builds Debug génèrent toujours des APK. Les fichiers sont automatiquement renommés après chaque build réussi.
|
||||
|
||||
### Méthode 2: Gradle manuel (si nécessaire)
|
||||
|
||||
Si vous préférez utiliser Gradle directement:
|
||||
|
||||
**Debug build (pour tester):**
|
||||
```bash
|
||||
./gradlew assembleDebug
|
||||
```
|
||||
L'APK sera dans: `app/build/outputs/apk/debug/app-debug.apk`
|
||||
|
||||
### Release build (pour production):
|
||||
**Release build (pour production):**
|
||||
```bash
|
||||
./gradlew assembleRelease
|
||||
```
|
||||
L'APK sera dans: `app/build/outputs/apk/release/app-release.apk`
|
||||
|
||||
### Bundle AAB (pour Google Play Store):
|
||||
**Bundle AAB (pour Google Play Store):**
|
||||
```bash
|
||||
./gradlew bundleRelease
|
||||
```
|
||||
Le bundle sera dans: `app/build/outputs/bundle/release/app-release.aab`
|
||||
|
||||
⚠️ **Note**: Avec la méthode manuelle:
|
||||
- Vous devez gérer le versioning manuellement dans `version.properties`
|
||||
- Les fichiers conservent leurs noms par défaut (`app-debug.apk`, `app-release.apk`, `app-release.aab`)
|
||||
- Aucun renommage automatique n'est effectué
|
||||
|
||||
## Vérification du build
|
||||
|
||||
Vérifiez l'APK signé:
|
||||
@@ -69,8 +149,19 @@ jarsigner -verify -verbose -certs app/build/outputs/apk/release/app-release.apk
|
||||
|
||||
## Checklist avant publication
|
||||
|
||||
- [ ] Version code incrémenté dans `build.gradle.kts`
|
||||
- [ ] Version name mise à jour
|
||||
### Si vous utilisez `build.ps1` (recommandé):
|
||||
- [x] Version automatiquement incrémentée par le script
|
||||
- [ ] Type de bump approprié choisi (Major/Minor/Patch)
|
||||
- [ ] Tests passés
|
||||
- [ ] ProGuard configuré et testé
|
||||
- [ ] APK/AAB généré et vérifié
|
||||
- [ ] Captures d'écran prêtes pour le store
|
||||
- [ ] Description de l'app rédigée
|
||||
- [ ] Icône et assets graphiques finalisés
|
||||
|
||||
### Si vous utilisez Gradle manuel:
|
||||
- [ ] Version code incrémenté dans `version.properties`
|
||||
- [ ] Version name mise à jour dans `version.properties`
|
||||
- [ ] Tests passés
|
||||
- [ ] ProGuard configuré et testé
|
||||
- [ ] APK signé et vérifié
|
||||
@@ -78,6 +169,42 @@ jarsigner -verify -verbose -certs app/build/outputs/apk/release/app-release.apk
|
||||
- [ ] Description de l'app rédigée
|
||||
- [ ] Icône et assets graphiques finalisés
|
||||
|
||||
### Workflow recommandé avec `build.ps1`:
|
||||
1. Développement et tests avec `.\build.ps1 -Bump None`
|
||||
2. Quand prêt pour release:
|
||||
- Hotfix: `.\build.ps1 -Type Release -Bump Patch`
|
||||
- Nouvelle fonctionnalité: `.\build.ps1 -Type Release -Bump Minor`
|
||||
- Version majeure: `.\build.ps1 -Type Release -Bump Major`
|
||||
3. Vérifier l'AAB généré dans `app/build/outputs/bundle/release/`
|
||||
4. Soumettre sur Google Play Console
|
||||
|
||||
## Système de Versioning Automatique
|
||||
|
||||
Le projet utilise un système de versioning sémantique (SemVer) automatisé:
|
||||
|
||||
### Fichiers impliqués:
|
||||
- **`version.properties`**: Source unique de vérité pour la version
|
||||
```properties
|
||||
VERSION_NAME=1.0.1
|
||||
VERSION_CODE=3
|
||||
```
|
||||
- **`build.ps1`**: Script qui incrémente la version et lance le build
|
||||
- **`app/build.gradle.kts`**: Lit `version.properties` pour configurer `BuildConfig`
|
||||
- **Settings → À propos**: Affiche dynamiquement `BuildConfig.VERSION_NAME` et `BuildConfig.VERSION_CODE`
|
||||
|
||||
### Règles de versioning:
|
||||
- **Major (X.0.0)**: Changements cassants, refactoring majeur
|
||||
- **Minor (X.Y.0)**: Nouvelles fonctionnalités, rétrocompatibles
|
||||
- **Patch (X.Y.Z)**: Corrections de bugs, petites améliorations
|
||||
- **VERSION_CODE**: Toujours incrémenté pour Google Play Store (doit être unique)
|
||||
|
||||
### Exemples de progression:
|
||||
```bash
|
||||
1.0.0 (code: 1) → Patch → 1.0.1 (code: 2)
|
||||
1.0.1 (code: 2) → Minor → 1.1.0 (code: 3)
|
||||
1.1.0 (code: 3) → Major → 2.0.0 (code: 4)
|
||||
```
|
||||
|
||||
## Notes de sécurité
|
||||
|
||||
⚠️ **IMPORTANT**: Ne jamais commiter ces fichiers:
|
||||
|
||||
Reference in New Issue
Block a user