Skip to main content
Skip to content

Создание и совместное использование подключаемого модуля Marketplace на GitHub

Опубликуйте размещенную в Marketplace платформу GitHub, чтобы пользователи могли обнаруживать и устанавливать подключаемые модули в поддерживаемых Copilot клиентах.

Marketplace распространяет подключаемые модули для поддерживаемых Copilot клиентов. Их можно разместить в GitHub репозитории, другом узле Git или локальном каталоге. В этой статье описывается публикация Marketplace в репозитории GitHub . Общие сведения см. в разделе Подключаемые модули для GitHub Copilot.

Перед началом

  • Создайте один или несколько подключаемых модулей, которые работают в клиентах, где люди будут использовать их. Инструкции GitHub Copilot CLI по форматированию и разработке см. в разделе Создание плагина для GitHub Copilot CLI.
  • Рекомендации Visual Studio Code по форматированию и разработке см. в справочнике по разработке подключаемых модулей агента.
  • Выберите стабильное, kebab-case marketplace имя, например engineering-tools. Идентификаторы подключаемого модуля включают это имя, поэтому изменение идентификатора людей, используемых в параметрах и командах.

Создание репозитория Marketplace

Создайте репозиторий для Marketplace. Вы можете начать с шаблона начального модуля Marketplace marketplace и следовать его README, чтобы установить зависимости разработки и задать имя Marketplace или создать файлы самостоятельно. Если вы используете шаблон, удалите все примеры подключаемых модулей, которыми вы не хотите предоставлять общий доступ.

  1. marketplace.json Добавьте файл .github/plugin/каталога в .
  2. Добавьте каждый каталог подключаемого модуля в путь, указанный его source полем. Например, если источник является ./plugins/frontend-design, добавьте frontend-design каталог plugins/ в репозиторий.
  3. Добавьте стабильное значение кебаб-регистра для marketplace name.
  4. Обновите .github/CODEOWNERS, инструкции по вкладу и шаблоны запросов на вытягивание, чтобы соответствовать тому, как вы хотите поддерживать Marketplace.
  5. Если вы используете начальный шаблон, следуйте инструкциям README для запуска npm run verify. Шаблон описывает эту команду как проверку каталога, манифестов, тестов и покрытия оценки. Сохраните рабочий .github/workflows/validate.yml процесс, чтобы запустить бесплатные проверки на запросы на вытягивание и отправки. Проверьте текущий рабочий процесс README и рабочий процесс, так как проверки шаблона могут измениться.

Файл marketplace.json является обязательным каталогом Marketplace. Он предоставляет метаданные Marketplace и перечисляет подключаемые модули. Поле верхнего уровня plugins — это массив записей подключаемого модуля с метаданными, такими как имя каждого подключаемого модуля, описание, версия и источник. Пример каталога см marketplace.json . в github/awesome-copilotразделе .

Поддерживаемые поля каталога и другие расположения файлов Marketplace см. в разделе Справочник по подключаемым модулям и Marketplace.

Проверка и обслуживание Marketplace

Просмотрите изменения подключаемого модуля как инфраструктуру общего агента. Протестируйте поведение подключаемого модуля перед публикацией обновлений и сохраняйте оценки с контекстом, который они предназначены для оценки. Просмотрите записи каталога и источники подключаемых модулей при обновлении репозитория.

Общий доступ к Marketplace

Пользователи, которые добавляют Marketplace или получают его подключаемые модули, нуждаются в доступе на чтение к репозиторию и должны войти в GitHub свой клиент. Для частной платформы разместите его в организации и предоставьте пользователям доступ. Членство в организации не гарантирует доступ к частному репозиторию.

После публикации репозитория поделитесь СВОИМ URL-адресом с людьми, которым нужно добавить его в клиент. Вы также можете сделать подключаемые модули доступными с помощью общих параметров:

  • Для личного использования добавьте Marketplace в клиент, где вы хотите использовать его подключаемые модули. Инструкции клиента см. в разделе Использование подключаемых модулей в Visual Studio Code, AUTOTITLE или AUTOTITLE.
  • Для репозитория объявляйте marketplace и подключаемые .github/copilot/settings.jsonмодули по умолчанию. Участники могут переопределить репозиторий по умолчанию локально в поддерживаемых поверхностях. Copilot in the cloud использует эти параметры репозитория и не имеет локального переопределения. См . раздел AUTOTITLE.
  • Для корпоративных требований используйте управляемые параметры, чтобы сделать Marketplace доступными и требовать или блокировать подключаемые модули. См . раздел AUTOTITLE.

Дополнительные материалы