Расширения для упаковки и публикации

Статья
03/25/2024

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

После разработки расширения можно упаковать и опубликовать его в Visual Studio Marketplace. Marketplace — это глобальный репозиторий для частных и общедоступных расширений, интеграции и других предложений корпорации Майкрософт.

Примечание.

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

Необходимые компоненты

Перед публикацией в Marketplace необходимо выполнить следующий список требований.

Установите средство упаковки расширений (TFX). Запустите npm install -g tfx-cli из командной строки.
Убедитесь, что необходимые разрешения предоставляются для использования изображений, например значков, логотипов, снимков экрана и т. д.
Добавьте подробный overview.md файл, чтобы описать список в Marketplace.
Добавьте значок расширения, размер которого составляет не менее 128x128 пикселей.
Если вы ссылаетесь на продукты Майкрософт, используйте полные имена вместо аббревиаций, например Azure DevOps и AzDO или любую другую аббревиацию.
Воздерживайтесь от использования фирменной марки в имени вашего расширения.

Создание издателя

Все расширения и интеграции, включая расширения от Корпорации Майкрософт, имеют издателя. Любой пользователь может создать издателя и опубликовать в нем расширения. Вы также можете предоставить другим пользователям доступ к издателю, если команда разрабатывает расширение.

Пользователь владеет издателем, как правило, пользователем, создавшим его. Вы также можете поделиться издателем с другими пользователями.

Войдите на портал публикации Visual Studio Marketplace.
Если вы еще не являетесь членом существующего издателя, и создайте издателя. Введите имя в поле имени издателя. Поле идентификатора должно автоматически задаваться в зависимости от введенного имени.

Примечание.

Запишите идентификатор, так как его необходимо задать в файле манифеста расширения.

Если вам не предлагается создать издателя, прокрутите вниз до нижней части страницы и выберите "Опубликовать расширения" под связанными сайтами.
- Укажите идентификатор издателя, например: mycompany-myteam Этот идентификатор используется в качестве значения атрибута в файле манифеста publisher расширения.
- Укажите отображаемое имя издателя, например: My Team
Просмотрите соглашение издателя Marketplace и нажмите кнопку "Создать".

После создания издателя вы будете перенаправлены для управления элементами, но нет элементов.

Упаковка расширения

Чтобы отправить расширение, необходимо упаковать его как VSIX 2.0-совместимый vsix-файл. Корпорация Майкрософт предоставляет кроссплатформенный интерфейс командной строки (CLI) для упаковки и публикации расширения.

Откройте файл манифеста расширения (vss-extension.json) и задайте для publisher поля идентификатор издателя. Например:
```
{
    ...
    "id": "my-first-extension",
    "publisher": "AnnetteNielsen",
    ...
}
```
В командной строке выполните команду упаковки средства TFX из каталога расширений.
```
npx tfx-cli extension create
```
Появится сообщение, указывающее, что расширение успешно упаковано:
```
=== Completed operation: create extension ===
- VSIX: C:\my-first-extension\AnnetteNielsen.my-first-extension-1.0.0.vsix
- Extension ID: my-first-extension
- Extension Version: 1.0.0
- Publisher: AnnetteNielsen
```

Примечание.

При каждом обновлении необходимо увеличить версию расширения или интеграции.
Если вы не добавили расширение или интеграцию в манифесте, передайте переключатель командной --rev-version строки. Это увеличивает номер версии исправления расширения и сохраняет новую версию в манифесте.

Проверка размера пакета

Проверьте размер vsix после его упаковки. Если это больше 50 МБ, необходимо оптимизировать его. Для этого ознакомьтесь со следующими рекомендациями.

Дедупликация общих зависимостей( если таковые имеются), указав их один раз в пакете расширения.
Извлеките вещи во время выполнения или во время установки, а не предоставляйте его в пакете. Рекомендуется использовать библиотеку установщика инструментов для извлечения зависимостей инструментов во время выполнения. Использование lib предоставляет преимущества, в которых средство кэшировано по версии, поэтому для частных агентов оно не загружает каждую сборку. Мы сделали его lib, чтобы его можно было использовать вне задач установщика инструментов. Но задача не работает в отключенных сценариях (нет Интернета), которые должны находиться в описании или документации для задачи.
У некоторых пользователей есть успех с WebPack, чтобы встряхнуть их зависимости в своих задачах.

Публикация расширения

После упаковки расширения его можно отправить в Marketplace под издателем. Идентификатор publisher , указанный в файле манифеста расширения, должен соответствовать идентификатору издателя, в котором отправляется расширение.

На портале управления выберите издателя в раскрывающемся меню в верхней части страницы.
Выберите новое расширение>Azure DevOps.
Перетащите файл или выберите его, чтобы найти файл VSIX, созданный на предыдущем шаге упаковки, а затем нажмите кнопку "Отправить".

После быстрой проверки расширение появится в списке опубликованных расширений. Не беспокойтесь, расширение видно только вам.

