From d158213ffe34b2954d5a1d27d122fc4d588d4a1e Mon Sep 17 00:00:00 2001 From: Nicolas Perriault Date: Tue, 3 Sep 2024 17:11:45 +0200 Subject: [PATCH] feat: add a few sample docs. --- tech-docs/book.toml | 2 +- tech-docs/src/README.md | 1 + tech-docs/src/SUMMARY.md | 3 ++- tech-docs/src/chapter_1.md | 3 --- .../src/format-de-donn\303\251es-lca-acv.md" | 1 + tech-docs/src/gestion-des-tests.md | 25 +++++++++++++++++++ 6 files changed, 30 insertions(+), 5 deletions(-) create mode 120000 tech-docs/src/README.md delete mode 100644 tech-docs/src/chapter_1.md create mode 100644 "tech-docs/src/format-de-donn\303\251es-lca-acv.md" create mode 100644 tech-docs/src/gestion-des-tests.md diff --git a/tech-docs/book.toml b/tech-docs/book.toml index 75e3975a51..6ec2178ba7 100644 --- a/tech-docs/book.toml +++ b/tech-docs/book.toml @@ -1,6 +1,6 @@ [book] authors = ["Nicolas Perriault"] -language = "en" +language = "fr" multilingual = false src = "src" title = "Ecobalyse - Documentation technique" diff --git a/tech-docs/src/README.md b/tech-docs/src/README.md new file mode 120000 index 0000000000..fe84005413 --- /dev/null +++ b/tech-docs/src/README.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file diff --git a/tech-docs/src/SUMMARY.md b/tech-docs/src/SUMMARY.md index 7390c82896..d868224efd 100644 --- a/tech-docs/src/SUMMARY.md +++ b/tech-docs/src/SUMMARY.md @@ -1,3 +1,4 @@ # Summary -- [Chapter 1](./chapter_1.md) +- [README](./README.md) +- [Gestion des tests](./gestion-des-tests.md) diff --git a/tech-docs/src/chapter_1.md b/tech-docs/src/chapter_1.md deleted file mode 100644 index 8a25757ad7..0000000000 --- a/tech-docs/src/chapter_1.md +++ /dev/null @@ -1,3 +0,0 @@ -# Ecobalyse — Documentation technique - -This is a test, don't panic. diff --git "a/tech-docs/src/format-de-donn\303\251es-lca-acv.md" "b/tech-docs/src/format-de-donn\303\251es-lca-acv.md" new file mode 100644 index 0000000000..3a572eab80 --- /dev/null +++ "b/tech-docs/src/format-de-donn\303\251es-lca-acv.md" @@ -0,0 +1 @@ +# Format de données LCA ACV diff --git a/tech-docs/src/gestion-des-tests.md b/tech-docs/src/gestion-des-tests.md new file mode 100644 index 0000000000..02274b9d4d --- /dev/null +++ b/tech-docs/src/gestion-des-tests.md @@ -0,0 +1,25 @@ + +> 💡 **Prérequis** +> +> Pour exécuter et régler les problèmes de tests en échec suite à la mise à jour d’impacts, il convient de disposer d’une installation locale du projet. Les instructions d’installation et de configuration sont décrites [dans le README sur le dépôt.](https://github.com/MTES-MCT/ecobalyse/blob/master/README.md) + + + +**Si suite à une mise à jour des impacts ou des coefficients de complément les tests échouent, voici la méthode pour régler la situation :** + +- Depuis votre branche à jour en local et depuis un terminal, lancez `npm test` +- Vérifiez dans les rapports de tests si les échecs ou différences relevés sont attendus ou non +- Si les échecs **ne sont pas attendus**, réglez le problème et soumettez les modifications sur la branche afin que les tests passent à nouveau +- Si les échecs **sont attendus** — par exemple lorsque vous mettez à jour des impacts ou des compléments — et que vous vous souhaitez mettre à jour les tests afin de prendre en compte les nouvelles valeurs obtenues : + - Pour les tests unitaires, mettez à jour les valeurs en échecs directement dans les tests Elm (`tests/**/*Test.elm`) + - Pour les tests e2e (serveur), il faudra copier le ou les fichiers suivants, générés automatiquement à chaque lancement de la suite de tests via `npm test`: + - Pour le textile : `cp tests/e2e-textile-output.json tests/e2e-textile.json` + - Pour l’alimentaire : `cp tests/e2e-food-output.json tests/e2e-food.json` + - Une fois que les tests passent tous à nouveau, vous pouvez commiter et pousser les changements sur votre branche distante, le build de votre pull-request devrait revenir au vert et être déployé automatiquement en recette.💡C’est toujours une bonne idée d’aller sur la recette Web vérifier que tout fonctionne comme prévu. + + +> 💡 **Cas particulier de la détection d’évolutions inhabituelles d’impacts** +> +> Si vous obtenez des échecs sur les tests de type `Food ingredients ecoscore deviation`, il vous faut également vérifier si ces écarts sont attendus ou non. +> +> S’ils sont attendus, il vous faut commenter le test en question, merger votre branche dans master, puis pousser un commit sur master qui décommente le test à nouveau afin que le contrôle puisse être effectué sur les branches et pull-requests créées par la suite.