Zabalení a publikování rozšíření
Azure DevOps Services | Azure DevOps Server 2022 – Azure DevOps Server 2019
Jakmile budete vyvíjet rozšíření, můžete ho zabalit a publikovat na Visual Studio Marketplace. Marketplace je globální úložiště pro privátní a veřejná rozšíření, integrace a další nabídky od Microsoftu.
Poznámka:
Pro informace o vlastnostech pro objevení, které jsou k dispozici v souboru manifestu rozšíření a pomáhají uživatelům objevit a dozvědět se o vašem rozšíření, se podívejte na Referenci k manifestu rozšíření.
Požadavky
Před publikováním na Marketplace musí být splněn následující seznam požadavků.
- Nainstalujte nástroj pro balení rozšíření (TFX). Spusťte
npm install -g tfx-cli
příkaz z příkazového řádku. - Ujistěte se, že máte udělená správná oprávnění k používání obrázků, například ikon, log, snímků obrazovky atd.
- Zahrňte důkladný soubor
overview.md
k popisu vašeho záznamu na tržišti. - Zahrňte ikonu rozšíření, která má velikost aspoň 128 × 128 pixelů.
- Pokud odkazujete na produkty Microsoftu, používejte místo zkratek celé názvy, například Azure DevOps vs. AzDO nebo jakoukoli jinou zkratku.
- Nepoužívejte názvy značek v názvu vašeho rozšíření.
Vytvoření vydavatele
Všechna rozšíření a integrace, včetně rozšíření od Microsoftu, mají vydavatele. Každý může vytvořit vydavatele a publikovat pod ním rozšíření. Můžete také poskytnout přístup k vašemu vydavateli jiným lidem, pokud rozšíření vyvíjí tým.
Uživatel vlastní vydavatele, obvykle uživatele, který ho vytvořil. Vydavatele můžete také sdílet s ostatními uživateli.
Přihlaste se k portálu pro publikování Visual Studio Marketplace.
Pokud ještě nejste členem existujícího vydavatele, + Vytvořte vydavatele. Do pole pro název vydavatele zadejte název. Pole ID by se mělo automaticky nastavit na základě zadaného názvu.
Poznámka:
Poznamenejte si ID, protože ho musíte nastavit v souboru manifestu vaší přípony.
Pokud se nezobrazí výzva k vytvoření vydavatele, posuňte se dolů na konec stránky a vyberte Publikovat rozšíření pod Související weby.
- Zadejte identifikátor vydavatele, například:
mycompany-myteam
. Tento identifikátor se používá jako hodnota atributupublisher
v souboru manifestu přípony. - Zadejte zobrazovaný název vydavatele, například:
My Team
- Zadejte identifikátor vydavatele, například:
Zkontrolujte smlouvu vydavatele Marketplace, a pak vyberte Vytvořit.
Po vytvoření vydavatele budete přesměrováni na správu položek, ale žádné položky tam nejsou.
Zabalte své rozšíření
Pokud chcete nahrát rozšíření, zabalte ho jako soubor .vsix kompatibilní s VSIX 2.0. Microsoft poskytuje rozhraní příkazového řádku (CLI) pro různé platformy pro zabalení a publikování rozšíření.
Otevřete soubor manifestu přípony (
vss-extension.json
) a nastavte hodnotupublisher
pole na ID vydavatele. Příklad:{ ... "id": "my-first-extension", "publisher": "AnnetteNielsen", ... }
Z příkazového řádku spusťte balicí příkaz nástroje TFX ze složky rozšíření.
npx tfx-cli extension create
Zobrazí se zpráva oznamující, že se vaše rozšíření úspěšně zabalí:
=== Completed operation: create extension === - VSIX: C:\my-first-extension\AnnetteNielsen.my-first-extension-1.0.0.vsix - Extension ID: my-first-extension - Extension Version: 1.0.0 - Publisher: AnnetteNielsen
Poznámka:
Zvýšení verze rozšíření nebo integrace v manifestu s každou aktualizací
Použijte přepínač příkazového řádku --rev-version
. Tento přepínač zvýší číslo verze patchu vašeho rozšíření a uloží novou verzi do manifestu.
Kontrola velikosti balíčku
Zkontrolujte velikost vsix po zabalení. Pokud je větší než 50 MB, musíte ho optimalizovat. Pokud to chcete udělat, podívejte se na následující aspekty:
- Odstraněním redundantních závislostí a jejich uvedením jednou v balíčku rozšíření můžete zefektivnit správu.
- Načítá závislosti za běhu nebo během instalace místo jejich zahrnutí do balíčku. Zvažte použití knihovny instalačního programu nástrojů k vyžádání závislostí nástrojů za běhu. Tento přístup ukládá nástroj do mezipaměti na základě verze pro privátní agenty, což zabraňuje stahování při každém sestavení. Knihovna instalačního programu nástrojů nefunguje v odpojených scénářích (bez internetu), které by se měly zmínit v popisu úlohy nebo dokumentaci.
- Pomocí nástroje webpack můžete optimalizovat závislosti v úkolech pomocí techniky tree shaking.
Publikování rozšíření
Jakmile je vaše rozšíření zabalené, můžete ho nahrát na Marketplace pod vydavatelem. Identifikátor publisher
zadaný v souboru manifestu rozšíření se musí shodovat s identifikátorem vydavatele, pod který se přípona nahraje.
Na portálu pro správu vyberte vydavatele z rozevírací nabídky v horní části stránky.
Vyberte Nové rozšíření>Azure DevOps.
Přetáhněte soubor nebo ho vyberte, abyste našli soubor VSIX, který jste vytvořili v předchozím kroku balení, a pak zvolte Nahrát.
Po rychlém ověření se vaše rozšíření zobrazí v seznamu publikovaných rozšíření. Nedělejte si starosti, rozšíření je viditelné jenom pro vás.
V tomto okamžiku není vaše rozšíření viditelné pro žádné účty a nejde ho nainstalovat, dokud ho nesdílíte.
Poznámka:
Microsoft spustí kontrolu virů na každém novém a aktualizovaném balíčku rozšíření publikovaném. Dokud nebude kontrola úplně jasná, nepublikujeme rozšíření na Marketplace pro veřejné použití. Tímto způsobem se také vyhneme nevhodnému nebo urážlivému obsahu na stránkách Marketplace.
Sdílení rozšíření
Před instalací rozšíření v Azure DevOps můžete rozšíření sdílet s organizací. Pokud chcete rozšíření sdílet, proveďte následující úlohy:
Na portálu pro správu Marketplace vyberte rozšíření ze seznamu, klikněte pravým tlačítkem myši a v závislosti na rozšíření zvolte Sdílet, Zrušit sdílení nebo Publikovat nebo Zrušit publikování.
Vyberte Organizace a zadejte název vaší organizace. Stiskněte klávesu Enter.
Zavřete panel.
Vaše rozšíření je teď možné nainstalovat do této organizace.
Instalace rozšíření
Pokud chcete nainstalovat sdílené rozšíření, postupujte následovně.
Na Marketplace vyberte své rozšíření, aby se otevřela stránka s přehledem.
Poznámka:
Vzhledem k tomu, že je vaše rozšíření soukromé, uvidí tuto stránku jenom vy a členové organizace, se kterou je sdílená.
Vyberte Získat zdarma a spusťte proces instalace. V rozevírací nabídce vyberte organizaci, se kterou jste rozšíření sdíleli.
Vyberte volbu Instalovat.
Gratulujeme! Rozšíření jste nainstalovali do organizace a můžete ho vyzkoušet.
Vyzkoušejte si rozšíření.
Výběrem možnosti Pokračovat v organizaci na konci průvodce instalací přejděte na domovskou stránku organizace, do které se rozšíření nainstalovalo (
https://dev.azure.com/{organization}
).Aktualizujte si stránku v prohlížeči.
Otevřete nastavení organizace a pak vyberte Rozšíření.
Nové rozšíření by se mělo zobrazit na kartě Nainstalované .
Ladění vašeho rozšíření
Chcete-li ladit rozšíření pomocí nástrojů Visual Studio nebo Browser Developer Tools, změňte manifest přidáním baseUri
vlastnosti. Tato akce urychlí vývoj bez nutnosti opětovného nasazení rozšíření při každé změně zdrojového kódu.
{
...
"baseUri": "https://localhost:44300",
...
}
Když změníte manifest, načte rozšíření z místní instance webového serveru. Například IISExpress v sadě Visual Studio. Po změně manifestu toto rozšíření nasaďte a nainstalujte pouze jednou.
Poznámka:
Spusťte místní webový server v režimu SSL, protože Azure DevOps vyžaduje, aby webová stránka byla obsluhována ze zabezpečeného zdroje. V opačném případě se během načítání prvku IFRAME rozšíření zobrazí chyba v konzole prohlížeče.
Aktualizace rozšíření
Pokud chcete změnit rozšíření, které už je publikované, aktualizujte ho.
Tip
Doporučujeme rozšíření aktualizovat, nikoli odebírat a znovu nahrávat. Doporučujeme mít také dvě rozšíření, například publisher.extension
a publisher.extension-dev
.
Publisher.extension
je veřejná na Marketplace, kde si ji zákazníci můžou nainstalovat ve svých organizacích Azure DevOps.
Publisher.extension-dev
je soukromá na Marketplace a může být sdílena s organizací, kterou vlastníte a řídíte.
Nemusíte udržovat dvě kopie zdrojového kódu rozšíření. Můžete udržovat dva soubory manifestu – jeden pro každou příponu a během balení rozšíření můžete poskytnout příslušný soubor manifestu nástroji tfx-cli. Informace o argumentech nezbytných pro nástroj najdete v příkazech rozšíření TFX.
- Ze seznamu zobrazených položek vyberte rozšíření.
- Klikněte pravým tlačítkem myši a vyberte Aktualizovat pro
publisher.extension-dev
, například. - Ověřte své rozšíření.
- Proveďte stejné aktualizace produkční verze,
publisher.extension
například. - Přejděte na soubor .vsix pro vaše rozšíření a nahrajte ho.
Aktualizovaná verze vašeho rozšíření se automaticky nainstaluje do účtů, které ho už mají nainstalované. Nové účty, ve kterých je rozšíření nainstalované v budoucnu, obdrží také nejnovější verzi.
Zveřejněte své rozšíření
Zatímco vyvíjíte rozšíření nebo integraci pro Marketplace, ponechte ho v privátním režimu. Pokud chcete rozšíření zpřístupnit veřejně, nastavte v manifestu true
.
Kvalifikace
Pokud chcete mít veřejný výpis na Marketplace, musí vaše integrace nebo rozšíření splňovat následující kvalifikace:
- Funguje s Azure DevOps nebo jeho rozšířením.
- Vy nebo vaše společnost vlastníte, vyvíjíte a máte licenci k distribuci a inzerování integrace nebo rozšíření.
- Rozšíření nebo integrace se aktivně udržují.
Microsoft může také požádat o ukázku a zkontrolovat obsah plánovaný pro vaši položku Marketplace.
Hlavní vydavatel
Program Top Publisher je k dispozici pouze pro vydavatele s rozšířeními nebo integracemi Azure DevOps. Neplatí pro vydavatele rozšíření Visual Studio IDE a Visual Studio Code.
Program Top Publisher oceňuje vydavatele s nasazením pro své zákazníky a tržiště prostřednictvím příkladných zásad, kvality, spolehlivosti a podpory. Jakmile se stanete hlavním vydavatelem, ve všech vašich veřejných nabídkách se bude zobrazovat odznak „Top Publisher.“
Hlavní požadavky vydavatele
Program Top Publisher na Marketplace je navržený tak, aby vám pomohl vyhodnotit nebo získat rozšíření a integrace Azure DevOps s jistotou. Odznáček Top Publisher znamená, že vydavatel ukazuje závazek svých zákazníků a Marketplace prostřednictvím vzorových zásad, kvality, spolehlivosti a podpory. Je určený pro vydavatele s jedním nebo více globálními rozšířeními Nebo integracemi Azure DevOps a nevztahuje se na vydavatele rozšíření Visual Studio IDE a visual Studio Code.
Marketplace přiřadí vydavateli odznáček po pečlivé kontrole vydavatele pomocí následujících parametrů:
- Zásady ochrany osobních údajů
- Zásady licencování
- Zásady podpory
- Dokumentace
- Reakce na dotazy
- Hodnocení a recenze nabídek
- Aktivní přijetí a počet instalací pro jejich nabídky
- Správa alespoň jednoho veřejného rozšíření pro Azure DevOps
- Veřejné rozšíření s více než 5 000 instalacemi a aktivním počtem instalací přesahujícím 1000
Pokud získáte rozšíření od Top Publisheru, můžete očekávat včasnou podporu a dobré celkové prostředí. Podívejte se na nabídky od hlavních vydavatelů.
Další informace o přidávání zásad do vaší nabídky najdete v manifestu rozšíření
Aktualizujte profil vydavatele.
Prostřednictvím profilu vydavatele můžete všechny své nabídky prezentovat na jednom místě spolu s klíčovými informacemi souvisejícími s vydavatelem. Pokud chcete zadat informace, které se zobrazí v profilu, proveďte následující kroky:
a. Přihlaste se k https://marketplace.visualstudio.com/manage/publishers účtu, pomocí kterého publikujete a spravujete své nabídky v sadě Visual Studio Marketplace.
b. Vyberte vydavatele a vyplňte oddíl O vás na kartě Podrobnosti .
c. Uložte změny a vyberte Zobrazit profil , abyste viděli, jak se uživatelům zobrazuje. Tuto profilovou stránku můžete využít k propagaci vašich nabídek.
Poznámka:
Tento program certifikuje vydavatele, nikoli software nebo zabezpečení jejich rozšíření a integrací. Při vyhodnocování nabídek od vydavatele doporučujeme zkontrolovat bezpečnostní informace. Pokud jste získali rozšíření z Top Publisheru a nejste spokojení s vašimi zkušenostmi, zvažte možnost zapojit se s vydavatelem jako první.
Přihlásit se jako špičkový vydavatel
- Přihlaste se k portálu pro správu marketplace pomocí účtu, pomocí kterého publikujete a spravujete své nabídky na Marketplace.
- Vyberte vydavatele a přejděte na jeho kartu Top Publisher. Karta se zobrazí, pokud máte jedno nebo více globálních rozšíření nebo integrací Azure DevOps (Server/Služba).
- Pokud splňujete výše uvedené požadavky a jste vlastníkem vydavatele, můžete požádat o program. Po aplikaci se týmu Marketplace odešle e-mail, který zkontroluje váš případ. Odpoví do 10 pracovních dnů dalšími kroky, objasněním otázek nebo udělením odznáček.
Tým pravděpodobně bere v úvahu další parametry, jako je aktivní využívání nabídek, počet instalací/zahájení a hodnocení & recenze v rámci nabídek před udělením odznáček. Společnost Microsoft si vyhrazuje právo kdykoli udělit, odmítnout nebo odvolat odznáček Top Publisher.
Jakmile je vydavatel hlavním vydavatelem, musí všechny její budoucí aktualizace a nabídky splňovat výše uvedené požadavky.
Reagování na recenze rozšíření Marketplace
Můžete reagovat na recenze, které zákazníci zanechají pro vaše rozšíření ve Visual Studio Marketplace. Pokud máte jedno z následujících oprávnění: vlastník, tvůrce nebo přispěvatel, vyhledejte a vyberte Odpovědět vedle recenze.
Můžete nechat jenom jednu odpověď. Nepoužívejte recenze jako fórum podpory. Pokud potřebujete další podrobnosti, poskytněte alias podpory pro recenzenta. Problémy pak můžete vyřešit externě a odpověď aktualizovat řešením.
Pokyny pro odpovědi vydavatele
Nechte Visual Studio Marketplace otevřeným, přívětivým, respektujícím a užitečným místem pro zákazníky, kde mohou najít, vyzkoušet, nainstalovat a ohodnotit rozšíření. Komunikace hraje důležitou roli při udržování zdravé komunity. Pro usnadnění vytváření tohoto prostředí jsou zde pokyny pro vydavatele, kteří reagují na recenze zákazníků. Zamyslete se nad interakcemi zákazníků a zamyslete se nad duchem zkušeností zákazníků, které se Marketplace snaží vytvořit.
- Vyhraďte hodnocení pro komentáře zákazníků. Odpověď můžete použít jenom k odpovídání na recenzi.
- Respektovat všechny názory zákazníků. Považovat komentáře za zpětnou vazbu bez diskuse, kritiky nebo argumentu.
- Zajistěte, aby odpovědi přidaly hodnotu a byly relevantní pro komentáře vašich zákazníků.
- Zaměřte se na přesné řešení otázek nebo problémů. Pokud potřebujete další podrobnosti, požádejte zákazníka, aby vás kontaktoval prostřednictvím e-mailu a nediskutoval v recenzích. Když problém vyřešíte, aktualizujte odpověď řešením. Odpovědi můžete upravit, jako když zákazníci můžou upravovat svoje recenze.
- Oznamte všechny nevhodné recenze, jako je spam, zneužívající nebo urážlivý obsah, pro naši recenzi.
Žádost o zrušení revize
Jako vydavatel se můžete odvolat proti hodnocení, pokud je problém nahlášený kvůli trhu nebo základní platformě. Pokud je problém platný, správci Marketplace hodnocení vynulují. Na stránce centra rozšíření můžete podat odvolání prostřednictvím sekce hodnocení a recenzí.
Zrušení publikování rozšíření
Pokud už je nechcete nabízet na Marketplace, můžete zrušit publikování bezplatných rozšíření.
Zvažte odebrání rozšíření z Marketplace v následujících scénářích:
- Vytvořili jste nové rozšíření a už nechcete nabízet aktuální rozšíření.
- Vaše rozšíření má problém a chcete ho z Marketplace odebrat, dokud problém nevyřešíte.
- Rozšíření jste publikovali omylem jako veřejné.
Aby bylo možné zrušit publikování nebo odebrat rozšíření, musí být splněna určitá kritéria:
Akce | Požadavky |
---|---|
Zrušit publikování | Nepublikovaná mohou být pouze bezplatná rozšíření . |
Odebrat | Aby bylo vaše rozšíření odstraněno, musí mít nula (0) instalací. |
Důležité
Pokud ho musíte odebrat z důvodu právních nebo bezpečnostních problémů, obraťte se na zákaznickou podporu v komunitě vývojářů. Žádost zkontrolujeme a ručně odstraníme rozšíření.
Vyberte rozšíření na stránce vydavatele a v nabídce zvolte Zrušit publikování .
Vaše rozšíření se okamžitě nepublikuje z Marketplace a noví uživatelé ho nemůžou nainstalovat. Hodnocení a recenze vašeho rozšíření zůstanou nedotčené.
Pokud chcete rozšíření znovu nabídnout na Marketplace, v nabídce vyberte Publikovat.
Pokud má vaše rozšíření nulovou instalaci, můžete se rozhodnout, že ho úplně odeberete z Marketplace. Uděláte to tak, že v nabídce vyberete Odebrat. Tuto akci nelze vrátit zpět.