Publikowanie rozszerzenia

Po utworzeniu rozszerzenia interfejsu wiersza polecenia dewelopera Azure (azd) utwórz pakiet i opublikuj go w rejestrze, aby inni mogli go zainstalować. W tym artykule pokazano, jak opublikować przykładowe rozszerzenie Contoso Resource Tagger z przewodnika „Szybki start: tworzenie przykładowego rozszerzenia”. Te same kroki można zastosować do dowolnego rozszerzenia.

Wybieranie rejestru

azd może rozpoznawać rozszerzenia z oficjalnego rejestru, niestandardowych manifestów rejestru opartych na adresach URL, manifestów rejestru opartych na plikach i przenośnych plików pakietu. Wybierz metodę dystrybucji zgodną ze sposobem instalowania rozszerzenia przez użytkowników:

• Oficjalny rejestr: rejestr dostarczany z azd. Aby opublikować tutaj, prześlij pull request do forka repozytorium azure/azure-dev.
• Niestandardowy rejestr oparty na adresach URL: zdalny manifest rejestru hostujący zespół na potrzeby dystrybucji publicznej lub prywatnej.
• Rejestr oparty na plikach: lokalny manifest rejestru na potrzeby programowania, testowania, używania w trybie offline lub dystrybucji prywatnej.
• Rejestr programistyczny lub nocny: rejestr zgody na pracę w toku lub automatycznie skompilowane rozszerzenia pierwszej firmy. Rozszerzenia w rejestrze deweloperów są niepodpisane, nieobjęte pomoc techniczna platformy Azure i mogą ulec zmianie lub usunięciu bez powiadomienia.
• Przenośny pakiet: samodzielny .zip pakiet instalowany przez użytkowników bezpośrednio ze ścieżki lokalnej lub adresu URL HTTPS bez dodawania źródła rejestru.

W tym artykule użyto rejestru deweloperów do zademonstrowania publikowania w udostępnionym źródle testowym. Aby uzyskać szczegółowe informacje na temat rozwiązywania problemów ze źródłem i wersją, zobacz dokumentację platformy rozszerzeń.

Wymagania wstępne

• Gotowe rozszerzenie utworzone na podstawie przewodnika Szybki start: tworzenie przykładowego rozszerzenia.
• Rozszerzenie deweloperskie azd (microsoft.azd.extensions), które udostępnia polecenia azd x służące do pakowania i publikowania. Po ukończeniu przewodnika Szybki start jest on już zainstalowany. W przeciwnym razie uruchom polecenie azd extension install microsoft.azd.extensions.
• Konto w serwisie GitHub i repozytorium do przechowywania artefaktów wydania.
• Osobisty token dostępu GitHub (PAT) z zakresem repo. Polecenie release używa tego tokenu do tworzenia wydań w serwisie GitHub i przesyłania artefaktów. Aby uzyskać więcej informacji, zobacz Zarządzanie osobistymi tokenami dostępu.

Aktualizowanie wersji i dziennika zmian

Przed opublikowaniem zaktualizuj wersję i udojmij zmiany:

1. Zaktualizuj właściwość version w extension.yaml zgodnie z wersjonowaniem semantycznym. Zwiększa liczbę głównych, pomocniczych lub poprawek na podstawie typu zmiany.

2. Zaktualizuj CHANGELOG.md, uwzględniając najważniejsze zmiany w tej wersji. azd używa dziennika zmian do generowania informacji o wydaniu.

Spakuj rozszerzenie

azd x pack Użyj polecenia , aby utworzyć pliki binarne specyficzne dla platformy i spakować rozszerzenie:

azd x pack

Polecenie tworzy artefakty dla każdej obsługiwanej platformy w katalogu wyjściowym. azd x release przekazuje te artefakty i azd x publish aktualizuje metadane rejestru. Pakiet uruchamia również testy migawek w celu sprawdzenia, czy rozszerzenie działa zgodnie z oczekiwaniami przed opublikowaniem.

Jeśli chcesz dystrybuować rozszerzenie bezpośrednio zamiast publikować je za pośrednictwem rejestru, utwórz pakiet samodzielnej zawartości za pomocą polecenia azd x pack --bundle. Pakiet jest przenośnym elementem .zip zawierającym metadane rejestru i artefakty wymagane do instalacji ze ścieżki pliku lub adresu URL HTTPS.

Opublikuj rozszerzenie

Użyj polecenia azd x release, aby utworzyć wydanie w serwisie GitHub i przesłać spakowane artefakty. Podaj token PAT GitHub, aby polecenie mogło utworzyć wydanie:

azd x release

Polecenie tworzy wydanie w repozytorium GitHub, przekazuje spakowane pliki binarne i generuje informacje o wersji z dziennika zmian. Publikowanie oparte na rejestrze używa tych artefaktów wydania jako pakietów rozszerzeń do pobrania. Dystrybucja pakietów bezpośrednich nie wymaga tego kroku wydania, chyba że chcesz hostować pakiet w GitHub.

Publikowanie w rejestrze

azd x publish Użyj polecenia , aby dodać lub zaktualizować wpis rozszerzenia w rejestrze rozszerzeń:

azd x publish

Polecenie aktualizuje metadane rejestru, aby użytkownicy mogli odnajdywać i instalować rozszerzenie z rejestru deweloperów. Ten krok różni się od lokalnego publikowania, które azd x init wykonuje w przewodniku „Szybki start”, a które rejestruje rozszerzenie tylko w źródle lokalnym na komputerze. Uruchomienie polecenia azd x publish aktualizuje współdzielony rejestr deweloperski, aby inni użytkownicy mogli zainstalować Twoje rozszerzenie.

Instalowanie i weryfikowanie

Po opublikowaniu sprawdź, czy inne osoby mogą zainstalować rozszerzenie z rejestru deweloperów:

1. Upewnij się, że rejestr deweloperów został już dodany.

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

2. Zainstaluj rozszerzenie według jego identyfikatora.

   azd extension install contoso.azd.tagger
   

3. Uruchom polecenie, aby potwierdzić działanie rozszerzenia.

   azd tagger show
   

Publikowanie w oficjalnym rejestrze

Aby opublikować plik w oficjalnym rejestrze, prześlij rozszerzenie do repozytorium azure/azure-dev:

1. Rozwidlenie repozytorium azure/azure-dev.
2. Dodaj wpis rejestracyjny rozszerzenia do oficjalnego pliku rejestru w swoim fork.
3. Prześlij pull request do przeglądu.

Zespół Azure Developer CLI sprawdza zgłoszenia do oficjalnego rejestru pod kątem jakości i bezpieczeństwa, zanim zostaną scalone.

Rozwiązywanie problemów z publikowaniem

W poniższej tabeli wymieniono typowe problemy z publikowaniem i ich rozwiązania:

Treści powiązane

• Definiowanie manifestu rozszerzenia
• Dodawanie możliwości rozszerzenia
• Komunikacja z azd przy użyciu zestawu SDK
• Dokumentacja platformy rozszerzeń