mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
5.3 KiB
5.3 KiB
Packaging d’applications : les bonnes pratiques
Cette page est en cours d'élaboration. Tant que cet avertissement n'est pas enlevé. Considérez ces informations comme potentiellement fausse.
Introduction
Ce document a pour but de lister les différentes bonnes pratiques concernant la création de paquet d'application YunoHost.
Chaque bonne pratique est numérotée avec un numéro suffixé par les lettres YEP (YunoHost Enhancement Proposals), ceci afin de pouvoir y faire référence facilement dans les outils d'analyse automatique de paquet (package checker, package linter), mais également lors des revues de code.
Statut : brouillon, validé, refusé, obsolète Nécessaire si : YEP nécessaire pour atteindre le statut indiqué
Index des YEP
| Nécessaire si | ID | Titre | Status | Test |
|---|---|---|---|---|
| YEP 1 | Communiquer avec la communauté | |||
| NOTWORKING | YEP 1.1 | Nommer son app et son dépot | validé | manuel |
| NOTWORKING | YEP 1.2 | Inscrire l'app sur un "répertoire" connu | validé | manuel |
| WORKING | YEP 1.3 | Indiquer la licence associée au paquet | validé | AUTO |
| WORKING | YEP 1.4 | Informer sur l'intention de maintenir un paquet | brouillon | manuel |
| WORKING | YEP 1.5 | Mettre à jour régulièrement le statut de l'app | brouillon | manuel |
| OFFICIAL | YEP 1.6 | Se tenir informé sur l'évolution du packaging d'apps | validé | manuel |
| OFFICIAL | YEP 1.7 | Ajouter l'app à l'organisation YunoHost-Apps | validé | manuel |
| OFFICIAL | YEP 1.8 | Publier des demandes de test | validé | manuel |
| OFFICIAL | YEP 1.9 | Documenter l'app | validé | AUTO |
| OFFICIAL | YEP 1.10 | Garder un historique de version propre | brouillon | manuel |
| OFFICIAL | YEP 1.11 | Ajouter l'app au bugtracker YunoHost | brouillon | manuel |
| YEP 2 | Stabiliser une app | |||
| INPROGRESS | YEP 2.1 | Respecter le format du manifeste | validé | auto |
| WORKING | YEP 2.2 | Utiliser bash pour les scripts principaux | validé | auto |
| WORKING | YEP 2.3 | Sauvegarder les réponses lors de l'installation | validé | manuel |
| WORKING | YEP 2.4 | Détecter et gérer les erreurs | brouillon | manuel |
| WORKING | YEP 2.5 | Copier correctement des fichiers | brouillon | manuel |
| WORKING | YEP 2.6 | Annuler l'action si les valeurs d'entrées sont incorrectes | validé | manuel |
| WORKING | YEP 2.7 | Donner des permissions suffisantes aux instructions bash | validé | auto |
| WORKING | YEP 2.8 | Modifier correctement une configuration système | brouillon | manuel |
| WORKING | YEP 2.9 | Enlever toutes traces de l'app lors de la suppression | brouillon | manuel |
| WORKING | YEP 2.10 | Configurer les logs de l'application | brouillon | manuel |
| OFFICIAL | YEP 2.11 | Utiliser une variable plutôt que l'app id directement | validé | manuel |
| OFFICIAL | YEP 2.12 | Utiliser les commandes pratiques (helpers) | validé | auto |
| OFFICIAL | YEP 2.13 | Traduire le package en anglais | brouillon | manuel |
| OFFICIAL | YEP 2.14 | Remplir correctement un fichier de conf | brouillon | manuel |
| OFFICIAL | YEP 2.15 | Vérifier les paramètres saisies par l'utilisateur | validé | manuel |
| OFFICIAL | YEP 2.16 | Vérifier la disponibilité des dépendances sur ARM, x86 et x64 | validé | manuel |
| OFFICIAL | YEP 2.17 | Prendre en compte la version d'origine lors des mises à jour | validé | manuel |
| YEP 2.18 | Stabiliser une webapp | |||
| WORKING | YEP 2.18.1 | Lancer le script d'installation d'une webapp correctement | validé | manuel |
| WORKING | YEP 2.18.2 | Supporter l'installation sur un domaine | validé | auto |
| WORKING | YEP 2.18.3 | Supporter l'installation sur un sous-domaine | validé | auto |
| OFFICIAL | YEP 2.18.4 | Supporter l'installation sur un sous-dossier | validé | auto |
| OFFICIAL | YEP 2.18.5 | Ajouter la tuile YunoHost pour naviguer facilement entre les applications | validé | manuel |
| YEP 3 | Sécuriser une app | |||
| NOTWORKING | YEP 3.1 | Ne pas demander ou stocker de mot de passe LDAP | brouillon | manuel |
| WORKING | YEP 3.2 | Ouvrir un port correctement | brouillon | manuel |
| OFFICIAL | YEP 3.3 | Faciliter le contrôle de l'intégrité des sources | brouillon | manuel |
| OFFICIAL | YEP 3.4 | Isoler l'app | brouillon | manuel |
| OFFICIAL | YEP 3.5 | Suivre les recommendations de la documentation de l'app | validé | manuel |
| YEP 4 | Intégrer une app | |||
| OFFICIAL | 4.1 | Lier au ldap | validé | manuel |
| OFFICIAL | YEP 4.2 | Lier l'authentification au sso | validé | manuel |
| OFFICIAL | YEP 4.2.1 | Déconnexion | validé | manuel |
| OFFICIAL | YEP 4.3 | Fournir un script de sauvegarde YunoHost fonctionnel | validé | auto |
| OFFICIAL | YEP 4.4 | Fournir un script de restauration YunoHost fonctionnel | validé | auto |
| OPTIONAL | YEP 4.5 | Utiliser les hooks | validé | manuel |
| OPTIONAL | YEP 4.6 | Gère le multi-instance | validé | manuel |
| OPTIONAL | YEP 4.7 | Ajouter un module à la CLI | validé | manuel |
| OPTIONAL | YEP 4.8 | Ajouter un module à l'admin web | brouillon | manuel |