Skip to content

Latest commit

 

History

History
92 lines (67 loc) · 4.68 KB

README.md

File metadata and controls

92 lines (67 loc) · 4.68 KB
Raw

YunoHost application catalog

Here you will find the repositories and versions of every apps available in YunoHost's default catalog.

It is browsable here: https://yunohost.org/apps

The main file of the catalog is apps.json which contains references to the corresponding git repositories for each application, along with a few metadata about them such as its category or maintenance state. This file regularly read by list_builder.py which publish the results on https://app.yunohost.org/default/.

Where can I learn about app packaging in Yunohost ?

How to add your app to the application catalog

N.B. : the Yunohost project will NOT integrate in its catalog applications that are not based on free-software upstreams.

To add your application to the catalog:

  • Fork this repository and edit the 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.
  • Create a Pull Request

App example addition:

    "wallabag": {
        "branch": "master",
        "revision": "HEAD",
        "url": "https://github.com/abeudin/wallabag_ynh",
        "state": "working"
    }

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 : If "revision": "HEAD" is used in apps.json, any commit to the master branch on your app will automatically be published to the catalog. Therefore we strongly encourage you to develop in separate branches, and only 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.

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:

./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 instead of doing Pull Request for files in locales folder.

How to make my app flagged as High Quality ?

A High Quality app will be highlighted in the app list and marked as a level 9 app.
To become a High Quality app, a package has to follow the criterias listed here.

Once the app is validated is "high quality", the tag "high_quality": true shall be added to the app infos inside the catalog (apps.json).

What to do if I can't maintain my app anymore ?

If you don't have time anymore to maintain an app, you can update its status to inform users and packagers that you will not maintain it anymore.
In order to do so, use the tag "maintained":.
This tag can have 5 different values:

  • "maintained": true That's the default value if the tag isn't present for your app. That simply means that this app is maintained.
  • "maintained": "request_help" Use that value to inform other packagers that you need help to maintain this app. You'll then be more than one maintainer for this apps.
  • "maintained": "request_adoption" Use that value to inform other packagers, as well as users, that you're going to give up that app. So that you would like another maintainer to take care of it.
  • "maintained": false or "maintained": "orphaned" This value means that this app is no longer maintained... That means also that a packager can declare himself/herself as its new maintainer.
    Please contact the Apps group if you want to take care of an unmaintained app.

If you want to modify the status of one of your apps, for any reason, please consider informing the community via the forum. Users would probably be glad to be informed that an app they use will become unmaintained.