From bb53b68ce4ff8f4aacac1aa4ecfac7e7e482a32c Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Tue, 3 Jan 2023 18:07:28 +0100 Subject: [PATCH] Remove add_or_update script, update README instructions about adding apps to the catalog --- README.md | 51 +++++++++++++++++++++------------------------------ 1 file changed, 21 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index c185bd6..6ec2873 100644 --- a/README.md +++ b/README.md @@ -23,26 +23,36 @@ https://app.yunohost.org/default/. N.B.: The YunoHost project will **NOT** integrate in its catalog applications that are not based on free-software upstreams. +N.B.2 : We strongly encourage you to transfer the ownership of your repository to +the YunoHost-Apps organization on GitHub, such that the community will help you +with keeping your app working and up to date with packaging evolutions. + To add your application to the catalog: * Fork this repository and edit the [apps.json](https://github.com/YunoHost/apps/tree/master/apps.json) file * Add your app's ID and git information at the right alphabetical place * Indicate the app's functioning state: `notworking`, `inprogress`, or `working` -* *Do not* add the level entry by yourself. Our automatic test suite ("the CI") will handle it. +* Indicate the app category, which you can pick from `categories.yml` +* Indicate any anti-feature that your app may be subject to, see `antifeatures.yml` (or remove the `antifeatures` key if there's none) +* Indicate if your app can be thought of as an alternative to popular proprietary services (or remove the `potential_alternative_to` key if there's none) +* *Do not* add the `level` entry by yourself. Our automatic test suite ("the CI") will handle it. * Create a [Pull Request](https://github.com/YunoHost/apps/pulls/) App example addition: ```json - "wallabag": { - "url": "https://github.com/abeudin/wallabag_ynh", - "state": "working" + "your_app": { + "antifeatures": [ + "deprecated-software" + ], + "potential_alternative_to": [ + "YouTube" + ], + "category": "pick_the_appropriate_category", + "state": "working", + "url": "https://github.com/YunoHost-Apps/your_app_ynh" } ``` -N.B.: We strongly encourage you to transfer the ownership of your repository to -the YunoHost-Apps organization on GitHub, such that the community will help you -with keeping your app working and up to date with packaging evolutions. - -N.B.2: Implicitly, the catalog publishes the `HEAD` of branch `master` +N.B: Implicitly, the catalog publishes the `HEAD` of branch `master` (this can be overwritten by adding keys `branch` and `revision`). Therefore, **be careful that any commit on the `master` branch will automatically be published**. **We strongly encourage you to develop in separate branches**, and only @@ -50,28 +60,9 @@ merge changes that were carefully tested. Get in touch with the Apps group to obtain an access to the developer CI where you'll be able to test your app easily. -### Updating apps' level in the catalog +### Updating apps levels in the catalog -App packagers should *not* manually set their apps' level. The levels of all the apps are automatically updated once per week on Friday. - -#### Helper script - -You can use the add_or_update.py Python script to add or update -your app from one of the 2 JSON files. - -Usage: - -```bash -./add_or_update.py apps.json [github/gitlab url OR app name [github/gitlab url OR app name [github/gitlab url OR app name ...]]] -``` - -### How to help translating - -Update on Nov. 2020: this part is broken / not maintained anymore for the -moment... - -We invite you to use [translate.yunohost.org](https://translate.yunohost.org/) -instead of doing Pull Request for files in `locales` folder. +App packagers should *not* manually set their apps' level. The levels of all the apps are automatically updated once per week on Friday, according to the results from the official app CI. ### Apps flagged as not-maintained