Partager via


Empaqueter et publier des extensions

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Une fois que vous avez développé votre extension, vous pouvez empaqueter et la publier sur Visual Studio Marketplace. Le Marketplace est un référentiel mondial pour les extensions privées et publiques, les intégrations et autres offres de Microsoft.

Note

Pour en savoir plus sur les propriétés de découverte disponibles dans le fichier manifeste de votre extension qui aident les utilisateurs à découvrir et à en savoir plus sur votre extension, consultez la section Référence du manifeste d’extension.

Prerequisites

La liste suivante d’exigences doit être respectée avant de publier sur le Marketplace.

Catégorie Spécifications
Outil d’empaquetage Installez l’outil d’empaquetage d’extension (TFX). Exécutez npm install -g tfx-cli à partir d’une invite de commandes.
Autorisations d’image Vérifiez que vous disposez des autorisations appropriées pour utiliser toutes les images, telles que les icônes, les logos, les captures d’écran, et ainsi de suite.
Vue d’ensemble du marché Incluez un fichier complet overview.md pour décrire votre annonce sur la Marketplace.
Icône d’extension Incluez une icône pour votre extension qui représente votre intégration, votre entreprise ou votre organisation, au moins 128 x 128 pixels de taille (PNG ou JPEG).
Noms de produits Microsoft Utilisez des noms complets pour les produits Microsoft (par exemple, Azure DevOps au lieu d’AzDO ou d’autres abréviations).
Noms de marques N’utilisez pas de noms de marque dans le nom de votre extension.

Créer un serveur de publication

Chaque extension ou intégration, y compris celles de Microsoft, doit avoir un éditeur. Tout le monde peut créer un éditeur et publier des extensions sous celui-ci. Vous pouvez également partager l’accès aux éditeurs avec d’autres utilisateurs, tels que votre équipe de développement.

  1. Connectez-vous au Portail de publication de la Visual Studio Marketplace.

  2. Si vous ne faites pas partie d’un éditeur existant, sélectionnez + Créer un éditeur.
    Entrez un nom d’éditeur ; le champ ID se remplit automatiquement en fonction de votre entrée.

    Capture d’écran du bouton en surbrillance, Créer un éditeur.

    Note

    • Vérifiez que le nom de votre serveur de publication est compris entre 16 caractères pour les caractères multioctets.
    • Enregistrez l’ID de l’éditeur. Vous en avez besoin dans le fichier manifeste de votre extension.

    Si vous n’êtes pas invité à créer un éditeur, faites défiler jusqu’à Publier des extensions sous sites connexes.

    • Définissez un identificateur d’éditeur unique, tel que mycompany-myteam. Utilisez cette valeur pour l’attribut publisher dans votre manifeste.
    • Définissez un nom d'affichage, tel que My Team.
  3. Passez en revue le Contrat d’éditeur de la Place de marché, puis sélectionnez Créer.

    Créer un éditeur pour l’extension

Après avoir créé l’éditeur, vous pouvez gérer les éléments, bien qu’aucun élément n’apparaisse tant que vous n’avez pas publié.

Empaqueter votre extension

Pour charger votre extension, empaquetez-la en tant que fichier .vsix compatible VSIX 2.0. Microsoft fournit une interface de ligne de commande multiplateforme (CLI) pour emballer et publier votre extension.

  1. Ouvrez votre fichier de manifeste d’extension (vss-extension.json) et définissez la valeur du champ publisher sur l’ID de votre éditeur. Par exemple :

    {
        ...
        "id": "my-first-extension",
        "publisher": "AnnetteNielsen",
        ...
    }
    
  2. À partir d’un prompt de commande, exécutez la commande de packaging de l’outil TFX à partir de votre répertoire d’extension.

    npx tfx-cli extension create
    

    Un message s’affiche pour indiquer que votre extension a été correctement emballée :

    === Completed operation: create extension ===
    - VSIX: C:\my-first-extension\AnnetteNielsen.my-first-extension-1.0.0.vsix
    - Extension ID: my-first-extension
    - Extension Version: 1.0.0
    - Publisher: AnnetteNielsen
    

Note

Incrémentez la version de votre extension ou intégration dans le manifeste avec chaque mise à jour.
Utilisez le commutateur de ligne de commande --rev-version. Ce commutateur incrémente le numéro de version du patch de votre extension et enregistre la nouvelle version dans votre manifeste.