На этом этапе расширение не отображается для учетных записей и не может быть установлено до тех пор, пока вы не поделились им.

Примечание.

Корпорация Майкрософт выполняет проверку вирусов на каждом новом и обновленном пакете расширения, опубликованном. Пока проверка не будет ясно, мы не публикуем расширение в Marketplace для общедоступного использования. Таким образом, мы также избегаем неуместных или оскорбительных содержимого на страницах Marketplace.

Чтобы установить его в Azure DevOps, необходимо предоставить общий доступ к расширению организации. Чтобы предоставить общий доступ к расширению, выполните следующие задачи:

На портале управления Marketplace выберите расширение из списка, щелкните правой кнопкой мыши и выберите "Общий доступ", "Отменить общий доступ" или "Опубликовать" или "Отменить публикацию" в зависимости от расширения.
Выберите организацию и введите имя вашей организации. Выберите ВВОД.
Закройте панель.

Теперь расширение можно установить в этой организации.

Установка расширения

Чтобы установить общее расширение, выполните следующие действия.

В Marketplace выберите расширение, чтобы открыть страницу обзора.

Примечание.

Так как расширение является частным, вы и любой член организации, к которой он предоставлен, может видеть эту страницу.
Выберите " Получить бесплатно ", чтобы запустить процесс установки. Выберите организацию, с которой вы предоставили общий доступ к расширению в раскрывающемся меню.
Выберите Установить.

Поздравляем! Вы установили расширение в организацию, и вы готовы попробовать его.

Попробуйте расширение

