Paketera och publicera en integrering

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

Publicera ditt verktyg, din tjänst eller produkt som integreras med Azure DevOps på Visual Studio Marketplace. Marketplace är den centrala hubben för användare att identifiera integreringar och tillägg.

Anmärkning

Den här artikeln beskriver integreringar (externa verktyg och tjänster). Tillägg (tillägg som körs i Azure DevOps) finns i Paketera och publicera tillägg.

Förutsättningar

Följande lista med krav måste uppfyllas innan du publicerar på Marketplace.

Kategori Kravspecifikation
Förpackningsverktyg Installera tilläggspaketeringsverktyget (TFX). Kör npm install -g tfx-cli från en kommandotolk.
Bildbehörigheter Se till att du har rätt behörighet att använda bilder, till exempel ikoner, logotyper, skärmbilder och så vidare.
Översikt över Marketplace Inkludera en grundlig overview.md fil för att beskriva din lista på Marketplace.
Tilläggsikon Inkludera en ikon för tillägget som representerar din integrering, ditt företag eller din organisation, minst 128 x 128 bildpunkter i storlek (PNG eller JPEG).
Microsofts produktnamn Använd fullständiga namn för Microsoft-produkter (till exempel Azure DevOps i stället för AzDO eller andra förkortningar).
Varumärken Använd inte varumärkesnamn i namnet på ditt tillägg.

Du behöver också följande tillgångar:

  • Minst en skärmbild av din integrering
  • En uppmaning till handling- eller start-URL för användare

Skapa en utgivare

Varje tillägg eller integrering, inklusive de från Microsoft, måste ha en utgivare. Vem som helst kan skapa en utgivare och publicera tillägg under denne. Du kan också dela utgivaråtkomst med andra användare, till exempel ditt utvecklingsteam.

  1. Logga in på Visual Studio Marketplace-publiceringsportalen.

  2. Om du inte är en del av en befintlig utgivare väljer du + Skapa en utgivare.
    Ange ett utgivarnamn. ID-fältet fylls i automatiskt baserat på din inmatning.

    Skärmbild som visar den markerade knappen Skapa utgivare.

    Anmärkning

    • Kontrollera att utgivarnamnet är inom 16 tecken för flerabytestecken.
    • Spara utgivar-ID:t – du behöver det i tilläggets manifestfil.

    Om du inte uppmanas att skapa en utgivare bläddrar du till Publicera tillägg under Relaterade webbplatser.

    • Ange en unik utgivaridentifierare, till exempel mycompany-myteam. Använd det här värdet för publisher attributet i manifestet.
    • Ange ett visningsnamn, till exempel My Team.
  3. Granska Marketplace Publisher-avtalet och välj sedan Skapa.

    Skapa publicerare för tillägg

När du har skapat utgivaren kan du hantera objekt, även om inga objekt visas förrän du publicerar.

Konfigurera projektstruktur

Skapa följande kataloglayout:

home/
├── images/
│   ├── integration-logo.png    (128×128 px minimum)
│   └── screenshot.png          (1366×768 px)
├── overview.md
└── vss-integration.json
Arkiv Avsikt
overview.md GitHub Flavored Markdown-beskrivning av din integrering.
vss-integration.json Marknadsplatsmanifest. Se Tilläggsmanifest-referens.

Skapa manifestet

Skapa vss-integration.json med följande innehåll och uppdatera sedan värdena för din integrering:

{
    "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"
    }
}

Uppdatera fält med hjälp av följande referenser:

Följande egenskaper krävs:

Fastighet Beskrivning Noteringar
manifestVersion Ett tal som motsvarar versionen av manifestformatet. Ska vara 1.
ID Tilläggets identifierare. Det här ID:t är en sträng som måste vara unik bland tillägg från samma utgivare. Den måste börja med ett alfabetiskt eller numeriskt tecken och innehålla "A" genom "Z", "a" till "z", "0" till och med "9" och "-" (bindestreck). Exempel: sample-extension.
version En sträng som anger versionen av ett tillägg. Ska vara i formatet major.minor.patch, till exempel 0.1.2 eller 1.0.0. Du kan också lägga till ett fjärde tal för följande format: 0.1.2.3
Namn Ett kort, läsbart namn på tillägget. Begränsad till 200 tecken. Exempel: "Fabrikam Agile Board Extension".
förläggare Utgivarens identifierare. Den här identifieraren måste matcha den identifierare som tillägget publiceras under. Se Skapa och hantera en utgivare.
Kategorier Matris med strängar som representerar de kategorier som tillägget tillhör. Minst en kategori måste anges och det finns ingen gräns för hur många kategorier du kan inkludera. Giltiga värden: Azure Repos, Azure Boards, Azure Pipelines, Azure Test Plansoch Azure Artifacts.