Vérifier la taille du package

Vérifiez la taille du vsix une fois qu’il est emballé. S’il est supérieur à 50 Mo, vous devrez l’optimiser. Pour ce faire, veuillez tenir compte des considérations suivantes :

  • Dédupliquer les dépendances courantes en les indiquant une fois dans le package d’extension.
  • Récupérez les dépendances au moment de l’exécution ou pendant l’installation plutôt que de les inclure dans le package. Envisagez d’utiliser la bibliothèque du programme d’installation d’outils pour extraire les dépendances des outils au moment de l’exécution. Cette approche met en cache l’outil par version pour les agents privés, empêchant les téléchargements pour chaque build. La bibliothèque d’installation d’outils ne fonctionne pas dans les scénarios déconnectés (pas Internet), qui doivent être mentionnés dans la description ou la documentation de la tâche.
  • Utilisez WebPack pour arborer les dépendances des shakes dans les tâches.

Publier votre extension

Une fois votre extension emballée, vous pouvez la charger sur la Marketplace sous un éditeur. L’publisheridentifiant spécifié dans le fichier manifeste de votre extension doit correspondre à l’identifiant de l’éditeur sous lequel l’extension est chargée.

  1. Dans le portail de gestion, sélectionnez votre éditeur dans le menu déroulant en haut de la page.

  2. Sélectionnez Nouvelle extension>Azure DevOps.

    Capture d’écran du menu déroulant Nouvelle extension avec la sélection Azure DevOps mise en évidence.

  3. Glissez-déposez votre fichier ou sélectionnez-le pour trouver votre fichier VSIX, que vous avez créé lors de l’étape d’emballage précédente, puis choisissez Charger.

    Capture d’écran de Charger la nouvelle extension pour Azure DevOps.

    Après une validation rapide, votre extension apparaît dans la liste des extensions publiées. Ne vous inquiétez pas, l’extension n’est visible que par vous.

    Capture d’écran de l’extension dans la liste des extensions publiées.

À ce stade, votre extension n’est visible pour aucun compte. Pour le rendre visible pour d’autres personnes, vous devez partager l’extension.

Note

Microsoft effectue une analyse antivirus sur chaque nouveau package d’extension et chaque mise à jour publiés. Tant que l’analyse n’est pas terminée, nous ne publions pas l’extension sur la Marketplace pour une utilisation publique. De cette manière, nous évitons également que des contenus inappropriés ou offensants apparaissent sur les pages de la Marketplace.

Partager votre extension

Partagez votre extension avec une organisation avant de pouvoir l’installer dans Azure DevOps. Pour partager une extension, procédez comme suit :

  1. Dans le Portail de gestion de la Marketplace, sélectionnez votre extension dans la liste, effectuez un clic droit, puis choisissez Partager/Annuler le partage or Publier/Annuler la publication, selon l’extension.

    Capture d’écran de la sélection du menu, Partager/Annuler le partage.

  2. Sélectionnez Organisation, puis saisissez le nom de votre organisation. Ensuite, sélectionnez Entrée.

    Capture d’écran du bouton Entrée.

  3. Fermez le volet.

Votre extension peut désormais être installée dans cette organisation.

Installez votre extension

Procédez comme suit pour installer votre extension partagée.

  1. Dans la Marketplace, sélectionnez votre extension pour ouvrir sa page Vue d’ensemble.

    Capture d’écran de la page de présentation.

    Note

    Étant donné que votre extension est privée, seul vous et les membres de l’organisation qu’il a partagés peuvent voir cette page.

  2. Sélectionnez Obtenir gratuitement pour lancer le processus d’installation. Sélectionnez l’organisation avec laquelle vous avez partagé l’extension dans le menu déroulant.

    Capture d’écran de la boîte de dialogue d’installation de l’extension.

  3. Cliquez sur Installer.

Félicitations ! Vous avez installé votre extension dans une organisation et vous êtes prêt à l’essayer.