Выберите "Перейти к организации " в конце мастера установки, чтобы перейти на домашнюю страницу организации, в которую было установлено расширение (https://dev.azure.com/{organization}).
Обновите свой браузер.
Откройте параметры организации и выберите "Расширения".

На вкладке "Установленные" должно появиться новое расширение.

Отладка расширения

Чтобы отладить расширение с помощью Средств разработчика Visual Studio или Browser, измените манифест, добавив baseUri это свойство. Это действие ускоряет разработку без необходимости повторного развертывания расширения при каждом изменении исходного кода.

{
    ...
    "baseUri": "https://localhost:44300",
    ...
}

При изменении манифеста он загружает расширение из локального экземпляра веб-сервера. Например, IISExpress в Visual Studio. После изменения манифеста разверните и установите это расширение отладки только один раз.

Примечание.

Запустите локальный веб-сервер в режиме SSL, так как Azure DevOps требует от безопасного источника веб-страницы. В противном случае во время загрузки IFRAME расширения в консоли браузера возникает ошибка.

Обновление расширения

Чтобы изменить уже опубликованное расширение, обновите его.

Совет

Рекомендуется обновить расширение при удалении и повторной отправке. Мы также рекомендуем использовать два расширения, напримерpublisher.extension.publisher.extension-dev Publisher.extension является общедоступным в Marketplace, где клиенты могут установить его в своих организациях Azure DevOps. Publisher.extension-dev хранится в закрытом режиме в Marketplace и может быть предоставлен общий доступ к организации, которой вы владеете и управляете. Вам не нужно поддерживать две копии исходного кода расширения. Вы можете поддерживать два файла манифеста — по одному для каждого расширения и во время упаковки расширения можно предоставить соответствующий файл манифеста средству tfx-cli. Дополнительные сведения о аргументах, необходимых для средства, см. в командах расширения TFX.

Выберите расширение из списка отображаемых элементов.
Щелкните правой кнопкой мыши и выберите пункт "Обновить " для publisher.extension-devпримера.
Проверьте расширение.
Например, publisher.extensionвнесите те же обновления в рабочую версию.
Перейдите к VSIX для расширения и отправьте его.

Обновленная версия расширения автоматически устанавливается в учетные записи, которые уже установлены. Новые учетные записи, в которых расширение установлено в будущем, также получают последнюю версию.

Сделать расширение общедоступным

При разработке расширения или интеграции для Marketplace сохраните его в закрытом режиме. Чтобы сделать расширение доступным общедоступным, задайте общедоступный флагtrue в манифесте.

Профессиональные требования

Чтобы иметь общедоступный список в Marketplace, интеграция или расширение должны соответствовать следующим квалификациям:

Работает с Azure DevOps или расширяет его.
Вы или ваша компания, владеете, разрабатываете и лицензируете распространение и объявление интеграции или расширения.
Расширение или интеграция активно поддерживается.

Корпорация Майкрософт также может запросить демонстрацию и просмотреть содержимое, запланированное для вашей записи Marketplace.

Лучший издатель

Программа Top Publisher доступна только для издателей с расширениями или интеграции Azure DevOps. Это не применимо для издателей расширений Visual Studio IDE и Visual Studio Code.

Снимок экрана: значок верхнего издателя.

Программа Top Publisher распознает издателей с приверженностью своим клиентам и Marketplace с помощью примерных политик, качества, надежности и поддержки. После того как вы станете лучшим издателем, все общедоступные предложения отображают значок Top Publisher.

Основные требования к издателю

Программа Top Publisher в Marketplace предназначена для оценки или получения расширений и интеграции Azure DevOps с уверенностью. Значок "Лучший издатель" подразумевает, что издатель проявляет приверженность своим клиентам и Marketplace с помощью примерных политик, качества, надежности и поддержки. Это для издателей с одним или несколькими глобальными расширениями Или интеграции Azure DevOps и не применяется для издателей расширений Visual Studio IDE и Visual Studio Code.

Marketplace назначает издателю значок после тщательной проверки издателя в следующих параметрах:

Политика конфиденциальности
Политика лицензирования
Политика поддержки
Документация
Скорость реагирования на вопросы и ответы
Оценки и рецензирование для своих предложений
Активное получение и количество установок для своих предложений
Управление по крайней мере одним общедоступным расширением Azure DevOps от издателя.
Общедоступное расширение должно иметь более 5000 установок, при этом активное число установок превышает 1000.

Вы можете ожидать своевременной поддержки и хороший общий опыт при получении расширения от верхнего издателя. Ознакомьтесь с предложениями из лучших издателей.

Дополнительные сведения о добавлении политик в предложение см. в манифесте расширения.

Обновите профиль издателя.

С помощью профиля издателя вы можете продемонстрировать все предложения в одном месте вместе с информацией, связанной с ключевым издателем. Чтобы предоставить сведения, которые отображаются в профиле, сделайте следующее:

a. Войдите в https://marketplace.visualstudio.com/manage/publishers учетную запись, с помощью которой вы публикуете предложения и управляете ими в Visual Studio Marketplace.

b. Выберите издателя и заполните раздел "О вас " на вкладке "Сведения ". В. Сохраните изменения и выберите "Просмотреть профиль ", чтобы узнать, как он отображается для потребителей. Эту страницу профиля можно использовать для евангелизации предложений.

Примечание.

С помощью этой программы это издатель, который сертифицирован. Это не охватывает программное обеспечение или безопасность своих расширений и интеграции. Мы рекомендуем учитывать сведения о безопасности при оценке предложений издателя.

Если вы получили расширение от верхнего издателя и не удовлетворены вашим опытом, рассмотрите возможность взаимодействия с издателем в первую очередь. После этого, если вы все еще не удовлетворены, обратитесь в группу Marketplace.

Применение к началу издателя

Войдите в https://marketplace.visualstudio.com/manage/publishers систему с помощью учетной записи, с помощью которой вы публикуете предложения и управляете ими в Marketplace
Выберите издателя и перейдите на вкладку "Лучший издатель ". Обратите внимание, что необходимо иметь одно или несколько глобальных расширений Azure DevOps (server/Service) или интеграцию для отображения вкладки.
Если вы соответствуете ранее перечисленным требованиям и являетесь владельцем издателя, вы увидите возможность подать заявку на программу. В приложении сообщение электронной почты отправляется группе Marketplace для просмотра вашего дела. Они отвечают в течение 10 рабочих дней с помощью следующих шагов, уточняя вопросы или предоставление значка.

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

После того как издатель является лучшим издателем, все будущие обновления и предложения должны соответствовать ранее перечисленным требованиям.

Ответ на отзывы о расширении Marketplace

Вы можете ответить на отзывы о том, что клиенты покидают расширения в Visual Studio Marketplace. Найдите и выберите ответ рядом с проверкой, если у вас есть одно из следующих разрешений: владелец, создатель или участник.

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

Запрос на отмену проверки

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

Отмена публикации расширения

Вы можете отменить публикацию бесплатных расширений, если вы больше не хотите предлагать их в Marketplace.

В следующих сценариях описано, когда может потребоваться удалить расширение из Marketplace:

Вы разработали другое расширение и больше не хотите предлагать текущую.
Расширение имеет проблему, поэтому вы хотите удалить расширение из Marketplace, пока не устраните проблему.
Вы опубликовали расширение как общедоступное по ошибке.

Для отмены публикации или удаления расширения необходимо выполнить определенные условия:

Действие	Требования
Отменить публикацию	Можно отменить публикацию только бесплатных расширений .
Удалить	Для удаления расширения должно быть установлено ноль (0 ).

Внимание

Если вы должны удалить расширение из-за юридических или проблем безопасности, обратитесь к группе Marketplace. Мы просматриваем запрос и вручную удаляем расширение.

Выберите расширение на странице издателя и выберите "Отменить публикацию " в меню.

Расширение не опубликовано сразу из Marketplace, и новые пользователи не могут установить его. Оценки и отзывы о расширении остаются неизменными.

Чтобы снова предложить расширение в Marketplace, выберите " Опубликовать " в меню.

Вы также можете полностью удалить расширение из Marketplace, если расширение имеет нулевое (0) установки. Для этого нажмите кнопку "Удалить " в меню. Это действие невозможно отменить.

Расширения для упаковки и публикации

Необходимые компоненты

Создание издателя