Skip to main content
Skip to content

Creación y uso compartido de un marketplace de complementos en GitHub

Publique un GitHubmarketplace hospedado para que los usuarios puedan descubrir e instalar complementos en clientes compatibles Copilot.

Los mercados distribuyen complementos para clientes admitidos Copilot. Se pueden hospedar en un GitHub repositorio, en otro host de Git o en un directorio local. En este artículo se describe cómo publicar un marketplace en un GitHub repositorio. Para obtener información general, consulte Complementos para GitHub Copilot.

Antes de empezar

  • Cree uno o varios complementos que funcionen en los clientes donde los usuarios los usarán. Para obtener instrucciones sobre GitHub Copilot CLI formato y creación de contenido, consulte Creación de un complemento para GitHub Copilot CLI.
  • Para obtener instrucciones sobre Visual Studio Code el formato y la creación, consulte la referencia de creación de Agent Plugins.
  • Elija un nombre de marketplace estable, kebab-case, como engineering-tools. Los identificadores de complemento incluyen este nombre, por lo que cambiarlo cambia el identificador que usan los usuarios en la configuración y los comandos.

Crear el repositorio de Marketplace

Cree un repositorio para el marketplace. Puede empezar con la plantilla de inicio del mercado de complementos y seguir su LÉAME para instalar sus dependencias de desarrollo y establecer el nombre del mercado, o crear los archivos usted mismo. Si usa la plantilla, quite los complementos de ejemplo que no quiera compartir.

  1. Agregue un marketplace.json archivo de catálogo a .github/plugin/.
  2. Agregue cada directorio del complemento en la ruta de acceso enumerada por su source campo. Por ejemplo, si el origen es ./plugins/frontend-design, agregue el directorio frontend-design debajo de plugins/ en el repositorio.
  3. Agregue un valor estable en kebab-case para el name del marketplace.
  4. Actualice .github/CODEOWNERS, las instrucciones de contribución y las plantillas de incidencias y de solicitudes de extracción para que coincidan con la forma en que desea mantener Marketplace.
  5. Si usa la plantilla de inicio, siga su README para ejecutar npm run verify. La plantilla describe este comando como comprobar el catálogo, los manifiestos, las pruebas y la cobertura de evaluación. Mantenga habilitado su .github/workflows/validate.yml flujo de trabajo para ejecutar comprobaciones sin modelos en pull requests y pushes. Compruebe el archivo LÉAME y el flujo de trabajo actuales porque las comprobaciones de plantilla pueden cambiar.

El marketplace.json archivo es el catálogo de Marketplace necesario. Proporciona metadatos del Marketplace y enumera complementos. El campo de nivel plugins superior es una matriz de entradas del complemento con metadatos como el nombre, la descripción, la versión y el origen de cada complemento. Para ver un catálogo de ejemplo, consulte marketplace.json en github/awesome-copilot.

Para conocer los campos de catálogo admitidos y otras ubicaciones de archivos de Marketplace, consulte Referencia sobre complementos y la tienda.

Revisar y mantener el marketplace

Revise los cambios del complemento en la infraestructura compartida del agente. Pruebe el comportamiento del complemento antes de publicar actualizaciones y mantenga las evaluaciones con el contexto para el que están pensadas. Revise las entradas del catálogo y las fuentes del complemento al actualizar el repositorio.

Compartir el Marketplace

Las personas que agregan el marketplace o reciben sus complementos necesitan acceso de lectura al repositorio y deben haber iniciado sesión en su cliente en GitHub. Para un marketplace privado, alójelo en su organización y conceda acceso a sus usuarios. La pertenencia a la organización por sí sola no garantiza el acceso a un repositorio privado.

Después de publicar el repositorio, comparta su dirección URL con personas que necesiten agregarla a un cliente. También puede hacer que los complementos estén disponibles a través de la configuración compartida:

Lectura adicional