Essayez votre extension

  1. Sélectionnez Passer à l’organisation à la fin de l’Assistant Installation pour accéder à la page d’accueil de l’organisation sur laquelle l’extension a été installée (https://dev.azure.com/{organization}).

  2. Actualisez votre navigateur.

  3. Ouvrez Paramètres de l’organisation, puis sélectionnez Extensions.

    Capture d’écran de Paramètres de l’organisation, page Extensions.

Vous devriez voir la nouvelle extension sous l’onglet Installé .

Déboguer votre extension

Pour déboguer l’extension à l’aide de Visual Studio ou Outils de développement du navigateur, modifiez le fichier manifeste en ajoutant la propriété baseUri. Cette action accélère le développement sans avoir à redéployer l’extension à chaque modification du code source.

{
    ...
    "baseUri": "https://localhost:44300",
    ...
}

Lorsque vous modifiez le manifeste, l’extension est chargée à partir de votre instance de serveur Web local. Par exemple, IISExpress dans Visual Studio. Après avoir modifié le manifeste, déployez et installez cette extension de débogage une seule fois.

Note

Exécutez votre serveur Web local en mode SSL, car Azure DevOps exige que la page Web soit fournie à partir d’une source sécurisée. Sinon, vous obtenez une erreur dans la console du navigateur lors du chargement de l'extension IFRAME.

Mettre à jour votre extension

Pour mettre à jour une extension que vous avez déjà publiée, procédez comme suit :

Conseil

Mettez à jour votre extension au lieu de la supprimer et de la recharger. Nous vous recommandons de conserver deux extensions : publisher.extension, public sur la Place de marché pour les clients et publisher.extension-dev, privé, partagé uniquement avec votre organisation pour le développement et le test. Vous n’avez pas besoin de deux copies de votre code source : conservez simplement des fichiers manifeste distincts pour chaque extension. Lors de l’empaquetage, fournissez le fichier manifeste approprié à l’outil tfx-cli. Pour plus d’informations, consultez commandes d’extension TFX.

  1. Sélectionnez votre extension dans la liste des éléments affichés.
  2. Cliquez avec le bouton droit et sélectionnez Mettre à jour pour la version de développement, telle que publisher.extension-dev.
  3. Validez votre extension.
  4. Appliquez les mêmes mises à jour à la version de production, telles que publisher.extension.
  5. Accédez au fichier .vsix pour votre extension et chargez-la.

Azure DevOps installe automatiquement la version mise à jour pour tous les comptes qui ont déjà l’extension. De nouvelles installations reçoivent également la dernière version.

Rendez votre extension publique

Pendant que vous développez votre extension ou votre intégration pour la Marketplace, gardez-la privée. Cela limite la visibilité de l’extension à des comptes spécifiques que vous avez partagés.

Pour rendre votre extension publique, définissez l’indicateur public sur true dans votre manifeste.

Qualifications professionnelles

Pour être référencé sur la Marketplace, votre intégration ou extension doit répondre aux critères suivants :

  • Fonctionne avec ou étend Azure DevOps.
  • Vous, ou votre entreprise, êtes propriétaire, développeur et titulaire d’une licence pour distribuer et promouvoir l’intégration ou l’extension.
  • L’extension ou l’intégration fait l’objet d’une maintenance active.

Microsoft peut également demander une démonstration et examiner le contenu prévu pour votre entrée sur la Marketplace.

Éditeur de premier plan

Le programme Top Publisher est uniquement disponible pour les éditeurs disposant d’extensions ou d’intégrations Azure DevOps. Cela ne s’applique pas aux éditeurs d’IDE Visual Studio et d’extensions Visual Studio Code.

Capture d’écran du badge Top Publisher.

Le programme Top Publisher récompense les éditeurs qui s’engagent envers leurs clients et la Marketplace par le biais de politiques, d’une qualité, d’une fiabilité et d’un support exemplaires. Une fois que vous devenez un Top Publisher, toutes vos offres publiques affichent le badge Top Publisher.

Conditions requises pour devenir Top Publisher

Le programme Top Publisher du Marketplace est conçu pour vous aider à évaluer ou à acquérir en toute confiance des extensions et des intégrations Azure DevOps. Le badge « Top Publisher » signifie que l’éditeur fait preuve d’un engagement envers ses clients et la Marketplace grâce à des politiques, une qualité, une fiabilité et un support exemplaires. Il s’adresse aux éditeurs disposant d’une ou plusieurs extensions ou intégrations Azure DevOps mondiales et ne s’applique pas aux éditeurs d’extensions Visual Studio IDE et Visual Studio Code.

Marketplace attribue le badge à un éditeur après avoir soigneusement examiné celui-ci selon les paramètres suivants :

  • Politique de confidentialité
  • Stratégie de licence
  • Politique de support
  • Documentation
  • Réactivité des Q&A
  • Évaluations et avis pour leurs offres
  • L'adoption active et l'installation comptent pour leurs offres
  • Gestion d’au moins une extension publique pour Azure DevOps
  • Extension publique avec plus de 5 000 installations et un nombre d’installations actif dépassant 1 000

Vous pouvez compter sur une assistance rapide et une expérience globale satisfaisante lorsque vous obtenez une extension auprès d’un éditeur de premier plan. Découvrez les offres des Top Publishers.

Pour en savoir plus sur l’ajout de stratégies à votre offre, consultez le manifeste d’extension.

  1. Mettez à jour votre profil d’éditeur.

    Grâce au profil d’éditeur, vous pouvez présenter toutes vos offres dans un seul et même emplacement, accompagnées des informations clés relatives à votre activité. Pour fournir les informations qui apparaissent dans le profil, procédez comme suit :

    a) Connectez-vous à https://marketplace.visualstudio.com/manage/publishers l’aide du compte via lequel vous publiez et gérez vos offres dans Visual Studio Marketplace.

    b. Sélectionnez l’éditeur et finalisez la section À propos de vous dans l’onglet Détails. Capture d’écran de la section À propos de vous pour les éditeurs Microsoft. c. Enregistrez vos modifications et sélectionnez Afficher le profil pour voir comment celui-ci apparaît aux consommateurs. Vous pouvez utiliser cette page de profil pour évangéliser vos offres.

