doc/pages/04.contribute/04.packaging_apps/02.technical_intro/packaging_apps.fr.md

99 lines
5.7 KiB
Markdown
Raw Normal View History

2020-11-11 11:47:10 +01:00
---
2020-11-13 12:48:02 +01:00
title: Packaging d'applications
2020-11-11 11:47:10 +01:00
template: docs
taxonomy:
category: docs
routes:
default: '/packaging_apps'
2020-11-11 11:47:10 +01:00
---
2021-02-06 22:41:01 +01:00
![](image://yunohost_package.png?resize=100)
2013-11-27 13:19:13 +01:00
2015-06-18 19:12:22 +02:00
Ce document a pour but de vous apprendre à packager une application pour YunoHost.
! This page is outdated and should be reworked
2015-06-18 19:12:22 +02:00
### Prérequis
Pour packager une application, voici les prérequis :
2020-10-01 13:31:16 +02:00
* Un compte sur un serveur Git comme [GitHub](https://github.com/) pour pouvoir ensuite publier lapplication;
* Maîtriser un minimum [Git](/packaging_apps_git), le Shell et dautres notions de programmation;
2020-03-28 06:54:10 +01:00
* Une [machine virtuelle ou sur un serveur distant](/install) ou un environnement de développement, [ynh-dev](https://github.com/yunohost/ynh-dev) ou [VirtualBox](/packaging_apps_virtualbox), pour packager et tester son paquet.
2017-02-03 16:21:57 +01:00
2020-03-28 06:54:10 +01:00
Si vous ne comprenez pas ces prérequis, ou si vous ne savez pas comment écrire du code, consulter d'abord l'[introduction au packaging](/packaging_apps_start).
2016-12-07 13:26:25 +01:00
### Contenu
2016-03-30 14:32:52 +02:00
Un paquet YunoHost est composé :
2015-06-18 19:12:22 +02:00
* dun `manifest.json`
* dun dossier `scripts`, composé de six scripts Shell `install`, `remove`, `upgrade`, `backup`, `change_url` et `restore`
2015-06-18 19:59:22 +02:00
* de dossiers optionnels, contenant les `sources` ou de la `conf`
* dun fichier `LICENSE` contenant la licence du paquet
* dune page de présentation du paquet contenu dans un fichier `README.md`
[div class="btn btn-lg btn-default"] [Paquet de base](https://github.com/YunoHost/example_ynh) [/div] nhésitez pas à vous en servir comme base de travail.
2014-11-04 09:37:21 +01:00
2016-01-26 17:29:42 +01:00
## Manifeste
[div class="btn btn-lg btn-default"] [Manifeste](/packaging_apps_manifest) [/div]
## Les scripts
[div class="btn btn-lg btn-default"] [Scripts](/packaging_apps_scripts) [/div]
### Architecture et arguments
2016-01-30 22:00:44 +01:00
Comme les instances de YunoHost possèdent une architecture unifiée, vous serez capable de deviner la plupart des réglages nécessaires. Mais si vous avez besoin de réglages spécifiques, comme le nom de domaine ou un chemin web pour configurer lapplication, vous devrez les demander aux administrateurs lors de linstallation (voir la section `arguments` dans le § **Manifeste** ci-dessus).
[div class="btn btn-lg btn-default"] [Gestion des arguments](/packaging_apps_arguments_management) [/div]
2020-09-15 13:57:31 +02:00
### Configuration NGINX
[div class="btn btn-lg btn-default"] [Configuration NGINX](/packaging_apps_nginx_conf) [/div]
2016-01-30 19:09:53 +01:00
2016-02-24 23:07:50 +01:00
### Multi-instance
[div class="btn btn-lg btn-default"] [Multi-instance](/packaging_apps_multiinstance) [/div]
2016-02-24 23:07:50 +01:00
### Hooks
[div class="btn btn-lg btn-default"] [Hooks](/packaging_apps_hooks) [/div]
2013-12-01 15:20:40 +01:00
### Commandes pratiques
[div class="btn btn-lg btn-default"] [Commandes pratiques](/packaging_apps_helpers) [/div]
2015-08-10 01:11:35 +02:00
2015-08-10 17:57:03 +02:00
### Améliorer la qualité du paquet dinstallation
2016-03-30 14:32:52 +02:00
Vous trouverez ci-dessous une liste des points à vérifier concernant la qualité de vos scripts :
* Vos scripts utilisent bien `sudo cp -a ../sources/. $final_path` plutôt que `sudo cp -a ../sources/* $final_path`;
2020-03-28 06:54:10 +01:00
* Votre script dinstallation contient une gestion en cas derreurs du script pour supprimer les fichiers résiduels à laide de `set -e` et de [trap](/packaging_apps_trap);
2016-03-30 14:32:52 +02:00
* Votre script dinstallation utilise une méthode dinstallation en ligne de commande plutôt quun appel curl via un formulaire web dinstallation;
* Votre script dinstallation enregistre les réponses de lutilisateur;
* Vous avez vérifié les sources de lapplication avec une somme de contrôle (sha256, sha1 ou md5) ou une signature PGP;
2020-07-27 18:55:33 +02:00
* Vos scripts ont été testés sur Debian Buster 32 bits, 64 bits et ARM;
2015-08-10 17:57:03 +02:00
* Les scripts backup et restore sont présents et fonctionnels.
2015-08-10 01:11:35 +02:00
2020-03-28 06:54:10 +01:00
Pour mesurer la qualité d'un paquet, celui-ci obtiendra un [niveau](/packaging_apps_levels), déterminé en fonction de divers critères d'installation et selon le respect des [règles de packaging](/packaging_apps_guidelines).
2016-02-24 21:28:39 +01:00
### Script de vérification du paquet
[div class="btn btn-lg btn-default"] [Vérificateur de paquets](https://github.com/YunoHost/package_checker) [/div]
2016-02-24 21:28:39 +01:00
2016-03-30 14:32:52 +02:00
Il sagit dun script Python qui vérifie :
2016-02-24 21:28:39 +01:00
* que le paquet est à jour concernant les dernières spécifications
2016-02-24 21:30:11 +01:00
* que tous les fichiers sont présents
2016-02-24 21:28:39 +01:00
* que le manifeste ne comporte pas derreur de syntaxe
2016-02-24 21:30:11 +01:00
* que les scripts quittent bien avant de modifier le système lors de vérifications.
2016-02-24 21:28:39 +01:00
2019-03-10 00:37:25 +01:00
### Intégration continue
Un serveur d'intégration continue est a disposition des packagers désirant tester leurs applications.
[div class="btn btn-lg btn-default"] [Intégration continue](packaging_apps_ci) [/div]
2019-03-10 00:37:25 +01:00
2015-06-18 19:12:22 +02:00
### Publiez et demandez des tests de votre application
2021-01-18 15:24:21 +01:00
* Demandez des tests et des retours sur votre application en publiant un [post sur le Forum](https://forum.yunohost.org/) dans la [catégorie `Discussion > Apps`](https://forum.yunohost.org/c/discuss/discuss-apps/).
2015-06-18 19:12:22 +02:00
2020-03-28 06:54:10 +01:00
* Si votre paquet et l'application qu'il contient sont sous licence libre, faites une demande dajout de votre application dans le [dépôt des applications](https://github.com/YunoHost/apps) (voir aussi [la liste des apps](/apps)). Vous pouvez ajouter une application même si celle-ci n'est pour le moment pas fonctionelle : l'état d'avancement peut être `notworking`, `inprogress` ou `working`.
* Si votre application n'est *pas* sous licence libre, il se peut qu'une liste non-officielle soit créée pour gérer ces applications. Ce n'est pour l'instant pas le cas.
2016-03-09 16:14:23 +01:00
2015-06-18 19:59:22 +02:00
### Officialisation dune application
2019-03-08 15:51:42 +01:00
**!! Section obsolète au 08/03/19** - Le fonctionnement du projet est en cours d'évolution sur ce point.
2020-07-27 18:55:33 +02:00
Pour quune application devienne officielle, elle doit être suffisamment testée, stable et fonctionner sous Debian Buster 64 bits, 32 bits et ARM. Si ces conditions vous paraissent réunies, demandez l[intégration officielle](https://github.com/YunoHost/apps) de votre application.