Bővítmény közzététele

Miután létrehoz egy Azure fejlesztői parancssori felület (azdCLI) bővítményt, csomagolja be és tegye közzé egy beállításjegyzékben, hogy mások is telepíthessenek. Ez a cikk bemutatja, hogyan teheti közzé a Contoso Resource Tagger mintabővítményt a Mintabővítmény létrehozása rövid útmutatóból. Ugyanezeket a lépéseket bármely bővítményre alkalmazhatja.

Megjegyzés:

A azd bővítmény keretrendszere általánosan elérhető. Az egyes bővítmények vagy képességek saját előzetes verziós állapotúak lehetnek.

Beállításjegyzék kiválasztása

azd feloldhatja a hivatalos beállításjegyzék bővítményeit, az egyéni URL-alapú jegyzékjegyzékeket, a fájlalapú jegyzékjegyzékeket és a hordozható csomagfájlokat. Válassza ki a bővítmény telepítésével egyező terjesztési módszert:

  • Hivatalos regiszter: Az a regiszter, amely a azd-tel együtt érkezik. Ha itt szeretne közzétenni, küldjön be egy pull requestet a azure/azure-dev tárház egy forkjába.
  • Egyéni URL-alapú beállításjegyzék: A csapat által a nyilvános vagy privát terjesztéshez használt távoli beállításjegyzék-jegyzék.
  • Fájlalapú beállításjegyzék: Helyi beállításjegyzék-jegyzék fejlesztéshez, teszteléshez, offline használathoz vagy privát terjesztéshez.
  • Fejlesztési vagy éjszakai beállításjegyzék: A folyamatban lévő vagy automatikusan létrehozott belső bővítmények beállításjegyzéke. A fejlesztői beállításjegyzék bővítményei aláíratlanok, nem fedik le a Azure-támogatás, és értesítés nélkül módosíthatók vagy eltávolíthatók.
  • Hordozható csomag: Olyan önálló .zip csomag, amelyet a felhasználók közvetlenül helyi elérési útról vagy HTTPS-URL-címről telepíthetnek beállításjegyzék-forrás hozzáadása nélkül.

Ez a cikk a fejlesztési beállításjegyzék használatával mutatja be a megosztott tesztforráson való közzétételt. A forrás- és verziófeloldási részletekért tekintse meg a bővítmény-keretrendszer referenciáit.

Prerequisites

  • Egy kész bővítmény a Mintabővítmény létrehozása rövid útmutatóból.
  • A azd fejlesztői bővítmény (microsoft.azd.extensions), amely a csomagoláshoz és a azd x közzétételhez használt parancsokat tartalmazza. Ha befejezte a rövid útmutatót, az már telepítve van. Ellenkező esetben futtassa a parancsot azd extension install microsoft.azd.extensions.
  • Egy GitHub fiók és egy adattár a kiadási összetevők üzemeltetéséhez.
  • Egy GitHub személyes hozzáférési jogkivonat (PAT) a repo hatókörrel. A kiadási parancs ezt a jogkivonatot használja GitHub kiadások létrehozásához és összetevők feltöltéséhez. További információ: Személyes hozzáférési jogkivonatok kezelése.

A verzió és a változásnapló frissítése

Közzététel előtt frissítse a verziót, és dokumentálja a módosításokat:

  1. Frissítse a(z) versionextension.yaml tulajdonságát a szemantikus verziókezelés szerint. Növelje a fő-, al- vagy hibajavítási verziószámot a változás típusától függően.

  2. Frissítse a CHANGELOG.md elemet az adott verzióhoz tartozó jelentős változásokkal. azd a változásnaplót használja a kibocsátási megjegyzések létrehozásához.

A bővítmény csomagolása

azd x pack A parancs használatával platformspecifikus bináris fájlokat hozhat létre, és csomagolhatja a bővítményt:

azd x pack

A parancs összetevőket hoz létre a kimeneti címtár minden támogatott platformjához. azd x release feltölti ezeket az összetevőket, és azd x publish frissíti a beállításjegyzék metaadatait. A Csomagolás pillanatkép-teszteket is futtat annak ellenőrzéséhez, hogy a bővítmény a közzététel előtt a várt módon működik-e.

