Uploader une vue
Uploader une vue
La commande views up permet d’uploader une vue de manière interactive.
Elle est destinée aux équipes qui souhaitent publier ou mettre à jour une vue afin de la rendre disponible dans le registre des vues OIP.
Utilisation
Fonctionnement général
La commande fonctionne en mode interactif.
Elle guide l’utilisateur à travers plusieurs prompts afin de collecter les informations nécessaires à la publication de la vue.
Les informations demandées peuvent notamment concerner :
- le nom de la vue ;
- l’identifiant de la vue ;
- la description de la vue ;
- les tags associés ;
- le nom alternatif du module oip-core, si nécessaire.
Processus d’upload
Lors de l’upload, OIP Tools analyse la vue et prépare les éléments nécessaires à sa publication.
Le processus peut notamment inclure les étapes suivantes :
- analyse des imports utilisés par la vue ;
- analyse des dépendances locales et externes ;
- identification des entités utilisées ;
- identification des propriétés utilisées ;
- identification des enums utilisées ;
- identification des features utilisées ;
- génération du fichier manifest.yml ;
- assemblage de l’archive de la vue ;
- soumission de l’archive à l’API.
Prérequis projet
Avant d’exécuter la commande, le projet doit contenir les éléments nécessaires à l’analyse et à la publication de la vue.
Les éléments attendus sont notamment :
Résultat de la commande
Une fois le traitement terminé, la commande soumet la vue à l’API.
Selon le fonctionnement du registre, elle peut retourner une confirmation, une Pull Request ou une URL permettant de suivre la publication.
Exemple
La commande démarre alors le processus interactif d’upload de la vue.
Remarques
La commande nécessite un accès réseau à l’OIP API.
Les variables d’environnement nécessaires à l’authentification doivent être correctement renseignées, notamment OIP_TOOLS_CLIENT_SECRET.
Avant d’uploader une vue, il est recommandé de vérifier :
- la cohérence de la configuration de la vue ;
- la présence des fichiers nécessaires ;
- les dépendances déclarées dans le projet ;
- les features utilisées par la vue ;
- les entités, propriétés et enums réellement exploitées.