Anteckningar:
    – Använd version >=0.6.3 av tfx-cli om du publicerar tillägget programmatiskt.
    – Om du använder Azure DevOps Extension Tasks-tillägget för att publicera ska du kontrollera att dess version är >= 1.2.8. Du kan behöva godkänna tilläggsuppdateringen på grund av de senaste omfångsändringarna.
    – De kategorier som tidigare nämnts finns internt i Visual Studio Marketplace och Azure DevOps Server 2019 och senare.
Mål De produkter och tjänster som stöds av din integrering eller ditt tillägg. Mer information finns i installationsmål. En matris med objekt, där varje objekt har ett id fält som anger något av följande:
    - Microsoft.VisualStudio.Services(tillägg som fungerar med Azure DevOps),
    - Microsoft.TeamFoundation.Server (tillägg som fungerar med Azure DevOps Server),
    - Microsoft.VisualStudio.Services.Integration,
    - Microsoft.TeamFoundation.Server.Integration (integreringar som fungerar med Azure DevOps Server)

Följande valfria egenskaper hjälper användarna att identifiera och lära sig mer om ditt tillägg:

Fastighet Beskrivning Noteringar
beskrivning Några meningar som beskriver tilläggen. Begränsad till 200 tecken. Beskrivningen bör vara tilläggets "hisshöjd" – ett par rader för att beskriva ditt tillägg på Marketplace och få personer att vilja installera det. Se exemplet nedan
Ikoner Ordlista med ikoner som representerar tillägget. Giltiga nycklar: default (128 x 128 bildpunkter) av typen BMP, GIF, EXIF, JPG, PNG och TIFF). Andra nycklar som large (512 x 512 bildpunkter) kan stödjas i framtiden. Värdet för varje nyckel är sökvägen till ikonfilen i tillägget
tagg Matris med strängtaggar som hjälper användarna att hitta tillägget. Exempel: agile, project management, task timeroch så vidare.
skärmbilder Matris med bilder som inte kunde inkluderas i ditt innehåll. Skärmbilder är mer värdefulla när de visas i ditt innehåll och bör användas där för att skapa en informationssida för kvalitetsmarknadsinformation för ditt tillägg. Använd skärmbilder för mindre viktiga bilder som inte finns i ditt innehåll. Varje bild ska vara 1366 x 768 bildpunkter. Sökvägen till filen i tillägget är för varje objekt path.
innehåll Ordlista över innehållsfiler som beskriver ditt tillägg till användare. Varje tillägg bör innehålla fast innehåll. Så här visar du användarna vad tillägget kan göra. Gör den rik, förbrukningsbar och inkludera skärmbilder där det behövs. Inkludera en overview.md fil som basinnehållsdel. Varje fil antas vara i GitHub Flavored Markdown-format . För path varje objekt är sökvägen till Markdown-filen i tillägget. Giltiga nycklar: details. Andra nycklar kan stödjas i framtiden.
Länkar Ordlista med länkar som hjälper användarna att lära sig mer om ditt tillägg, få support och flytta. Giltiga nycklar: getstarted – första stegen, hur du konfigurerar eller använder. learn – djupare innehåll som hjälper användarna att bättre förstå ditt tillägg eller din tjänst. license – licensavtal för slutanvändare. privacypolicy – Sekretesspolicy för ett tillägg. support – få hjälp och stöd för ett tillägg. Värdet för varje nyckel är ett objekt med ett uri fält, vilket är länkens absoluta URL
Databasen Ordlista med egenskaper som beskriver källkodslagringsplatsen för tillägget Giltiga nycklar: type – Typ av lagringsplats. Exempel: git. uri – Absolut URL för lagringsplatsen.
Märken Matris med länkar till externa metadatamärken som TravisCI, Appveyor och så vidare från de godkända märkenas webbplatser Giltiga nycklar: href – Länken som användaren navigerar till när användaren väljer badgen. uri – Den absoluta URL:en för den märkesbild som ska visas. description - Beskrivning av märket, som ska visas när muspekaren förflyttas över.
Branding Ordlista över varumärkesrelaterade egenskaper. Giltiga nycklar: color – den primära färgen på tillägget eller utgivaren, kan vara en hex (#ff00ff), RGB (rgb(100 200,50)) eller HTML-färgnamn som stöds (blå). theme - kompletterar färgen; använd mörk för mörka varumärkesfärger eller ljus för ljusare varumärkesfärger.

Varning

Ange public till false eller utelämna det tills du är redo för offentlig synlighet.

Paketera integreringen

  1. Installera förpackningsverktyget om du inte redan har gjort det:

    npm install -g tfx-cli
    
  2. Paketera integrationen i en .vsix-fil:

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

    Tips/Råd

    Använd --rev-version för att automatiskt öka versionsnumret för korrigeringen.

Publicera på Marketplace

När tillägget har paketerats kan du ladda upp det till Marketplace under en utgivare. Identifieraren publisher som anges i tilläggets manifestfil måste matcha identifieraren för utgivaren som tillägget laddas upp under.

  1. Från hanteringsportalen väljer du utgivaren från den nedrullningsbara menyn överst på sidan.

  2. Välj Nytt tillägg>Azure DevOps.

    Skärmbild som visar listrutan Nytt tillägg och markerat Azure DevOps-val.

  3. Dra och släpp filen eller välj den för att hitta VSIX-filen, som du skapade i föregående paketeringssteg, och välj sedan Ladda upp.

    Skärmbild som visar Uppladdning av nytt tillägg för Azure DevOps.

    Efter snabb validering visas tillägget i listan över publicerade tillägg. Oroa dig inte, tillägget är bara synligt för dig.

    Skärmbild som visar tillägget i listan över publicerade tillägg.

Ditt tillägg är i det här läget inte synligt för några konton. För att göra det synligt för andra måste du dela tillägget.

Anmärkning

Microsoft kör en virusgenomsökning på varje nytt och uppdaterat tilläggspaket som publiceras. Innan genomsökningen är klar publicerar vi inte tillägget på Marketplace för offentlig användning. På så sätt undviker vi också att visa olämpligt eller stötande innehåll på Marketplace-sidorna.

Dela integreringen

Innan du kan installera en integrering i en Azure DevOps-organisation måste du dela den med den organisationen.

  1. Välj din integrering i listan över objekt som visas.
  2. Välj Dela.
  3. Ange organisationsnamnet (till exempel fabrikam-fiber-inc för dev.azure.com/fabrikam-fiber-inc).

Uppdatera integreringen

Gör följande för att uppdatera ett tillägg som du redan har publicerat:

Tips/Råd

Uppdatera tillägget i stället för att ta bort och ladda upp det igen. Vi rekommenderar att du underhåller två tillägg: publisher.extension, offentliga på Marketplace för kunder och publisher.extension-dev, privata, som endast delas med din organisation för utveckling och testning. Du behöver inte två kopior av källkoden– det är bara att underhålla separata manifestfiler för varje tillägg. När du paketerar anger du lämplig manifestfil till verktyget tfx-cli. Mer information finns i TFX-tilläggskommandon.

  1. Välj ditt tillägg i listan över objekt som visas.
  2. Högerklicka och välj Uppdatera för utvecklingsversionen, till exempel publisher.extension-dev.
  3. Bekräfta ditt tillägg.
  4. Tillämpa samma uppdateringar på produktionsversionen, till exempel publisher.extension.
  5. Bläddra till .vsix-filen för tillägget och ladda upp det.

Azure DevOps installerar automatiskt den uppdaterade versionen för alla konton som redan har tillägget. Nya installationer får också den senaste versionen.

Göra integrationen offentlig

Om du vill göra din integrering synlig för alla Marketplace-användare anger du public flaggan till true i manifestet och publicerar om den.

Mer information om de kvalifikationer som krävs för offentliga listor finns i Göra ditt tillägg offentligt.