Поделиться через


Разработка нового кода и документации

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

Рекомендации по разработке git/GitHub выходят за рамки этой документации, но дополнительные материалы можно найти здесь.

Новый код

Отправка запроса на включение внесенных изменений

Любой запрос на включение внесенных изменений должен включать ручной запуск с помощью конвейера сборки CI. Конвейер активируется путем добавления комментария в поле запроса. Следующая команда активирует полную сборку:

/azp run

Если известно, что изменения полностью ограничены либо кодом, либо документацией, то может выполняться только эта сторона сборки. Например, чтобы проверить только изменения кода:

/azp run wlt_ci

Или чтобы проверить только изменения документации:

/azp run wlt_docs

Однако следует помнить, что даже изменения, ограниченные файлами кода (CS), могут привести к изменениям документации. Всегда безопаснее выполнять полную сборку.

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

проверка кода;

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

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

Публикация нового выпуска

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

Продукт предоставляется через два канала:

  1. через репозиторий GitHub с открытым исходным кодом, помеченный как используемый для фиксаций проверенных выпусков;
  2. через опубликованные файлы .unitypackage.

Оба канала доступны на странице выпусков GitHub WLTU.

Сборка пакетов Unity

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

  1. Сначала перейдите на страницу конвейера сборки. Убедитесь, что выбрано значение "wlt_ci".

  2. Выберите сборку, соответствующую фиксации, которая будет основой для выпуска.

    Выберите сборку

  3. Этот выбор приводит к следующему экрану, из которого можно получить доступ к артефактам сборки.*

    Поиск артефактов сборки

  4. Выберите пакеты Unity.

    Использование пакетов Unity

  5. Затем загрузите как ZIP-архив.

    Скачать пакеты Unity в виде zip-файла

  6. После установки и проверки пакетов их можно интегрировать в новый выпуск.

Создание выпуска

Обновление поля версии в коде

Обновите поле WorldLockingManager.Version, чтобы оно правильно указывало на новую версию.

Создание ветви выпуска

Например, создайте ветвь с именем "release/v0.3.6-alpha". Несмотря на избыточное использование с тегом, эта ветвь будет способствовать применению исправлений в выпуске, что не подходит для основной ветви разработки "master".

Публикация выпуска

Перейдите на страницу выпусков World Locking Tools для Unity.

Нажмите кнопку Create a new release (Создать новый выпуск).

Укажите тег. Тег должен иметь форму vX.Y.Z[-модификатор-предварительного-выпуска]. X, Y и Z этого тега представляют собой три целых числа, которые должны соответствовать версии, указанной в поле WorldLockingManager.Version. Эти номера должны также соответствовать имени ветви выпуска.

Укажите созданную выше ветвь выпуска в качестве целевого объекта.

Заполните поля названия и описания соответствующим образом.

Перетащите созданные выше файлы .unitypackage в прямоугольник с меткой Attach binaries by dropping them here or selecting them (Вложите двоичные файлы, перетащив их сюда или выбрав их).

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

После успешной отправки файлов .unitypackage нажмите кнопку Publish Release (Опубликовать выпуск).

Убедитесь, что на странице выпусков вся информация выглядит правильно.