computablefacts/ynh-apps repository overview

⁠Computablefacts application catalog

⁠How-to build locally

Simply lauch the script ./rebuild.sh.

It should regenerate the files into ./builds/default/. You could see the build progress in the logfile ./app_list_auto_update.log. You could watch the JSON into builds/default/v3/apps.json.

⁠How-to deploy

When all is OK, commit your changes. Then you should tag the repo with git tag 1.6.7 (change the tag). Then push the new tag with git push --tags.

Docker Hub will build a new Docker image with that tag. You can check that here⁠.

Our catalog is deployed on Swarm. You must change the tag of the image for the service cf-ynh-apps_web to deploy the tagged version.

⁠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.toml⁠ 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?

• You can browse the contributor documentation : https://yunohost.org/contributordoc⁠
• If you are not familiar with Git/GitHub, you can have a look at our homemade guide⁠
• Don't hesitate to reach for help on the dedicated application packaging chatroom⁠ ... we can even schedule an audio meeting to help you get started!

⁠How to add your app to the application catalog

To add your application to the catalog:

• Fork this repository and edit the apps.toml⁠ file
• Add your app's ID and git information at the right alphabetical place
• Indicate the app's functioning state: notworking, inprogress, or working
• Indicate the app category, which you can pick from categories.toml
• Indicate any anti-feature that your app may be subject to, see antifeatures.toml (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⁠

App example addition:

[your_app]
antifeatures = [ "deprecated-software" ]   # Remove if no relevant antifeature applies
potential_alternative_to = [ "YouTube" ]   # Indicate if your app can be thought of as an alternative to popular proprietary services (or remove if none applies)
category = "foobar"                        # Replace with the appropriate category id found in categories.toml
state = "working"
url = "https://github.com/YunoHost-Apps/your_app_ynh"

⁠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, according to the results from the official app CI.

⁠Apps flagged as not-maintained

Applications with no recent activity and no active sign from maintainer may be flagged in apps.toml with the package-not-maintained antifeature tag to signify that the app is inactive and may slowly become outdated with respect to the upstream, or with respect to good packaging practices. It does not mean that the app is not working anymore.

Feel free to contact the app group if you feel like taking over the maintenance of a currently unmaintained app!