Publicera ett tillägg

När du har skapat ett Azure Developer CLI-tillägg (azd) paketera och publicera det till ett register så att andra kan installera det. Den här artikeln visar hur du publicerar exempeltillägget Contoso Resource Tagger från snabbstarten Skapa ett exempeltillägg. Du kan använda samma steg för alla tillägg.

Note

Tilläggsramverket azd är allmänt tillgängligt. Enskilda tillägg eller funktioner kan ha sin egen förhandsversionsstatus.

Välj ett register

azd kan lösa tillägg från det officiella registret, anpassade URL-baserade registermanifest, filbaserade registermanifest och portabla paketfiler. Välj den distributionsmetod som matchar hur användarna installerar tillägget:

  • Officiellt register: Registret som levereras med azd. Om du vill publicera här skickar du en pull-begäran till en förgrening av lagringsplatsen azure/azure-dev.
  • Anpassat URL-baserat register: Ett fjärrregistermanifest som ditt team är värd för för offentlig eller privat distribution.
  • Filbaserat register: Ett lokalt registermanifest för utveckling, testning, offlineanvändning eller privat distribution.
  • Utveckling eller nattligt register: Ett registreringsregister för pågående arbete eller automatiskt skapade tillägg från första part. Tillägg i dev-registret är osignerade, omfattas inte av Azure support och kan ändras eller tas bort utan föregående meddelande.
  • Portabelt paket: Ett fristående .zip paket som användarna installerar direkt från en lokal sökväg eller EN HTTPS-URL utan att lägga till en registerkälla.

Den här artikeln använder utvecklingsregistret för att demonstrera publicering till en delad testkälla. Information om käll- och versionsmatchning finns i referensen för ramverket Extension.

Förutsättningar

  • Ett färdigt tillägg från snabbstartsguiden Skapa ett exempeltillägg.
  • Utvecklartillägget azd (microsoft.azd.extensions), som innehåller de azd x kommandon som används för att paketera och publicera. Om du har slutfört snabbstarten är den redan installerad. Annars kör du azd extension install microsoft.azd.extensions.
  • Ett GitHub-konto och ett repo för att lagra releaseartefakterna.
  • En personlig åtkomsttoken för GitHub (PAT) med behörigheten repo. Versionskommandot använder den här token för att skapa GitHub versioner och ladda upp artefakter. Mer information finns i Hantera dina personliga åtkomsttoken.

Uppdatera version och ändringslogg

Innan du publicerar uppdaterar du versionen och dokumenterar ändringarna:

  1. Uppdatera egenskapen version i extension.yaml enligt semantisk versionshantering. Inkrementera huvudversionsnumret, delversionsnumret eller patchnumret beroende på typen av ändring.

  2. Uppdatera CHANGELOG.md med viktiga ändringar för den här versionen. azd använder ändringsloggen för att generera versionsinformation.

Paketera tillägget

azd x pack Använd kommandot för att skapa plattformsspecifika binärfiler och paketera tillägget:

azd x pack

Kommandot skapar artefakter för varje plattform som stöds i utdatakatalogen. azd x release laddar upp dessa artefakter och azd x publish uppdaterar registermetadata. Paketeringen kör även ögonblicksbildstester för att verifiera att tillägget fungerar som förväntat innan du publicerar.

Om du vill distribuera ett tillägg direkt i stället för att publicera det via ett register skapar du ett fristående paket med azd x pack --bundle. Paketet är en bärbar .zip fil som innehåller de registermetadata och artefakter som behövs för installation från en filsökväg eller EN HTTPS-URL.

Släpp tillägget

azd x release Använd kommandot för att skapa en GitHub version och ladda upp de paketerade artefakterna. Ange din GitHub PAT så att kommandot kan skapa versionen:

azd x release

Kommandot skapar en version i din GitHub lagringsplats, laddar upp de paketerade binärfilerna och genererar viktig information från din ändringslogg. Registerbaserad publicering använder dessa versionsartefakter som nedladdningsbara tilläggspaket. Distribution av direktpaket kräver inte det här versionssteget om du inte vill vara värd för paketet i GitHub.

Tip

Lagra din GitHub PAT i en miljövariabel i stället för att skicka den på kommandoraden. Kontrollera kommandohjälpen genom att köra azd x release --help för de autentiseringsalternativ som stöds.

Publicera i registret

azd x publish Använd kommandot för att lägga till eller uppdatera tilläggets post i tilläggsregistret:

azd x publish

Kommandot uppdaterar registermetadata så att användarna kan identifiera och installera tillägget från utvecklingsregistret. Det här steget skiljer sig från den lokala publicering som azd x init utförs i snabbstarten, som endast registrerar tillägget till en lokal källa på datorn. När du kör azd x publish uppdateras det delade utvecklingsregistret så att andra användare kan installera tillägget.

Installera och verifiera

När du har publicerat kontrollerar du att andra kan installera tillägget från utvecklingsregistret:

  1. Kontrollera att du redan har lagt till utvecklingsregistret.

    azd extension source add -n dev -t url -l "https://aka.ms/azd/extensions/registry/dev"

  2. Installera tillägget med dess ID.

    azd extension install contoso.azd.tagger

  3. Kör ett kommando för att bekräfta att tillägget fungerar.

    azd tagger show

Publicera till det officiella registret

Om du vill publicera till det officiella registret skickar du tillägget till lagringsplatsen azure/azure-dev:

  1. Förgrena lagringsplatsen azure/azure-dev.
  2. Lägg till tilläggets registerpost i den officiella registerfilen i din fork.
  3. Skicka en pull request för granskning.

CLI-teamet Azure Developer granskar officiella registerinlämningar för kvalitet och säkerhet innan de slås samman.

Felsöka publicering

I följande tabell visas vanliga publiceringsproblem och deras lösningar:

Issue Lösning
Frisläppningen misslyckas på grund av ett autentiseringsfel Kontrollera att ditt GitHub PAT är giltigt och har omfånget repo.
Snapshot-tester misslyckas vid azd x pack Granska testutdata, uppdatera dina ögonblicksbilder om ändringarna förväntas och kör kommandot igen.
Användarna kan inte hitta tillägget Kontrollera att utvecklingsregistret har lagts till och att azd x publish har slutförts.
Versionskonflikt under publicering Öka version i extension.yaml till en ny, oanvänd version.

Relaterat innehåll

  • Last updated on