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.
@@ -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

@@ -502,13 +502,6 @@ state = "working"
 subtags = [ "wiki" ]
 url = "https://github.com/YunoHost-Apps/cowyo_ynh"
 
-[crabfit]
-category = "productivity_and_management"
-potential_alternative_to = [ "Doodle", "OpenSondage" ]
-state = "working"
-subtags = [ "poll" ]
-url = "https://github.com/YunoHost-Apps/crabfit_ynh"
-
 [cryptpad]
 category = "office"
 level = 8

store/translations/es/LC_MESSAGES/messages.po

@@ -8,21 +8,19 @@ msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
 "POT-Creation-Date: 2024-03-05 19:36+0100\n"
-"PO-Revision-Date: 2024-03-09 17:32+0000\n"
-"Last-Translator: cri <cri@cri.cl>\n"
-"Language-Team: Spanish <https://translate.yunohost.org/projects/yunohost/"
-"apps/es/>\n"
+"PO-Revision-Date: 2024-02-21 06:05+0100\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: es <LL@li.org>\n"
 "Language: es\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=2; plural=n != 1;\n"
-"X-Generator: Weblate 5.3.1\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
 "Generated-By: Babel 2.14.0\n"
 
 #: app.py:150
 msgid "App %(app_id) not found"
-msgstr "App %(app_id) no encontrada"
+msgstr ""
 
 #: app.py:152
 msgid "You must be logged in to be able to star an app"

store/translations/fr/LC_MESSAGES/messages.po

@@ -8,16 +8,15 @@ msgstr ""
 "Project-Id-Version: PROJECT VERSION\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
 "POT-Creation-Date: 2024-03-05 19:36+0100\n"
-"PO-Revision-Date: 2024-03-09 04:14+0000\n"
+"PO-Revision-Date: 2024-02-27 19:19+0000\n"
 "Last-Translator: OniriCorpe <oniricorpe@disroot.org>\n"
-"Language-Team: French <https://translate.yunohost.org/projects/yunohost/apps/"
-"fr/>\n"
 "Language: fr\n"
+"Language-Team: French "
+"<https://translate.yunohost.org/projects/yunohost/apps/fr/>\n"
+"Plural-Forms: nplurals=2; plural=n > 1;\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Plural-Forms: nplurals=2; plural=n > 1;\n"
-"X-Generator: Weblate 5.3.1\n"
 "Generated-By: Babel 2.14.0\n"
 
 #: app.py:150
@@ -255,7 +254,7 @@ msgstr "Documentation officielle pour les admins"
 
 #: templates/app.html:142
 msgid "Official user documentation"
-msgstr "Documentation officielle d'utilisation"
+msgstr "Documentation officielle pour les utilisateur·ice·s"
 
 #: templates/app.html:143
 msgid "Official code repository"
@@ -395,8 +394,8 @@ msgid ""
 "advise against their installation and advise users to find alternatives."
 msgstr ""
 "Cela signifie que le développeur ne les mettra plus à jour. Nous "
-"décourageons fortement leur installation et vous conseillons de vous tourner "
-"vers des alternatives."
+"décourageons fortement leur installation et conseillons aux utilisateurs "
+"de se tourner vers des alternatives."
 
 #: templates/index.html:10
 msgid "Application Store"
@@ -461,8 +460,8 @@ msgstr "Vous devez être connecté·e pour proposer une app pour la liste de sou
 #: templates/wishlist_add.html:40
 msgid "Due to abuses, only one proposal every 15 days per user is allowed."
 msgstr ""
-"En raison d'abus, la proposition d'app est limitée à une tous les 15 jours "
-"par personne."
+"En raison d'abus, la proposition d'app est limitée à une tous les 15 "
+"jours par utilisateur·ice."
 
 #: templates/wishlist_add.html:43
 msgid ""
@@ -528,3 +527,4 @@ msgstr "Envoyer"
 
 #~ msgid "Please check the license of the app your are proposing"
 #~ msgstr "Merci de vérifier la licence de l'app que vous proposez"
+

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()