Note

Ce programme certifiera l’éditeur, et non le logiciel, ni la sécurité de ses extensions et intégrations. Nous vous recommandons d’examiner les informations de sécurité lors de l’évaluation des offres d’un éditeur. Si vous avez obtenu une prolongation auprès d’un éditeur Top Publisher et que vous n’êtes pas satisfait de votre expérience, pensez d’abord à contacter l’éditeur.

Postuler pour devenir un Top Publisher

  1. Connectez-vous au portail de gestion de la Place de marché à l’aide du compte avec lequel vous publiez et gérez vos offres dans la Place de marché.
  2. Sélectionnez l’éditeur et accédez à son onglet Éditeur supérieur . Disposez d’une ou de plusieurs extensions ou intégrations Azure DevOps (Server/Service) globales pour que l’onglet apparaisse.
  3. Si vous répondez aux exigences répertoriées précédemment et êtes le propriétaire de l’éditeur, vous pouvez demander le programme. Lors de l’application, un e-mail est envoyé à l’équipe de la Place de marché pour examiner votre cas. Ils répondent dans les 10 jours ouvrables avec les étapes suivantes, la clarification des questions ou l’octroi du badge.

L’équipe prend probablement en compte d’autres paramètres, tels que l’adoption active de vos offres, le nombre d’installations/démarrages et les évaluations et les avis de vos offres avant de décerner le badge. Microsoft se réserve le droit d’accorder, rejeter ou révoquer le badge Top Publisher à tout moment.

Une fois qu’un éditeur devient un éditeur de premier plan, toutes ses futures mises à jour et offres doivent répondre aux exigences répertoriées précédemment.

Répondre aux avis d’extension de la Marketplace

Vous pouvez répondre aux avis laissés par les clients concernant vos extensions dans le Visual Studio Marketplace. Recherchez et sélectionnez Répondre en regard d’un avis si vous disposez de l’une des autorisations suivantes : propriétaire, créateur ou contributeur.

Vous ne pouvez laisser qu’une réponse. Évitez d’utiliser les avis comme forum d’assistance. Si vous avez besoin de plus amples informations, veuillez fournir un alias d’assistance afin que le réviseur puisse vous contacter. Vous pouvez alors résoudre leurs problèmes en externe et mettre à jour votre réponse avec une résolution.

Instructions concernant les réponses de l’éditeur

