Een integratie in Marketplace verpakken en publiceren

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

In dit artikel wordt uitgelegd hoe u uw hulpprogramma, service of product publiceert dat kan worden geïntegreerd met Azure DevOps in Visual Studio Marketplace. Door te publiceren op Marketplace kunnen gebruikers oplossingen ontdekken die hun Azure DevOps-ervaring uitbreiden en verbeteren. De Marketplace fungeert als de centrale hub voor personen en teams om integraties en extensies te vinden.

Blader door de Marketplace- om voorbeelden van andere integraties en extensies te bekijken.

Vereiste voorwaarden

Aan de volgende lijst met vereisten moet worden voldaan voordat u naar Marketplace publiceert.

Vereiste assets verzamelen

• Ten minste één schermopname van uw integratie.
• Oproep tot actie of aan de slag URL voor gebruikers.

Een uitgeversaccount maken

Elke extensie of integratie, inclusief die van Microsoft, moet een uitgever hebben. Iedereen kan een uitgever maken en er extensies onder publiceren. U kunt ook uitgeverstoegang delen met andere gebruikers, zoals uw ontwikkelteam.

1. Meld u aan bij de Visual Studio Marketplace-publicatieportal.

2. Als u geen deel uitmaakt van een bestaande uitgever, selecteert u + Een uitgever maken.
   Voer een naam in voor de uitgever; het id-veld wordt automatisch ingevuld op basis van uw invoer.

   

   Notitie

   • Zorg ervoor dat de naam van de uitgever binnen 16 tekens valt bij multibyte-tekens.
   • Sla de uitgevers-id op. U hebt deze nodig in het manifestbestand van uw extensie.

   Als u niet wordt gevraagd om een uitgever te maken, schuift u naar Extensies publiceren onder Gerelateerde sites.

   • Stel een unieke uitgevers-id in, zoals mycompany-myteam. Gebruik deze waarde voor het publisher kenmerk in uw manifest.
   • Stel een weergavenaam in, zoals My Team.

3. Controleer de Marketplace-uitgeversovereenkomst en selecteer Maken.

   

Nadat u de uitgever hebt gemaakt, kunt u items beheren, hoewel er geen items worden weergegeven totdat u publiceert.

Uw manifest en middelen organiseren

Voer de volgende stappen uit om uw manifest en assets te organiseren:

1. Maak een home map om vereiste assets op te slaan.
2. Maak een images map voor:
   • Uw integratielogo (128x128 pixels)
   • Schermafbeeldingen (1366x768 pixels)
3. Maak een overview.md bestand om uw integratie te beschrijven. Zie GitHub Flavored Markdown voor meer informatie.
4. Maak een vss-integration.json bestand. Dit is het manifestbestand van uw Marketplace-vermelding. Voor meer informatie, zie de referentie voor het extensiemanifest.

Het extensiemanifest voltooien

Publiceren naar Marketplace begint met het maken van een manifestbestand dat uw integratie en de belangrijkste detectiedetails definieert (schermopnamen, logo's, overzichtsinhoud). Deze informatie wordt gebruikt om uw integratie te presenteren aan gebruikers op de Marketplace.

1. Vul uw vss-integration.json bestand in met de volgende JSON:

   {
       "manifestVersion": 1,
       "id": "myservice",
       "version": "1.0.0",
       "name": "My Service",
       "publisher": "mycompany",
       "description": "Awesome tools to help you and your team do great things everyday.",
       "targets": [
           {
               "id": "Microsoft.VisualStudio.Services.Integration"
           }
       ],    
       "icons": {
           "default": "images/service-logo.png"
       },
       "categories": [
           "Plan and track"
       ],
       "tags": [
           "working",
           "people person",
           "search"
       ],
       "screenshots": [
           {
               "path": "images/screen1.png"
           },
           {
               "path": "images/screen2.png"
           }
       ],
       "content": {
           "details": {
               "path": "overview.md"
           },
           "license": {
               "path": "fabrikam-license-terms.md"
           }
       },
       "links": {
           "getstarted": {
               "uri": "https://www.mycompany.com/help/getstarted"
           },
           "learn": {
               "uri": "https://www.mycompany.com/features"
           },
           "support": {
               "uri": "https://www.mycompany.com/support"
           }
       },
       "branding": {
           "color": "rgb(34, 34, 34)",
           "theme": "dark"
       }
   }
   

2. Werk de JSON bij met behulp van de volgende verwijzingen:

De volgende eigenschappen zijn vereist:

Met de volgende optionele eigenschappen kunnen gebruikers uw extensie detecteren en leren:

Begrijp de detailpagina

• 1 - beschrijving
• 2 - pictogram
• 3 - categorieën
• 4 - schermopnamen
• 5 - de inhoud (details)
• 6 - koppelingen
• 7 - huisstijl

Verpak uw manifest en middelen

Het pakkethulpprogramma installeren (tfx-cli)

Installeer of werk de CLI voor meerdere platforms voor Azure DevOps (tfx-cli) bij met behulp van npm:

npm i -g tfx-cli

Uw integratie inpakken in een VSIX-bestand

tfx extension create --manifest-globs vss-extension.json

Uw integratie publiceren naar Marketplace

Zodra uw extensie is verpakt, kunt u deze uploaden naar Marketplace onder een uitgever. De publisher-id die is opgegeven in het manifestbestand van uw -extensie, moet overeenkomen met de id van de uitgever waaronder de extensie is geüpload.

1. Selecteer in de beheerportaluw uitgever in de vervolgkeuzelijst boven aan de pagina.

2. Selecteer Nieuwe extensie>Azure DevOps-.

   

3. Sleep uw bestand hierheen of selecteer het om uw VSIX-bestand te vinden dat u in de vorige pakketstap hebt gemaakt en kies vervolgens Uploaden.

   

   Na snelle validatie wordt uw extensie weergegeven in de lijst met gepubliceerde extensies. Maak u geen zorgen, de extensie is alleen zichtbaar voor u.

   

Op dit moment is uw extensie niet zichtbaar voor accounts. Als u het zichtbaar wilt maken voor anderen, moet u de extensie delen.

Deel uw integratie

Voordat u een integratie in een Azure DevOps-organisatie installeert, deelt u deze met die organisatie. Delen is vereist voor ontwikkeling en testen, omdat het de enige manier is om een integratie uit te voeren tijdens deze fasen.

Volg deze stappen om een integratie te delen:

1. Selecteer een integratie in de lijst met weergegeven items
2. Selecteer de knop Delen
3. Geef de naam op van de organisatie om deze integratie zichtbaar te maken voor. Als u bijvoorbeeld een integratie zichtbaar wilt maken voor de dev.azure.com/fabrikam-fiber-inc organisatie, geeft u fabrikam-fiber-incop.

Een item bijwerken

Ga als volgt te werk om een extensie bij te werken die u al hebt gepubliceerd:

1. Selecteer uw extensie in de lijst met weergegeven items.
2. Klik met de rechtermuisknop en selecteer Update voor de ontwikkelingsversie, zoals publisher.extension-dev.
3. Valideer uw extensie.
4. Pas dezelfde updates toe op de productieversie, zoals publisher.extension.
5. Blader naar het VSIX-bestand voor uw extensie en upload het.

Azure DevOps installeert automatisch de bijgewerkte versie voor alle accounts die al de extensie hebben. Nieuwe installaties ontvangen ook de nieuwste versie.

Uw integratie openbaar maken

Zie Uw vermelding openbaar maken voor informatie over het zichtbaar maken van uw integratie voor iedereen.