Ha a bővítményt közvetlenül szeretné terjeszteni ahelyett, hogy egy beállításjegyzéken keresztül szeretné közzétenni, hozzon létre egy önálló csomagot a következővel azd x pack --bundle: . A csomag egy hordozható .zip csomag, amely tartalmazza a beállításjegyzék metaadatait és a telepítéshez szükséges összetevőket egy fájl elérési útjáról vagy HTTPS URL-címéről.

Tedd közzé a bővítményt

azd x release A paranccsal hozzon létre egy GitHub kiadást, és töltse fel a csomagolt összetevőket. Adja meg a GitHub PAT-t, hogy a parancs létre tudja hozni a kiadást:

azd x release

A parancs létrehoz egy kiadást a GitHub adattárban, feltölti a csomagolt bináris fájlokat, és kibocsátási jegyzeteket hoz létre a változásnaplóból. A beállításjegyzék-alapú közzététel ezeket a kiadási összetevőket használja letölthető bővítménycsomagokként. A közvetlen csomagterjesztéshez nincs szükség erre a kiadási lépésre, hacsak nem szeretné üzemeltetni a csomagot GitHub.

Tip

Tárolja a GitHub PAT-t egy környezeti változóban ahelyett, hogy a parancssorba továbbítanák. A támogatott hitelesítési lehetőségek megtekintéséhez a(z) azd x release --help futtatásával ellenőrizze a parancs súgóját.

Közzététel a regiszterben

azd x publish A parancs használatával hozzáadhatja vagy frissítheti a bővítmény bejegyzését a bővítményregisztrációs adatbázisban:

azd x publish

A parancs frissíti a beállításjegyzék metaadatait, így a felhasználók felfedezhetik és telepíthetik a bővítményt a fejlesztési beállításjegyzékből. Ez a lépés eltér a gyorsútmutatóban végzett helyi közzétételtől, amelyet a azd x init hajt végre, és amely a bővítményt csak a gépén lévő helyi forrásban regisztrálja. A azd x publish futtatása frissíti a megosztott fejlesztői beállításjegyzéket, így más felhasználók is telepíthetik a bővítményt.

Telepítés és ellenőrzés

A közzététel után ellenőrizze, hogy mások is telepíthetik-e a bővítményt a fejlesztési beállításjegyzékből:

  1. Győződjön meg arról, hogy már hozzáadta a fejlesztői regisztert.

    azd extension source add -n dev -t url -l "https://aka.ms/azd/extensions/registry/dev"
    
  2. Telepítse a bővítményt az azonosítója alapján.

    azd extension install contoso.azd.tagger
    
  3. Futtasson egy parancsot a bővítmény működésének megerősítéséhez.

    azd tagger show
    

Közzététel a hivatalos nyilvántartásban

A hivatalos beállításjegyzékben való közzétételhez küldje el a bővítményt a azure/azure-dev adattárba:

  1. Forkolja le a azure/azure-dev tárolót.
  2. Add hozzá a bővítményed regisztrációs bejegyzését a hivatalos regisztrációs fájlhoz a saját forkodban.
  3. Küldj egy pull requestet felülvizsgálatra.

A Azure fejlesztői parancssori felület csapata az egyesítés előtt áttekinti a hivatalos beállításjegyzék-beküldéseket a minőség és a biztonság érdekében.

A közzététel hibáinak elhárítása

Az alábbi táblázat a gyakori közzétételi problémákat és azok megoldásait sorolja fel:

Issue Resolution
A kiadás hitelesítési hibával meghiúsul Ellenőrizze, hogy a GitHub PAT érvényes-e, és rendelkezik-e a hatókörrelrepo.
A pillanatkép-tesztek meghiúsulnak a(z) azd x pack során. Tekintse át a teszt kimenetét, frissítse a pillanatképeket, ha a módosítások várhatók, és futtassa újra a parancsot.
A felhasználók nem találják a bővítményt Győződjön meg arról, hogy a fejlesztési regisztrációs adatbázis hozzá lett adva, és hogy a(z) azd x publish sikeresen befejeződött.
Verzióütközés a közzététel során Növelje a(z) version elemben található extension.yaml értékét egy új, még nem használt verzióra.