feat(make_readme): add some tests

README.md

@@ -1,6 +1,6 @@
 # YunoHost application catalog
 
-<img alt="YunoHost logo" src="https://avatars.githubusercontent.com/u/1519495?s=200&v=4" width=80><img alt="Package logo" src="https://yunohost.org/user/images/yunohost_package.png" width=80>
+<img src="https://avatars.githubusercontent.com/u/1519495?s=200&v=4" width=80><img src="https://yunohost.org/user/images/yunohost_package.png" width=80>
 
 This repository contains the default YunoHost app catalog, as well as related
 tools that can be run manually or automatically.
@@ -16,7 +16,7 @@ them such as their category or maintenance state. This file is regularly read by
 
 - 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](https://yunohost.org/packaging_apps_git)
-- Don't hesitate to reach for help on the dedicated [application packaging chatroom](https://yunohost.org/chat_rooms)... we can even schedule an audio meeting to help you get started!
+- Don't hesitate to reach for help on the dedicated [application packaging chatroom](https://yunohost.org/chat_rooms) ... we can even schedule an audio meeting to help you get started!
 
 ## How to add your app to the application catalog
 
@@ -46,9 +46,9 @@ App example addition:
 
 ```toml
 [your_app]
-antifeatures = [ "deprecated-software" ]   # Replace with the appropriate category id found in antifeatures.toml, remove if no relevant antifeature applies
+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, don't invent a category
+category = "foobar"                        # Replace with the appropriate category id found in categories.toml
 state = "working"
 url = "https://github.com/YunoHost-Apps/your_app_ynh"
 ```

apps.toml

@@ -37,7 +37,6 @@ level = 6
 state = "working"
 subtags = [ "microblogging", "pictures" ]
 url = "https://github.com/YunoHost-Apps/acropolis_ynh"
-antifeatures = ["deprecated-software"]
 
 [actual]
 category = "productivity_and_management"
@@ -60,7 +59,6 @@ level = 8
 state = "working"
 subtags = [ "db" ]
 url = "https://github.com/YunoHost-Apps/adminer_ynh"
-antifeatures = ["deprecated-software"]
 
 [aeneria]
 category = "iot"
@@ -75,7 +73,6 @@ potential_alternative_to = [ "Google Agenda", "Microsoft Outlook" ]
 state = "working"
 subtags = [ "calendar" ]
 url = "https://github.com/YunoHost-Apps/agendav_ynh"
-antifeatures = ["deprecated-software"]
 
 [agora]
 category = "wat"
@@ -188,7 +185,6 @@ category = "iot"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/beehive_ynh"
-antifeatures = ["deprecated-software"]
 
 [biboumi]
 category = "communication"
@@ -203,7 +199,6 @@ level = 7
 state = "working"
 subtags = [ "books" ]
 url = "https://github.com/YunoHost-Apps/bicbucstriim_ynh"
-antifeatures = ["deprecated-software"]
 
 [blogotext]
 category = "publishing"
@@ -212,7 +207,6 @@ potential_alternative_to = [ "Blogger", "Coldfusion", "Wix" ]
 state = "working"
 subtags = [ "blog" ]
 url = "https://github.com/YunoHost-Apps/blogotext_ynh"
-antifeatures = ["deprecated-software"]
 
 [bludit]
 category = "publishing"
@@ -337,7 +331,6 @@ category = "small_utilities"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/cheky_ynh"
-antifeatures = ["deprecated-software"]
 
 [chitchatter]
 category = "communication"
@@ -441,7 +434,6 @@ potential_alternative_to = [ "Disqus" ]
 state = "working"
 subtags = [ "website" ]
 url = "https://github.com/YunoHost-Apps/commento_ynh"
-antifeatures = ["deprecated-software"]
 
 [compteur_du_gase]
 category = "office"
@@ -495,7 +487,7 @@ subtags = [ "db" ]
 url = "https://github.com/YunoHost-Apps/couchdb_ynh"
 
 [couchpotato]
-antifeatures = [ "package-not-maintained", "deprecated-software" ]
+antifeatures = [ "package-not-maintained" ]
 category = "multimedia"
 level = 0
 potential_alternative_to = [ "Netflix" ]
@@ -665,7 +657,6 @@ level = 6
 state = "working"
 subtags = [ "pastebin" ]
 url = "https://github.com/YunoHost-Apps/distbin_ynh"
-antifeatures = ["deprecated-software"]
 
 [django-fmd]
 category = "iot"
@@ -845,7 +836,6 @@ category = "small_utilities"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/encryptor-decryptor_ynh"
-antifeatures = ["deprecated-software"]
 
 [endi]
 category = "productivity_and_management"
@@ -875,7 +865,6 @@ potential_alternative_to = [ "Google Sheets", "G Suite", "Microsoft Excel", "Off
 state = "working"
 subtags = [ "spreadsheet" ]
 url = "https://github.com/YunoHost-Apps/ethercalc_ynh"
-antifeatures = ["deprecated-software"]
 
 [etherpad]
 category = "office"
@@ -913,7 +902,6 @@ level = 8
 state = "working"
 subtags = [ "monitoring" ]
 url = "https://github.com/YunoHost-Apps/facette_ynh"
-antifeatures = ["deprecated-software"]
 
 [facilmap]
 category = "productivity_and_management"
@@ -955,7 +943,6 @@ potential_alternative_to = [ "WeTransfer" ]
 state = "working"
 subtags = [ "files" ]
 url = "https://github.com/YunoHost-Apps/filepizza_ynh"
-antifeatures = ["deprecated-software"]
 
 [firefish]
 category = "social_media"
@@ -1015,7 +1002,6 @@ potential_alternative_to = [ "Invision Community", "Vanilla", "vBulletin", "XenF
 state = "working"
 subtags = [ "forum" ]
 url = "https://github.com/YunoHost-Apps/fluxbb_ynh"
-antifeatures = ["deprecated-software"]
 
 [focalboard]
 category = "productivity_and_management"
@@ -1137,7 +1123,6 @@ level = 8
 state = "working"
 subtags = [ "website", "blog" ]
 url = "https://github.com/YunoHost-Apps/getsimple_ynh"
-antifeatures = ["deprecated-software"]
 
 [ghost]
 antifeatures = [ "arbitrary-limitations" ]
@@ -1369,7 +1354,6 @@ category = "system_tools"
 level = 7
 state = "working"
 url = "https://github.com/Yunohost-Apps/httpsh_ynh"
-antifeatures = ["deprecated-software"]
 
 [hubzilla]
 category = "social_media"
@@ -1458,6 +1442,7 @@ subtags = [ "videos" ]
 url = "https://github.com/YunoHost-Apps/invidious_ynh"
 
 [invoiceninja]
+antifeatures = [ "deprecated-software" ]
 category = "productivity_and_management"
 level = 7
 state = "working"
@@ -1490,7 +1475,7 @@ state = "working"
 url = "https://github.com/YunoHost-Apps/jackett_ynh"
 
 [jappix]
-antifeatures = [ "package-not-maintained", "deprecated-software" ]
+antifeatures = [ "package-not-maintained" ]
 category = "communication"
 level = 7
 state = "working"
@@ -1661,7 +1646,7 @@ subtags = [ "text" ]
 url = "https://github.com/YunoHost-Apps/languagetool_ynh"
 
 [laverna]
-antifeatures = [ "package-not-maintained", "deprecated-software" ]
+antifeatures = [ "package-not-maintained" ]
 category = "office"
 level = 7
 state = "working"
@@ -1742,7 +1727,6 @@ level = 7
 state = "working"
 subtags = [ "wiki" ]
 url = "https://github.com/YunoHost-Apps/libreto_ynh"
-antifeatures = ["deprecated-software"]
 
 [libretranslate]
 category = "small_utilities"
@@ -1790,7 +1774,6 @@ level = 6
 state = "working"
 subtags = [ "monitoring" ]
 url = "https://github.com/YunoHost-Apps/linuxdash_ynh"
-antifeatures = ["deprecated-software"]
 
 [lionwiki-t2t]
 category = "publishing"
@@ -1829,7 +1812,6 @@ potential_alternative_to = [ "Google Docs", "Microsoft Excel" ]
 state = "working"
 subtags = [ "spreadsheet" ]
 url = "https://github.com/YunoHost-Apps/luckysheet_ynh"
-antifeatures = ["deprecated-software"]
 
 [lufi]
 category = "synchronization"
@@ -2004,7 +1986,6 @@ level = 8
 state = "working"
 subtags = [ "chat" ]
 url = "https://github.com/YunoHost-Apps/minchat_ynh"
-antifeatures = ["deprecated-software"]
 
 [mindmaps]
 category = "office"
@@ -2012,7 +1993,6 @@ level = 8
 state = "working"
 subtags = [ "mindmap" ]
 url = "https://github.com/YunoHost-Apps/mindmaps_ynh"
-antifeatures = ["deprecated-software"]
 
 [minetest]
 category = "games"
@@ -2026,7 +2006,6 @@ category = "publishing"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/mineweb_ynh"
-antifeatures = ["deprecated-software"]
 
 [minidlna]
 category = "multimedia"
@@ -2139,7 +2118,6 @@ level = 8
 state = "working"
 subtags = [ "meeting" ]
 url = "https://github.com/YunoHost-Apps/mumble-web_ynh"
-antifeatures = ["deprecated-software"]
 
 [mumbleserver]
 category = "communication"
@@ -2375,7 +2353,6 @@ category = "wat"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/osjs_ynh"
-antifeatures = ["deprecated-software"]
 
 [osticket]
 category = "productivity_and_management"
@@ -2613,7 +2590,6 @@ level = 8
 state = "working"
 subtags = [ "website", "blog" ]
 url = "https://github.com/YunoHost-Apps/pico_ynh"
-antifeatures = ["deprecated-software"]
 
 [pihole]
 category = "system_tools"
@@ -2713,7 +2689,6 @@ potential_alternative_to = [ "Wix" ]
 state = "working"
 subtags = [ "website" ]
 url = "https://github.com/YunoHost-Apps/prettynoemiecms_ynh"
-antifeatures = ["deprecated-software"]
 
 [privatebin]
 category = "small_utilities"
@@ -2995,7 +2970,6 @@ category = "small_utilities"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/scrumblr_ynh"
-antifeatures = ["deprecated-software"]
 
 [scrutiny]
 category = "system_tools"
@@ -3061,7 +3035,6 @@ category = "system_tools"
 level = 6
 state = "working"
 url = "https://github.com/YunoHost-Apps/shellinabox_ynh"
-antifeatures = ["deprecated-software"]
 
 [shiori]
 category = "small_utilities"
@@ -3084,7 +3057,6 @@ potential_alternative_to = [ "bitly" ]
 state = "working"
 subtags = [ "url_shortener" ]
 url = "https://github.com/YunoHost-Apps/shuri_ynh"
-antifeatures = ["deprecated-software"]
 
 [signaturepdf]
 category = "small_utilities"
@@ -3097,14 +3069,12 @@ category = "small_utilities"
 level = 6
 state = "working"
 url = "https://github.com/YunoHost-Apps/simple-file-manager_ynh"
-antifeatures = ["deprecated-software"]
 
 [simple-hash-generator]
 category = "small_utilities"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/simple-hash-generator_ynh"
-antifeatures = ["deprecated-software"]
 
 [simple-torrent]
 antifeatures = [ "deprecated-software" ]
@@ -3122,7 +3092,7 @@ subtags = [ "chat" ]
 url = "https://github.com/YunoHost-Apps/simplex_ynh"
 
 [simplytranslate]
-antifeatures = [ "non-free-network", "deprecated-software" ]
+antifeatures = [ "non-free-network" ]
 category = "small_utilities"
 level = 7
 state = "working"
@@ -3134,7 +3104,6 @@ level = 8
 state = "working"
 subtags = [ "website" ]
 url = "https://github.com/YunoHost-Apps/sitemagiccms_ynh"
-antifeatures = ["deprecated-software"]
 
 [slingcode]
 category = "dev"
@@ -3142,7 +3111,6 @@ level = 8
 state = "working"
 subtags = [ "programming" ]
 url = "https://github.com/YunoHost-Apps/slingcode_ynh"
-antifeatures = ["deprecated-software"]
 
 [snappymail]
 category = "communication"
@@ -3231,7 +3199,6 @@ category = "system_tools"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/ssh_chroot_dir_ynh"
-antifeatures = ["deprecated-software"]
 
 [statpingng]
 category = "system_tools"
@@ -3261,7 +3228,6 @@ potential_alternative_to = [ "Google Slides", "Office 365", "Prezi", "SoZi" ]
 state = "working"
 subtags = [ "impress" ]
 url = "https://github.com/YunoHost-Apps/strut_ynh"
-antifeatures = ["deprecated-software"]
 
 [superset]
 category = "wat"
@@ -3318,7 +3284,7 @@ state = "working"
 url = "https://github.com/YunoHost-Apps/tandoor_ynh"
 
 [taskboard]
-antifeatures = [ "package-not-maintained", "deprecated-software" ]
+antifeatures = [ "package-not-maintained" ]
 category = "productivity_and_management"
 level = 7
 potential_alternative_to = [ "Trello" ]
@@ -3504,7 +3470,6 @@ level = 8
 state = "working"
 subtags = [ "task" ]
 url = "https://github.com/YunoHost-Apps/tyto_ynh"
-antifeatures = ["deprecated-software"]
 
 [ulogger]
 category = "small_utilities"
@@ -3622,7 +3587,6 @@ category = "wat"
 level = 8
 state = "working"
 url = "https://github.com/YunoHost-Apps/wemawema_ynh"
-antifeatures = ["deprecated-software"]
 
 [wetty]
 category = "system_tools"
@@ -3791,7 +3755,6 @@ level = 6
 potential_alternative_to = [ "Mullvad" ]
 state = "working"
 url = "https://github.com/YunoHost-Apps/zeronet_ynh"
-antifeatures = ["deprecated-software"]
 
 [zerotier]
 antifeatures = [ "not-totally-free-upstream", "non-free-network" ]

tools/readme_generator/tests/README.md

@@ -0,0 +1,60 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
+It shall NOT be edited by hand.
+-->
+
+# GoToSocial for YunoHost
+
+[![Integration level](https://dash.yunohost.org/integration/gotosocial.svg)](https://dash.yunohost.org/appci/app/gotosocial) ![Working status](https://ci-apps.yunohost.org/ci/badges/gotosocial.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/gotosocial.maintain.svg)
+
+[![Install GoToSocial with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gotosocial)
+
+*[Lire ce readme en français.](./README_fr.md)*
+
+> *This package allows you to install GoToSocial quickly and simply on a YunoHost server.
+If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
+
+## Overview
+
+GoToSocial is a fast [ActivityPub](https://activitypub.rocks/) social network server, written in Golang.
+
+With GoToSocial, you can keep in touch with your friends, post, read, and share images and articles. All without being tracked or advertised to!
+
+The official documentation is at [docs.gotosocial.org](https://docs.gotosocial.org).  
+The documentation for this YunoHost package [can be read here](./doc/DOCS.md) and the admin is **strongly encouraged to read it**!
+
+Please note that this package uses the ["i'm so tired" software license 1.0](https://github.com/YunoHost-Apps/gotosocial_ynh/blob/master/LICENSE), please read it and accept it before proceeding with installation.
+
+**Shipped version:** 0.13.3~ynh1
+
+## Screenshots
+
+![Screenshot of GoToSocial](./doc/screenshots/screenshot.png)
+
+## :red_circle: Antifeatures
+
+- **Alpha software**: Early development stage. May contain changing or unstable features, bugs, and security vulnerability.
+- **Not totally free package**: The YunoHost package of this app is under an overall free licence, but with clauses that restrict its use.
+
+## Documentation and resources
+
+- Official app website: <https://gotosocial.org/>
+- Official user documentation: <https://docs.gotosocial.org/en/latest/>
+- Official admin documentation: <https://docs.gotosocial.org/en/latest/>
+- Upstream app code repository: <https://github.com/superseriousbusiness/gotosocial>
+- YunoHost Store: <https://apps.yunohost.org/app/gotosocial>
+- Report a bug: <https://github.com/YunoHost-Apps/gotosocial_ynh/issues>
+
+## Developer info
+
+Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing).
+
+To try the testing branch, please proceed like that.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
+or
+sudo yunohost app upgrade gotosocial -u https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
+```
+
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

tools/readme_generator/tests/README_fr.md

@@ -0,0 +1,60 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
+It shall NOT be edited by hand.
+-->
+
+# GoToSocial pour YunoHost
+
+[![Niveau d’intégration](https://dash.yunohost.org/integration/gotosocial.svg)](https://dash.yunohost.org/appci/app/gotosocial) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/gotosocial.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/gotosocial.maintain.svg)
+
+[![Installer GoToSocial avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=gotosocial)
+
+*[Read this readme in english.](./README.md)*
+
+> *Ce package vous permet d’installer GoToSocial rapidement et simplement sur un serveur YunoHost.
+Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
+
+## Vue d’ensemble
+
+Un serveur de réseau social véloce basé sur [ActivityPub](https://activitypub.rocks/) écrit en Golang.
+
+Avec GoToSocial, vous pouvez rester en contact avec vos amis, publier, lire et partager des images et des articles. Tout cela sans être pisté ni subir de publicité !
+
+Vous pouvez consulter la documentation officielle à l'adresse : [docs.gotosocial.org](https://docs.gotosocial.org).  
+La documentation de ce paquet YunoHost [est lisible ici](./doc/DOCS_fr.md) et l'admin est **vivement encouragé-e à la lire** !
+
+Veuillez noter que ce paquet utilise la ["i'm so tired" software license 1.0](https://github.com/YunoHost-Apps/gotosocial_ynh/blob/master/LICENSE), veuillez la lire et l'accepter avant de procéder à l'installation.
+
+**Version incluse :** 0.13.3~ynh1
+
+## Captures d’écran
+
+![Capture d’écran de GoToSocial](./doc/screenshots/screenshot.png)
+
+## :red_circle: Anti-fonctionnalités
+
+- **Logiciel en version alpha** : Le logiciel est au tout début de son développement. Il pourrait contenir des fonctionnalités changeantes ou instables, des bugs, et des failles de sécurité.
+- **Package sous licence libre restreinte** : Le package YunoHost de cette application est sous une licence globalement libre, mais avec des clauses qui pourraient restreindre son utilisation.
+
+## Documentations et ressources
+
+- Site officiel de l’app : <https://gotosocial.org/>
+- Documentation officielle utilisateur : <https://docs.gotosocial.org/en/latest/>
+- Documentation officielle de l’admin : <https://docs.gotosocial.org/en/latest/>
+- Dépôt de code officiel de l’app : <https://github.com/superseriousbusiness/gotosocial>
+- YunoHost Store : <https://apps.yunohost.org/app/gotosocial>
+- Signaler un bug : <https://github.com/YunoHost-Apps/gotosocial_ynh/issues>
+
+## Informations pour les développeurs
+
+Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing).
+
+Pour essayer la branche testing, procédez comme suit.
+
+``` bash
+sudo yunohost app install https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
+ou
+sudo yunohost app upgrade gotosocial -u https://github.com/YunoHost-Apps/gotosocial_ynh/tree/testing --debug
+```
+
+**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>

tools/readme_generator/tests/tests_make_readme.py

@@ -0,0 +1,22 @@
+import os
+import subprocess
+
+CWD = os.path.split(os.path.realpath(__file__))[0]
+COMMIT_ID = "8f788213b363a46a5b6faa8f844d86d4adac9446"
+DIRECTORY = CWD + "/gotosocial_ynh"
+
+
+def test_running_make_readme():
+    subprocess.check_call(["rm", "-rf", DIRECTORY])
+    subprocess.check_call(["git", "clone", "https://github.com/yunohost-apps/gotosocial_ynh", DIRECTORY, "-q"])
+    subprocess.check_call(["git", "checkout", COMMIT_ID, "-q"], cwd=DIRECTORY)
+
+    print(CWD)
+    subprocess.check_call([CWD + "/../make_readme.py", DIRECTORY])
+
+    assert open(CWD + "/README.md").read() == open(DIRECTORY + "/README.md").read()
+    assert open(CWD + "/README_fr.md").read() == open(DIRECTORY + "/README_fr.md").read()
+
+
+if __name__ == '__main__':
+    test_running_make_readme()

wishlist.toml

@@ -1711,12 +1711,6 @@ upstream = ""
 website = "https://umap.openstreetmap.fr/"
 draft = "https://github.com/YunoHost-Apps/umap_ynh"
 
-[univer]
-name = "Univer"
-description = "Replacement of Luckysheet (deprecated, in yunohost packages)"
-upstream = "https://github.com/dream-num/univer"
-website = "https://univer.ai/"
-
 [upmpdcli]
 name = "upmpdcli"
 description = ""