Faites en sorte que Visual Studio Marketplace reste un espace ouvert, accueillant, respectueux et utile où les clients peuvent trouver, essayer, installer et évaluer des extensions. La communication joue un rôle important pour maintenir une communauté bienveillante. Pour vous aider à créer cet environnement, voici quelques lignes directrices à l’intention des éditeurs qui répondent aux avis clients. Réfléchissez profondément à vos interactions avec les clients et réfléchissez à l’esprit de l’expérience client que la Marketplace tente de créer.

  • Réservez les évaluations aux commentaires des clients. Utilisez Répondre uniquement pour répondre à un avis.
  • Respectez toutes les opinions des clients. Traitez les commentaires comme des commentaires sans débat, critique ou argument.
  • Vérifiez que vos réponses ajoutent de la valeur et sont pertinentes pour les commentaires de vos clients.
  • Concentrez-vous sur la réponse précise aux questions ou aux problèmes. Si vous avez besoin de plus de détails, demandez au client de vous contacter par e-mail plutôt que de discuter dans les avis. Une fois le problème résolu, mettez à jour votre réponse en indiquant la solution. Vous pouvez modifier votre réponse comme les clients peuvent modifier leurs avis.
  • Signalez toutes les critiques inappropriées, telles que le spam, le contenu abusif ou offensant, pour que nous les examinions.

Demander l’annulation d’un avis

En tant qu’éditeur, vous pouvez faire appel pour annuler un avis si le problème signalé est lié à la Marketplace ou à la plateforme sous-jacente. Si le problème est valide, les administrateurs de la Marketplace annulent la note. Vous pouvez faire appel à la section des évaluations et des commentaires sur la page hub de votre extension.

Annuler la publication d’une extension

Vous pouvez annuler la publication d’extensions gratuites si vous ne souhaitez plus les proposer dans la Place de marché.

Envisagez de supprimer votre extension de la Place de marché dans les scénarios suivants :

  • Vous avez développé une nouvelle extension et ne souhaitez plus offrir la nouvelle extension actuelle.
  • Votre extension a un problème et vous souhaitez la supprimer de la Place de marché jusqu’à ce que vous résolvez le problème.
  • Vous avez publié votre extension en mode public par erreur.

Certaines conditions doivent être remplies pour qu’une prolongation soit supprimée ou ne soit pas publiée :

Action Spécifications
Dépublier Il est uniquement possible d’annuler la publication des extensions gratuites.
Supprimer Votre extension doit avoir zéro (0) installation pour être supprimée.

Importante

Si vous devez supprimer votre extension en raison de problèmes juridiques ou de sécurité, contactez le support technique de la Communauté des développeurs. Nous examinerons votre demande et supprimerons manuellement l’extension.

  1. Sélectionnez l’extension sur votre page d’éditeur et choisissez Annuler la publication dans le menu.

    La publication de votre extension sera immédiatement annulée à partir de la Marketplace et les nouveaux utilisateurs ne pourront pas l’installer. Les évaluations et les commentaires concernant votre extension restent intacts.

Pour proposer à nouveau votre extension dans la Place de marché, sélectionnez Publier dans le menu.

Si votre extension a zéro installation, vous pouvez choisir de la supprimer complètement de la Place de marché. Pour ce faire, sélectionnez Supprimer dans le menu. Vous ne pouvez pas inverser cette action.

Hub de création de rapports d’extension

Une fois votre extension disponible dans Visual Studio Marketplace, vous pouvez utiliser la fonctionnalité Rapports . Avec cette fonctionnalité, vous pouvez suivre et analyser l’exécution de l’extension et effectuer des actions requises. Pour visiter le hub d’extension, accédez à votre page d’éditeur et sélectionnez l’extension ou sélectionnez le lien Rapports dans la page de détails de l’extension.

Acquisition

Vous pouvez afficher les données liées à l’acquisition dans cet onglet pour la période sélectionnée.

  • Acquisition agrégée au cours de la période sélectionnée pour l’acquisition globale
  • Acquisition agrégée divisée par les téléchargements d’extensions d’installation connectée Azure DevOps pour une extension gratuite
  • Acquisition agrégée divisée par les versions d’essai d’achat connecté Azure DevOps pour l’extension payante
  • Tendance quotidienne des vues de pages d’extension avec acquisition pour Azure DevOps et les serveurs connectés
  • Pourcentage de conversion des vues de page en acquisition

