Publikování rozšíření Azure DevOps z příkazového řádku

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

K publikování rozšíření na Visual Studio Marketplace použijte rozhraní příkazového řádku pro různé platformy pro Azure DevOps (tfx-cli). Další informace najdete v přehledu publikování, instalace a sdílení.

Požadavky

Kategorie Požadavky
Nářadí Platformní rozhraní příkazového řádku pro Azure DevOps (tfx-cli) nainstalované prostřednictvím npm
Autentizace Token Microsoft Entra (doporučeno) nebo osobní přístupový token (PAT) s oborem Marketplace (publish)
Vydavatel Účet publisher nastavený na Visual Studio Marketplace

Důležité

Zvažte použití bezpečnějších tokenů Microsoft Entra místo vysoce rizikových osobních přístupových tokenů. Další informace najdete v tématu Snížení využití PAT. Projděte si doprovodné materiály k ověřování a zvolte správný mechanismus ověřování pro vaše potřeby.

Získání nástroje tfx-cli

  1. Pokud ho nemáte, stáhněte a nainstalujte NodeJS. Během nastavování se ujistěte, že máte zvolenou možnost Přidat do PATH.

  2. Otevřete příkazový řádek a zadejte npm i -g tfx-cli.

Pokud už máte rozhraní příkazového řádku TFX nainstalované, můžete ho aktualizovat na nejnovější verzi spuštěním npm up -g tfx-cli.

Nainstalujte tfx-cli

npm install -g tfx-cli

Publikování pomocí tokenu Microsoft Entra

Rozšíření můžete publikovat jako instanční objekt.

  1. Přidejte službu principal jako člena účtu vydavatele. Získejte ID instančního objektu prostřednictvím rozhraní REST API přihlášením přes Azure CLI a dotazováním profilu instančního objektu:
az login --service-principal --username <appId> --password <password> --tenant <tenant-id>
# 499b84ac-1321-427f-aa17-267ca6975798 specifies azure devops as a resource
az rest -u https://app.vssps.visualstudio.com/_apis/profile/profiles/me --resource 499b84ac-1321-427f-aa17-267ca6975798

Pak pomocí ID z předchozího kroku přidejte service principal jako člena do účtu vydavatele.

  1. Publikujte rozšíření prostřednictvím TFX CLI pomocí služebního principálu. Spuštěním následujícího příkazu rozhraní příkazového řádku TFX použijte jeho přístupový token:
tfx extension publish --publisher my-publisher --vsix my-publisher.my-extension-1.0.0.vsix --auth-type pat -t <ENTRA_TOKEN>

Publikování pomocí osobního přístupového tokenu

Vytvořte osobní přístupový token (PAT) s rozsahem Marketplace (publikování).

Jakmile nainstalujete tfx-cli a budete mít pat, zabalíte a publikujete rozšíření.

  1. Otevřete příkazový řádek do kořenového adresáře rozšíření.
  2. Spuštěním následujícího příkazu publikujte rozšíření. Po zobrazení výzvy zadejte token k ověření.
tfx extension publish --publisher <YOUR_PUBLISHER_ID> --manifest-js <YOUR_EXTENSION_MANIFEST> --share-with <ACCOUNT_NAME>

Potenciální chyby

Pokud už je vaše rozšíření publikované, může se zobrazit následující chyba:

Failed Request: Internal Server Error(500) - Version number must increase each time an extension is published. Extension: fabrikam.my-extension  Current version: 0.1.9  Updated version: 0.1.9

--rev-version Přidejte příznak, který automaticky zvýší verzi patch vašeho rozšíření. Tento příznak také uloží novou verzi do manifestu.

Poznámka:

Všechny možnosti dostupné pro create jsou k dispozici pro příkaz publish.

Příklad

C:\vso-team-calendar>tfx extension publish --publisher publishFabrikam --manifest-js fabrikam.config.js --share-with fabrikam --rev-version
Copyright Microsoft Corporation
> Personal access token:
Checking if this extension is already published
It is, update the extension
Waiting for server to validate extension package...
Sharing extension with fabrikam.

=== Completed operation: publish extension ===
 - Packaging: C:\vso-team-calendar\fabrikam.team-calendar-0.2.6.vsix
 - Publishing: success
 - Sharing: shared with fabrikam