Pubblicare un'estensione

Dopo aver compilato un'estensione Azure Developer CLI (azd), creare un pacchetto e pubblicarlo in un registro in modo che altri utenti possano installarlo. Questo articolo mostra come pubblicare l'estensione di esempio Contoso Resource Tagger dalla guida introduttiva Creare un'estensione di esempio. È possibile applicare gli stessi passaggi a qualsiasi estensione.

Annotazioni

Il azd framework di estensione è disponibile a livello generale. Le singole estensioni o funzionalità potrebbero avere lo stato di anteprima.

Scegliere un registro

azd può risolvere le estensioni dal Registro di sistema ufficiale, manifesti del Registro di sistema personalizzati basati su URL, manifesti del Registro di sistema basati su file e file bundle portabili. Scegliere l'approccio di distribuzione che corrisponde al modo in cui gli utenti installano l'estensione:

  • Registro ufficiale: registro fornito con azd. Per pubblicare qui, invia una pull request a un fork del repository azure/azure-dev.
  • Registro personalizzato basato su URL: un manifesto del Registro di sistema remoto che il team ospita per la distribuzione pubblica o privata.
  • Registro di sistema basato su file: manifesto del Registro di sistema locale per lo sviluppo, il test, l'uso offline o la distribuzione privata.
  • Registro di sistema di sviluppo o notturno: un registro di consenso esplicito per le estensioni di primo piano o create automaticamente. Le estensioni nel Registro di sistema di sviluppo non sono firmate, non coperte da supporto tecnico di Azure e possono essere modificate o rimosse senza preavviso.
  • Bundle portabile: pacchetto autonomo .zip che gli utenti installano direttamente da un percorso locale o da un URL HTTPS senza aggiungere un'origine del Registro di sistema.

Questo articolo usa il Registro di sistema di sviluppo per illustrare la pubblicazione in un'origine di test condivisa. Per informazioni dettagliate sulla risoluzione delle versioni e di origine, vedere le informazioni di riferimento sul framework di estensione.

Prerequisiti

  • Un'estensione completata del quickstart Creare un'estensione di esempio.
  • Estensione azd per sviluppatori (microsoft.azd.extensions), che fornisce i azd x comandi usati per creare pacchetti e pubblicare. Se l'avvio rapido è stato completato, è già installato. In caso contrario, eseguire azd extension install microsoft.azd.extensions.
  • Un account GitHub e un repository per ospitare gli artefatti della release.
  • Un token di accesso personale (PAT) di GitHub con lo scope repo. Il comando release usa questo token per creare GitHub versioni e caricare elementi. Per altre informazioni, vedere Gestione dei token di accesso personali.

Aggiornare la versione e il log delle modifiche

Prima di pubblicare, aggiornare la versione e documentare le modifiche:

  1. Aggiorna la proprietà version in extension.yaml seguendo il versionamento semantico. Incrementare il numero principale, secondario o di patch in base al tipo di modifica.

  2. Eseguire l'aggiornamento CHANGELOG.md con le modifiche rilevanti per questa versione. azd usa il log delle modifiche per generare note sulla versione.

Creare un pacchetto dell'estensione

Usare il azd x pack comando per compilare file binari specifici della piattaforma e creare un pacchetto dell'estensione:

azd x pack

Il comando crea elementi per ogni piattaforma supportata nella directory di output. azd x release carica questi artefatti e azd x publish aggiorna i metadati del Registro di sistema. La creazione di pacchetti esegue anche test snapshot per verificare che l'estensione si comporti come previsto prima della pubblicazione.

Se si vuole distribuire direttamente un'estensione anziché pubblicarla tramite un registro, creare un bundle autonomo con azd x pack --bundle. Il bundle è una portabile .zip che contiene i metadati e gli artefatti del Registro di sistema necessari per l'installazione da un percorso di file o da un URL HTTPS.

Pubblica l'estensione

Usare il azd x release comando per creare una versione GitHub e caricare gli artefatti in pacchetto. Specificare il GitHub pat in modo che il comando possa creare la versione:

azd x release

Il comando crea una versione nel repository GitHub, carica i file binari in pacchetto e genera note sulla versione dal log delle modifiche. La pubblicazione basata sul Registro di sistema usa questi artefatti di versione come pacchetti di estensione scaricabili. La distribuzione di bundle diretti non richiede questo passaggio di versione, a meno che non si voglia ospitare il bundle in GitHub.

Suggerimento

Archiviare il GitHub PAT in una variabile di ambiente anziché passarlo alla riga di comando. Consulta la guida del comando eseguendo azd x release --help per visualizzare le opzioni di autenticazione supportate.

Pubblicare nel Registro di sistema

Utilizzare il comando azd x publish per aggiungere o aggiornare la voce della propria estensione nel registro delle estensioni:

azd x publish

Il comando aggiorna i metadati del Registro di sistema in modo che gli utenti possano individuare e installare l'estensione dal Registro di sistema di sviluppo. Questo passaggio è diverso dalla pubblicazione locale eseguita da azd x init nella guida introduttiva, che registra l'estensione solo in un'origine locale sul computer. L'esecuzione azd x publish di aggiornamenti del Registro di sistema di sviluppo condiviso consente ad altri utenti di installare l'estensione.

Installare e verificare

Dopo la pubblicazione, verificare che altri utenti possano installare l'estensione dal Registro di sistema di sviluppo:

  1. Assicurati di aver già aggiunto il registro di sviluppo.

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

  2. Installare l'estensione in base al relativo ID.

    azd extension install contoso.azd.tagger

  3. Eseguire un comando per confermare il funzionamento dell'estensione.

    azd tagger show

Pubblicare nel registro ufficiale

Per pubblicare nel registro ufficiale, inviare l'estensione al repository azure/azure-dev:

  1. Creare una copia tramite fork del repository azure/azure-dev.
  2. Aggiungi la voce di registro dell'estensione al file di registro ufficiale nel tuo fork.
  3. Inviare una richiesta pull per la revisione.

Il team di Azure Developer CLI esamina le richieste di inserimento nel registro ufficiale per verificarne la qualità e la sicurezza prima di unirle.

Risolvere i problemi di pubblicazione

Nella tabella seguente sono elencati i problemi di pubblicazione comuni e le relative soluzioni:

Issue Resolution
Il rilascio ha esito negativo e viene visualizzato un errore di autenticazione Verifica che il PAT GitHub sia valido e abbia l'ambito repo.
I test di snapshot hanno esito negativo durante azd x pack Esaminare l'output del test, aggiornare gli snapshot se sono previste modifiche ed eseguire di nuovo il comando.
Gli utenti non riescono a trovare l'estensione Verificare che il registro di sviluppo sia stato aggiunto e che azd x publish sia stato completato con successo.
Conflitto di versione durante la pubblicazione Aumentare version in extension.yaml a una nuova versione non ancora utilizzata.

Contenuti correlati

  • Last updated on