Pour les extensions payantes, tous les détails transactionnels pour l’achat et les versions d’évaluation sont disponibles avec la date, le nom de l’organisation, la date de fin de l’essai et la quantité. Vous pouvez utiliser l’action Contact pour communiquer avec vos utilisateurs. Pour plus d’informations, consultez la section Contact fournie plus loin dans cet article.

Désinstaller

Vous pouvez afficher les statistiques suivantes :

  • Nombre d’organisations désinstallées de votre extension
  • Tendance quotidienne des extensions de désinstallation
  • Commentaires détaillés partagés lors des désinstallations
  • Principales raisons de désinstallation

Vous pouvez utiliser la recherche de texte et de dates pour analyser et tirer davantage d’insights à partir des commentaires détaillés.

Pour les extensions payantes, vous pouvez utiliser l’action Contact pour communiquer avec vos utilisateurs. Pour plus d’informations, consultez la section Contact fournie plus loin dans cet article.

Évaluations et révision

Cet onglet vous fournit les informations suivantes :

  • Évaluation moyenne de la période sélectionnée par rapport à l’évaluation globale
  • Évaluation moyenne par nombre de réviseurs
  • Tendance quotidienne de l’évaluation moyenne

La section des détails fournit tous les avis et vos réponses en vue transactionnelle.

Vous pouvez répondre à une révision ou modifier une réponse précédente et mieux gérer l’engagement avec vos utilisateurs d’extension. Vous pouvez également Faire appel pour annuler une note si le problème signalé est lié à la Marketplace ou à la plateforme sous-jacente. Si le problème est valide, nous annulons l’évaluation.

Gérer l’engagement

L’onglet Q &A fournit un instantané de toutes les questions de vos utilisateurs d’extension, avec des requêtes non répondues en haut. Vous pouvez répondre ou modifier les réponses précédentes pour mieux gérer l’engagement avec vos utilisateurs d’extension.

Exporter vers Excel

Tous les éléments de données disponibles dans la page rapports sont également disponibles en téléchargement au format XLS pour faciliter la création de vos propres rapports personnalisés.

Contact

Pour les extensions payantes, vous pouvez utiliser l’action Contact pour communiquer avec vos utilisateurs. Cette fonctionnalité est disponible uniquement pour les éditeurs disposant d’un accès Contributeur+ sur l’extension.

La place de marché répartit la première communication avec l’utilisateur, car notre politique de confidentialité n’autorise pas le partage direct d’adresses e-mail client. Seuls les utilisateurs qui ont choisi de communiquer reçoivent l’e-mail. La date du dernier contact d'une organisation est mise à jour après l’envoi d’une communication.

Importante

Suivez les instructions sur la communication transactionnelle et promotionnelle. Les éditeurs ont trouvé que l’envoi de communications promotionnelles ou de courrier indésirable aux utilisateurs est ajouté à une liste de blocage et perdent l’accès à la fonctionnalité Contact pour toutes leurs extensions.

Communication transactionnelle : e-mails transmettant des informations critiques nécessaires à l’utilisation continue de l’extension ou du service, par exemple :

  • Avis de sécurité critiques
  • Confirmations des transactions
  • Avis de rappel de produit
  • Demandes de commentaires spécifiques
  • Avis de suppression de service

E-mails promotionnels : e-mails utilisés pour commercialiser votre extension, produit, service, site web ou événement, par exemple :

  • Invitations à des événements ou à des diffusions web
  • Informations sur les nouveaux programmes marketing ou partenaires
  • Offres pour obtenir du contenu à valeur ajoutée
  • Bulletins d’information contenant du contenu promotionnel

Pour plus d’informations, consultez le Contrat d’éditeur de la Place de marché.

Terminologie Descriptif
Affichages de page Nombre total de consultations de la page des détails de l'extension. Les vues répétées sont comptées.
Installations d’Azure DevOps Services Nombre total d’organisations dans laquelle l’extension est installée. Les installations répétées sur la même organisation sont comptées.
Installations d’Azure DevOps Server Nombre total de regroupements où l’extension est installée. Les installations répétées sur la même collection sont comptabilisées. Les données de serveur déconnectées ne sont pas disponibles.