Publicar uma extensão

Depois de criar uma extensão da CLI do Desenvolvedor Azure (azd), empacote e publique-a em um registro para que outras pessoas possam instalá-la. Este artigo mostra como publicar a extensão de exemplo Contoso Resource Tagger do início rápido Criar uma extensão de exemplo. Você pode aplicar as mesmas etapas a qualquer extensão.

Escolher um registro

azd pode resolver extensões do registro oficial, manifestos de registro baseados em URL personalizados, manifestos de registro baseados em arquivo e arquivos de pacote portáteis. Escolha a abordagem de distribuição que corresponde à forma como os usuários instalam sua extensão:

• Registro oficial: o registro que acompanha azd. Para publicar aqui, envie um pull request para um fork do repositório azure/azure-dev.
• Registro baseado em URL personalizado: um manifesto de registro remoto que sua equipe hospeda para distribuição pública ou privada.
• Registro baseado em arquivo: um manifesto do registro local para desenvolvimento, teste, uso offline ou distribuição privada.
• Desenvolvimento ou registro noturno: um registro de aceitação para extensões corporativas em andamento ou de primeira parte criadas automaticamente. As extensões no registro de desenvolvimento não são atribuídas, não cobertas por Suporte do Azure e podem ser alteradas ou removidas sem aviso prévio.
• Pacote portátil: um pacote autocontido .zip que os usuários instalam diretamente de um caminho local ou URL HTTPS sem adicionar uma fonte do Registro.

Este artigo usa o registro de desenvolvimento para demonstrar a publicação em uma fonte de teste compartilhada. Para obter detalhes de resolução de origem e versão, consulte a referência da estrutura de extensão.

Pré-requisitos

• Uma extensão concluída do início rápido criar uma extensão de exemplo.
• A azd extensão do desenvolvedor (microsoft.azd.extensions), que fornece os azd x comandos usados para empacotar e publicar. Se você concluiu o início rápido, ele já está instalado. Caso contrário, execute azd extension install microsoft.azd.extensions.
• Uma conta no GitHub e um repositório para hospedar os artefatos de lançamento.
• Um token de acesso pessoal (PAT) do GitHub com o escopo repo. O comando release usa esse token para criar releases no GitHub e fazer upload de artefatos. Para obter mais informações, consulte Gerenciar seus tokens de acesso pessoal.

Atualizar a versão e o registro de alterações

Antes de publicar, atualize a versão e documente suas alterações:

1. Atualize a propriedade version em extension.yaml, seguindo o versionamento semântico. Incremente o número principal, secundário ou de patch com base no tipo de alteração.

2. Atualize CHANGELOG.md com as alterações notáveis desta versão. azd usa o registro de alterações para gerar notas de versão.

Empacotar a extensão

Use o azd x pack comando para criar binários específicos da plataforma e empacotar a extensão:

azd x pack

O comando cria artefatos para cada plataforma com suporte no diretório de saída. azd x release carrega esses artefatos e azd x publish atualiza os metadados do Registro. O empacotamento também executa testes de instantâneo para verificar se a extensão se comporta conforme o esperado antes de publicar.

Se você quiser distribuir uma extensão diretamente em vez de publicá-la por meio de um registro, crie um pacote autossuficiente com azd x pack --bundle. O pacote é um portátil .zip que contém os metadados e artefatos do Registro necessários para instalação de um caminho de arquivo ou URL HTTPS.

Liberar a extensão

Use o comando azd x release para criar uma release no GitHub e enviar os artefatos empacotados. Forneça seu PAT GitHub para que o comando possa criar a versão:

azd x release

O comando cria uma versão em seu repositório GitHub, carrega os binários empacotados e gera notas de versão do seu changelog. A publicação baseada em Registro usa esses artefatos de versão como os pacotes de extensão para download. A distribuição de pacote direto não requer essa etapa de versão, a menos que você queira hospedar o pacote no GitHub.

Publicar no registro

Use o azd x publish comando para adicionar ou atualizar a entrada da extensão no registro de extensão:

azd x publish

O comando atualiza os metadados do Registro para que os usuários possam descobrir e instalar sua extensão no registro de desenvolvimento. Essa etapa difere da publicação local executada azd x init no início rápido, que registra a extensão apenas para uma fonte local em seu computador. A execução azd x publish atualiza o registro de desenvolvimento compartilhado para que outros usuários possam instalar sua extensão.

Instalar e verificar

Depois de publicar, verifique se outras pessoas podem instalar sua extensão no registro de desenvolvimento:

1. Verifique se você já adicionou o registro de desenvolvimento.

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

2. Instale a extensão pelo ID.

   azd extension install contoso.azd.tagger
   

3. Execute um comando para confirmar se a extensão funciona.

   azd tagger show
   

Publicar no registro oficial

Para publicar no registro oficial, envie sua extensão ao azure/azure-dev repositório:

1. Faça um fork do repositório azure/azure-dev.
2. Adicione a entrada de registro da sua extensão ao arquivo de registro oficial no seu fork.
3. Envie uma solicitação de pull para revisão.

A equipe do Azure Developer CLI analisa as submissões ao registro oficial quanto à qualidade e à segurança antes de serem incorporadas.

Solucionar problemas de publicação

A tabela a seguir lista problemas comuns de publicação e suas resoluções:

Conteúdo relacionado

• Definir o manifesto da extensão
• Adicionar recursos de extensão
• Comunicar-se com o azd usando o SDK
• Referência do framework de extensões