14 KiB
Quality levels of YunoHost application packages
In order to facilitate the packaging of applications by providing successive steps to achieve, each package is assigned a quality level, from 0 to 10.
A package must meet a number of criteria to reach each level. In addition, to reach a level, the package must have previously reached the previous level.
This classification of applications by levels has 3 advantages:
- The application packaging is more fun, with clear objectives to achieve and successive steps.
- A properly packaged application is put forward more than an application that does not comply with packaging rules.
- Users can quickly see the level of an application and thus know if the package is of good quality.
Level summary
Level 0 The application does not work.
Level 1 The application installs and uninstalls correctly in some cases.
Level 2 The application installs and uninstalls correctly in all common configurations.
Level 3 The application can be updated.
Level 4 The application can be saved and restored.
Level 5 The application package code follows some syntax rules.
Level 6 The application package is in the YunoHost-Apps organization.
Level 7 The application package passes all integrity tests successfully.
Level 8 The application package respects all packaging recommendations. This is a high quality app.
Level 9 The application complies with higher packaging recommendations. Not available yet.
Level 10 The application package is considered perfect!
Quality levels in detail:
Level 0
The application does not install or run after installation.
This is the lowest level, a level 0 application is considered non-functional.
YEP to be respected to reach level 0:
Level 1
The application can be installed and uninstalled correctly.
But exceptions are possible, if at least one installation method is functional and its removal then the application is considered functional.
YEP to be respected to reach level 1:
- YEP 2.2 Use bash for main scripts
- YEP 2.5 Correctly copy files
- YEP 2.7 Bash instructions: Give sufficient permissions to bash instructions
- YEP 2.15 : Follow the application installation instructions
Level 2
The application can be installed and uninstalled in all common configurations.
- Installation in subfolder.
- Installation at the root of a domain or subdomain.
- Private installation (secured by the SSO).
- Public installation.
- Multi-instance installation.
- Uninstallation under the same circumstances.
If an application does not allow certain installation configurations, these must be clearly indicated in the README. However, level 2 cannot be reached if an installation configuration is intentionally discarded without valid reason.
This does not preclude the voluntary restriction of public, private or multi-instance if it is relevant for this application.
YEP to be respected to reach level 2:
- YEP 1.5 : Update app status regularly
- YEP 2.18.2 : Support installation on a domain
- YEP 2.18.3 : Support installation on a subdomain
- YEP 2.18.4 : Support installation on a subfolder
- YEP 4.6 : Manage multi-instance
Level 3
The application supports upgrade from an older version of the package.
The application must be able to be updated from a previous version of the package without causing an error.
YEP to be respected to reach level 3:
- YEP 2.3 Save answers during installation
Level 4
The application can be backed up and restored without error on the same machine or another.
YEP to be respected to reach level 4:
- YEP 4.3 : Provide a functional YunoHost backup script
- YEP 4.4 : Provide a functional YunoHost restore script
Level 5
The application has no errors in Package linter.
There may be false positives in Package linter. These situations will be handled on a case-by-case basis.
YEP to be respected to reach level 5:
- YEP 1.3 : Specify the license associated with the package
- YEP 2.1 : Respect manifest format
- YEP 2.12 : Use practical commands (helpers)
- YEP 2.18.1 : Run the webapp installation script correctly
Level 6
The application can be backed up and restored without error on the same machine or another.
YEP to be respected to reach level 6:
- YEP 1.4 : Inform about the intention to maintain a package
- YEP 1.6 : As a maintainer, keep checking and being aware of the evolution of apps packaging
- YEP 1.7 : Add app to the YunoHost-Apps organization
- YEP 1.8 : Publish test requests
- YEP 1.9 : Document app
- YEP 1.10 : Keep a clean version history
- YEP 2.9 : Remove all traces of the app during deletion
- YEP 3.3 : Facilitating source integrity control
- YEP 3.5 : Follow the recommendations of the app documentation
- YEP 3.6 : Update versions containing CVEs
Level 7
The application has no errors in Package check.
Considering the maximum number of tests possible for the application.
YEP à respecter pour atteindre le niveau 7:
- YEP 2.4 : Error detection and management
- YEP 2.6 : Cancel action if input values are incorrect
- YEP 2.8 : Change a system configuration correctly
- YEP 2.10 : Configure application logs
- YEP 2.11 : Use a variable rather than the app id directly
- YEP 2.13 : Translate the package into English
- YEP 3.2 : Open port: Open port correctly
Level 8
The application package respects all packaging recommendations. This is a high quality app.
YEP to be respected to reach level 8:
- YEP 1.12 : Follow the template from example_ynh
- Supports change of URL
- YEP 2.16 : Check dependency availability on ARM, x86 and x64
- YEP 2.18.5 : Add the YunoHost tile to easily navigate between applications
- YEP 4.1 : Link to ldap
- YEP 4.2 : Bind authentication to sso
- YEP 4.5 : Use hooks
If an application is not available on an architecture, and it is impossible to circumvent this limitation reasonably, this limitation must be indicated in the REDME and taken into account in the installation script. The installation of the application on an unsupported architecture must be stopped before modifying the filesystem.
Level 9
The application complies with all optional YEPs.
YEP to be respected to reach level 9:
- YEP 2.14 : Fill a conf file correctly
- YEP 2.17 : Take into account the original version during updates
- YEP 3.4 : Isolate app
- YEP 4.2.1 : Logout
Level 10
The application is considered perfect.
This ultimate level for an application can only be reached after an in-depth study of the package and by the validation of the Apps group.