[TECH] Documenter les colonnes de notre base de données

[VincentHardouin]

🦄 Problème

Actuellement, la documentation est faite manuellement dans Confluence. C'est loin du code, ce qui fait personne y pense et c'est par conséquent pas à jour. De plus, notre data catalog n'en bénéficie pas ainsi que les personnes réutilisant la base de code.

🤖 Proposition

Ajouter les commentaires directement sur les colonnes.

La migration a été généré avec un script qui est dans le premier commit et supprimé dans le troisième car c'est un one-shot. Il est ajouté et supprimé uniquement pour le retrouver dans l'historique. Si vous êtes curieux ou curieuse de voir de l'AST, n'hésitez pas.

🌈 Remarques

Pour info les commentaires sont disponibles sur pgcli par exemple en faisant \d+ <nom_de_table>

A venir (prochain point tech par exemple): il faut créer une règle Eslint pour forcer les développeurs à commenter les colonnes à chaque nouvelle migration

💯 Pour tester

• Se connecter à la RA avec la CLI Scalingo en lancant un pgsql-console :

scalingo --region osc-fr1 -a pix-api-review-pr9457 pgsql-console

• Constater que les commentaires sont biens présents avec \d+ <nom_de_table>

• Tester la migration down en utilisant la CLI avec run npm run db:rollback:latest

scalingo --region osc-fr1 -a pix-api-review-pr9457 run npm run db:rollback:latest

• Constater que les commentaires ont disparu
• Remettre dans le bon état pour les copains run npm db:migrate

scalingo --region osc-fr1 -a pix-api-review-pr9457 run npm run db:migrate

[pix-bot-github]

Une fois les applications déployées, elles seront accessibles via les liens suivants :

• App (.fr)
• App (.org)
• Orga (.fr)
• Orga (.org)
• Certif (.fr)
• Certif (.org)
• Junior
• Admin
• API
• Audit Logger

Les variables d'environnement seront accessibles via les liens suivants :

• scalingo front
• scalingo api
• scalingo audit-logger