Criando e compartilhando um marketplace de plug-in no GitHub

Publique um GitHubmarketplace hospedado para que as pessoas possam descobrir e instalar plug-ins em clientes Copilot compatíveis.

Neste artigo

Os Marketplaces distribuem plug-ins para clientes Copilot compatíveis. Eles podem ser hospedados em GitHub um repositório, em outro host Git ou em um diretório local. Este artigo descreve como publicar um marketplace em um repositório GitHub. Para obter uma visão geral, consulte Plug-ins para GitHub Copilot.

Antes de começar

  • Crie um ou mais plug-ins que funcionem nos aplicativos cliente em que as pessoas os usarão. Para obter diretrizes de GitHub Copilot CLI formatação e criação, consulte Criando um plug-in para GitHub Copilot CLI.
  • Para obter diretrizes de Visual Studio Code formatação e criação, consulte a referência de criação do Agent Plugins.
  • Escolha um nome estável do marketplace em kebab-case, como engineering-tools. Os identificadores de plug-in incluem esse nome, portanto, alterá-lo altera o identificador que as pessoas usam em configurações e comandos.

Criar o repositório do marketplace

Crie um repositório para o marketplace. Você pode começar com o modelo inicial do marketplace de plug-in e seguir seu README para instalar suas dependências de desenvolvimento e definir o nome do marketplace ou criar os arquivos por conta própria. Se você usar o modelo, remova quaisquer plug-ins de exemplo que não deseja compartilhar.

  1. Adicionar um marketplace.json arquivo de catálogo a .github/plugin/.
  2. Adicione cada diretório de plug-in no caminho indicado no campo source. Por exemplo, se a origem for ./plugins/frontend-design, adicione o diretório frontend-design em plugins/ no repositório.
  3. Adicione um valor estável em kebab-case para o name do marketplace.
  4. Atualizar .github/CODEOWNERS, instruções de contribuição e modelos de issues e pull requests para corresponder à forma como você deseja manter o marketplace.
  5. Se você usar o modelo inicial, siga seu README para executar npm run verify. O template descreve esse comando como verificação do catálogo, manifestos, testes e cobertura de avaliação. Mantenha seu .github/workflows/validate.yml fluxo de trabalho habilitado para executar verificações sem modelo em pull requests e pushes. Verifique o README atual e o fluxo de trabalho porque as verificações de modelo podem ser alteradas.

O arquivo marketplace.json é o catálogo obrigatório do marketplace. Ele fornece os metadados do marketplace e lista os plug-ins. O campo de nível plugins superior é uma matriz de entradas de plug-in com metadados, como nome, descrição, versão e origem de cada plug-in. Para ver um catálogo de exemplo, consulte marketplace.json em github/awesome-copilot.

Para campos de catálogo com suporte e outros locais de arquivos do marketplace, consulte Referência de plug-in e marketplace.

Examinar e manter o marketplace

Revisar alterações no plugin como infraestrutura compartilhada de agentes. Teste o comportamento do plug-in antes de publicar atualizações e mantenha as avaliações no contexto que se destinam a avaliar. Examine as entradas do catálogo e os códigos-fonte dos plug-ins ao atualizar o repositório.

Compartilhar o marketplace

As pessoas que adicionam o marketplace ou recebem seus plug-ins precisam de acesso de leitura ao repositório e devem estar conectadas a GitHub em seu cliente. Para um marketplace privado, hospede-o em sua organização e conceda aos usuários acesso a ele. A associação da organização por si só não garante o acesso a um repositório privado.

Depois de publicar o repositório, compartilhe sua URL com pessoas que precisam adicioná-lo a um cliente. Você também pode disponibilizar plug-ins por meio de configurações compartilhadas:

Leitura adicional