Publicación de una extensión

Después de compilar una extensión de la CLI para desarrolladores de Azure (azd), empaquete y publíquela en un registro para que otras personas puedan instalarla. En este artículo se muestra cómo publicar la extensión de ejemplo Contoso Resource Tagger desde el inicio rápido Compilación de una extensión de ejemplo. Puede aplicar los mismos pasos a cualquier extensión.

Note

El azd marco de trabajo de extensión está disponible con carácter general. Es posible que las extensiones o funcionalidades individuales tengan su propio estado de vista previa.

Elección de un registro

azd puede resolver extensiones del registro oficial, manifiestos del registro personalizados basados en direcciones URL, manifiestos del registro basados en archivos y archivos de agrupación portátiles. Elija el enfoque de distribución que coincida con la forma en que los usuarios instalan la extensión:

  • Registro oficial: El registro que se suministra con azd. Para publicar aquí, envíe una solicitud de incorporación de cambios a una bifurcación del repositorio azure/azure-dev.
  • Registro basado en direcciones URL personalizadas: un manifiesto del registro remoto que hospeda el equipo para la distribución pública o privada.
  • Registro basado en archivos: un manifiesto del Registro local para el desarrollo, las pruebas, el uso sin conexión o la distribución privada.
  • Registro de desarrollo o nocturno: un registro de participación para las extensiones de trabajo en curso o compiladas automáticamente por primera vez. Las extensiones del registro de desarrollo no están firmadas, no cubiertas por Soporte técnico de Azure y pueden cambiarse o quitarse sin previo aviso.
  • Paquete portátil: un paquete independiente .zip que los usuarios instalan directamente desde una ruta de acceso local o una dirección URL HTTPS sin agregar un origen del registro.

En este artículo se usa el registro de desarrollo para demostrar la publicación en un origen de prueba compartido. Para obtener detalles de resolución de origen y versión, consulte la referencia del marco de extensión.

Prerequisites

  • Una extensión completada del inicio rápido para crear una extensión de ejemplo.
  • La azd extensión para desarrolladores (microsoft.azd.extensions), que proporciona los azd x comandos que se usan para empaquetar y publicar. Si ha completado el inicio rápido, ya está instalado. De lo contrario, ejecute azd extension install microsoft.azd.extensions.
  • Una cuenta de GitHub y un repositorio para alojar los artefactos de la versión.
  • Un token de acceso personal de GitHub (PAT) con el alcance repo. El comando release usa este token para crear GitHub versiones y cargar artefactos. Para obtener más información, consulte Administración de los tokens de acceso personal.

Actualizar la versión y el registro de cambios

Antes de publicar, actualice la versión y documente los cambios:

  1. Actualice la propiedad version en extension.yaml siguiendo el versionado semántico. Incremente el número de versión mayor, menor o de parche según el tipo de cambio.

  2. Actualice CHANGELOG.md con los cambios importantes de esta versión. azd usa el registro de cambios para generar notas de lanzamiento.

Empaquetar la extensión

Use el azd x pack comando para compilar archivos binarios específicos de la plataforma y empaquetar la extensión:

azd x pack

El comando crea artefactos para cada plataforma compatible en el directorio de salida. azd x release carga estos artefactos y azd x publish actualiza los metadatos del Registro. El empaquetado también ejecuta pruebas de instantáneas para comprobar que la extensión se comporta según lo previsto antes de publicar.

Si desea distribuir una extensión directamente en lugar de publicarla a través de un registro, cree una agrupación independiente con azd x pack --bundle. La agrupación es un portátil .zip que contiene los metadatos y artefactos del Registro necesarios para la instalación desde una ruta de acceso de archivo o una dirección URL HTTPS.

Liberar la extensión

Use el azd x release comando para crear una versión de GitHub y cargar los artefactos empaquetados. Proporcione el GitHub PAT para que el comando pueda crear la versión:

azd x release

El comando crea un lanzamiento en tu repositorio de GitHub, sube los archivos binarios empaquetados y genera las notas de la versión a partir de tu registro de cambios. La publicación basada en el Registro usa estos artefactos de versión como paquetes de extensión descargables. La distribución directa del lote no requiere este paso de versión a menos que desee hospedar la agrupación en GitHub.

Tip

Almacene la GitHub PAT en una variable de entorno en lugar de pasarla en la línea de comandos. Consulte la ayuda del comando ejecutando azd x release --help para ver las opciones de autenticación admitidas.

Publicación en el registro

Use el comando para agregar o actualizar la azd x publish entrada de la extensión en el Registro de extensiones:

azd x publish

El comando actualiza los metadatos del Registro para que los usuarios puedan detectar e instalar la extensión desde el registro de desarrollo. Este paso difiere de la publicación local que azd x init realiza en el inicio rápido, que registra la extensión solo en un origen local en el equipo. Al ejecutar azd x publish, se actualiza el registro compartido de desarrollo para que otros usuarios puedan instalar tu extensión.

Instalación y comprobación

Después de publicar, compruebe que otros usuarios pueden instalar la extensión desde el registro de desarrollo:

  1. Asegúrese de haber agregado ya el registro de desarrollo.

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

  2. Instale la extensión mediante su ID.

    azd extension install contoso.azd.tagger

  3. Ejecute un comando para confirmar que la extensión funciona.

    azd tagger show

Publicación en el registro oficial

Para publicar en el registro oficial, envíe la extensión al repositorio azure/azure-dev:

  1. Cree una bifurcación del repositorio azure/azure-dev.
  2. Agregue la entrada de registro de su extensión al archivo oficial del registro en su bifurcación.
  3. Envíe una solicitud de incorporación de cambios para revisión.

El equipo de Azure Developer CLI revisa los envíos al registro oficial para garantizar la calidad y la seguridad antes de fusionarlos.

Solucionar problemas de publicación

En la tabla siguiente se enumeran los problemas comunes de publicación y sus soluciones:

Issue Resolution
La publicación falla por un error de autenticación Compruebe que su PAT de GitHub sea válido y tenga el alcance repo.
Se produce un error en las pruebas de instantánea durante azd x pack Revise la salida de la prueba, actualice sus snapshots si los cambios son los esperados y vuelva a ejecutar el comando.
Los usuarios no pueden encontrar la extensión Confirme que se haya añadido el registro de desarrollo y que azd x publish se haya completado correctamente.
Conflicto de versión durante la publicación Incremente el version en extension.yaml hasta una versión nueva sin usar.

Contenido relacionado

  • Last updated on