Merge pull request #950 from YunoHost/ci-apps-dev

Add doc about ci-apps-dev
This commit is contained in:
Alexandre Aubin 2019-03-19 12:25:53 +01:00 committed by GitHub
commit edea217408
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 96 additions and 2 deletions

View file

@ -20,8 +20,9 @@
* [Package linter](https://github.com/YunoHost/package_linter)
* [Package check](https://github.com/YunoHost/package_check)
* [Applications levels](packaging_apps_levels_fr)
* [App Continuous Integration](https://ci-apps.yunohost.org/jenkins/)
* [App Continuous Integration](https://ci-apps.yunohost.org)
* [App CI dashboard](https://dash.yunohost.org/appci/branch/stable)
* [App Continuous Integration for packagers](/packaging_apps_ci)
* [YEP - YunoHost Enhancement Proposals](packaging_apps_guidelines_fr)
* [Contributing to the YunoHost core](/dev)
* [Setting up a dev environment with ynh-dev](https://github.com/YunoHost/ynh-dev/blob/master/README.md)

View file

@ -20,8 +20,9 @@
* [Package linter](https://github.com/YunoHost/package_linter)
* [Package check](https://github.com/YunoHost/package_check)
* [Niveaux des applications](packaging_apps_levels_fr)
* [Intégration continue des apps](https://ci-apps.yunohost.org/jenkins/)
* [Intégration continue des apps](https://ci-apps.yunohost.org)
* [Tableau de bord du CI des apps](https://dash.yunohost.org/appci/branch/stable)
* [Intégration continue pour packagers](/packaging_apps_ci)
* [YEP - YunoHost Enhancement Proposals](packaging_apps_guidelines_fr)
* [Contribuer à la partie "core" de YunoHost](/dev_fr)
* [Déployer un environnement de dev avec ynh-dev](https://github.com/YunoHost/ynh-dev/blob/master/README.md)

View file

@ -115,6 +115,11 @@ This Python script checks:
* that the manifest doesn't have syntax errors
* that scripts exit well before modifing the system during verification.
### Continuous integration
A continuous integration server is available for packagers who want to test their apps.
<a class="btn btn-lg btn-default" href="packaging_apps_ci">Continuous integration</a>
### Publish and ask for testing your application
* Publishing a [post on the Forum](https://forum.yunohost.org/) with the [`App integration` category](https://forum.yunohost.org/c/app-integration), to ask for testing and feedback on your application.

41
packaging_apps_ci.md Normal file
View file

@ -0,0 +1,41 @@
# Continuous integration
A continuous integration server is available for any packager willing to test an app with [Package_check](https://github.com/YunoHost/package_check).
<a class="btn btn-lg btn-default" href="https://ci-apps-dev.yunohost.org">ci-apps-dev</a>
This server is free to use for any of you, you just need an account.
To do so, ask to a member of the Apps group on our [Applications chatroom](/chat_rooms)
To create an account on this CI, you'll need two things:
- A name (To create an user and to give it a directory).
- A public ssh key (For your access to the server).
When that's done, you'll be able to access the server and put your apps on it.
To connect to the server use:
```bash
ssh USER@ci-apps-dev.yunohost.org -i YOUR_PRIVATE_KEY
```
You will find an empty directory, ready to receive your apps.
As soon as you push an app into your directory, in a 5 minutes maximum delay, a new job will be created for this app and executed by the CI.
Each time you will update this app, a new test will be executed.
However, to prevent any security issues, your ssh connection will be very limited.
You can only use `sftp` or `rsync` to copy your apps into that directory. `Git` isn't available, neither most of the usual bash commands.
To ease your usage of this CI, a small script can be used to copy your apps to your directory.
Copy this [script](https://raw.githubusercontent.com/YunoHost/CI_package_check/master/dev_CI/Send%20CI%20dev.sh) into your usual working directory and fill it with your info.
---
# Other continuous integration servers
For your information, here the list of all our continuous integration servers.
Those CI are automatic, you can't use them directly. They're working on their own.
- [Official CI](https://ci-apps.yunohost.org): Our official CI, working on a x86-64 system. It is in charge of determining levels for all working apps.
- [ARM CI](https://ci-apps-arm.yunohost.org): This CI is working with multiple Raspberry-Pi, own by members of the YunoHost community. Tests are running on Raspberry-Pi to determine if apps are working on this architecture.
- [Unstable/Testing CI](https://ci-apps-unstable.yunohost.org): CI designed to run tests on the branches Unstable and Testing of YunoHost. Its purpose is to test those branches before an official release.
- [Jessie CI](https://ci-stretch.nohost.me): CI running on a Debian Jessie system. This CI determine is apps are still working with the previous version of Debian and YunoHost before the version 3.
- [HQ CI](https://ci-apps-hq.yunohost.org): **Incoming...** This CI runs automatic tests on branches of High Quality apps. Except the master branch, which is exclude from this CI, all branches added to a High Quality app will be added to this CI to be tested.

41
packaging_apps_ci_fr.md Normal file
View file

@ -0,0 +1,41 @@
# Intégration continue
Un serveur d'intégration continue est disponible pour tout packager souhaitant tester une application avec [Package_check](https://github.com/YunoHost/package_check).
<a class="btn btn-lg btn-default" href="https://ci-apps-dev.yunohost.org">ci-apps-dev</a>
Ce serveur est libre d'accès pour chacun d'entre vous, vous avez juste besoin d'un compte.
Pour ce faire, demandez à un membre du groupe Apps sur notre [chatroom Applications](/chat_rooms)
Pour créer un compte sur ce CI, vous aurez besoin de deux choses:
- Un nom (Pour créer un utilisateur et lui donner un répertoire).
- Une clé ssh publique (Pour votre accès au serveur).
Une fois cela fait, vous pourrez accéder au serveur et y déposer vos applications.
Pour vous connecter au serveur, utilisez :
```bash
ssh USER@ci-apps-dev.yunohost.org -i YOUR_PRIVATE_KEY
```
Vous trouverez un répertoire vide, prêt à recevoir vos applications.
Dès que vous déposer une application dans votre répertoire, dans un délai maximum de 5 minutes, un nouveau job sera créé pour cette application et exécuté par le CI.
Chaque fois que vous mettrez à jour cette application, un nouveau test sera exécuté.
Cependant, pour éviter tout problème de sécurité, votre connexion ssh sera très limitée.
Vous ne pouvez utiliser que `sftp` ou `rsync` pour copier vos applications dans ce répertoire. `Git` n'est pas disponible, ni la plupart des commandes bash habituelles.
Pour faciliter votre utilisation de ce CI, un petit script peut être utilisé pour copier vos applications dans votre répertoire.
Copiez ce [script](https://raw.githubusercontent.com/YunoHost/CI_package_check/master/dev_CI/Send%20CI%20dev.sh) dans votre répertoire de travail habituel et indiquez vos informations.
---
# Autres serveurs d'intégration continue
Pour votre information, voici la liste de tous nos serveurs d'intégration continue.
Ces CI sont automatiques, vous ne pouvez pas les utiliser directement. Ils travaillent seuls.
- [Official CI](https://ci-apps.yunohost.org): Notre CI officiel, travaillant sur un système x86-64. Il est chargé de déterminer les niveaux pour toutes les applications notées 'working'.
- [ARM CI](https://ci-apps-arm.yunohost.org): Ce CI travaille avec plusieurs Raspberry-Pi, appartenant à des membres de la communauté YunoHost. Les tests sont exécutés sur Raspberry-Pi pour déterminer si les applications fonctionnent sur cette architecture.
- [Unstable/Testing CI](https://ci-apps-unstable.yunohost.org): CI conçu pour effectuer des tests sur les branches Unstable et Testing de YunoHost. Son rôle est de tester ces branches avant une sortie officielle.
- [Jessie CI](https://ci-stretch.nohost.me): CI fonctionnant sur un système Debian Jessie. Ce CI détermine si les applications fonctionnent toujours avec la version précédente de Debian et YunoHost avant la version 3.
- [HQ CI](https://ci-apps-hq.yunohost.org): **A venir...** Ce CI exécute des tests automatiques sur les branches des applications High Quality. A l'exception de la branche master, qui est exclue de ce CI, toutes les branches ajoutées à une application High Quality seront ajoutées à ce CI pour être testées.

View file

@ -97,6 +97,11 @@ Il sagit dun script Python qui vérifie :
* que le manifeste ne comporte pas derreur de syntaxe
* que les scripts quittent bien avant de modifier le système lors de vérifications.
### Intégration continue
Un serveur d'intégration continue est a disposition des packagers désirant tester leurs applications.
<a class="btn btn-lg btn-default" href="packaging_apps_ci">Intégration continue</a>
### Publiez et demandez des tests de votre application
* Demandez des tests et des retours sur votre application en publiant un [post sur le Forum](https://forum.yunohost.org/) dans la [catégorie `App integration`](https://forum.yunohost.org/c/app-integration).