Настройка автоматических сборок для приложения UWP
С помощью Azure Pipelines можно создавать автоматизированные сборки для проектов UWP. В этой статье мы рассмотрим различные способы, позволяющие это сделать. Мы также покажем, как выполнить эти задачи с помощью командной строки, чтобы взаимодействовать с другими системами сборки.
Создание конвейера Azure
Зарегистрируйтесь в Azure Pipelines, если вы этого еще не сделали.
Затем создайте конвейер, который можно использовать для сборки исходного кода. Учебник по созданию конвейера для создания репозитория GitHub см. в статье Create your first pipeline (Создание первого конвейера). Предложение Azure Pipelines поддерживает типы репозиториев, перечисленные в этой статье.
Настройка автоматической сборки
Начнем с определения сборки UWP по умолчанию, которое предоставляется в Azure Dev Ops, а затем перейдем к настройке конвейера.
В списке шаблонов определений сборки выберите шаблон универсальная платформа Windows.
Этот шаблон содержит базовую конфигурацию для сборки проекта UWP:
trigger:
- master
pool:
vmImage: 'windows-latest'
variables:
solution: '**/*.sln'
buildPlatform: 'x86|x64|ARM'
buildConfiguration: 'Release'
appxPackageDir: '$(build.artifactStagingDirectory)\AppxPackages\\'
steps:
- task: NuGetToolInstaller@1
- task: NuGetCommand@2
inputs:
restoreSolution: '$(solution)'
- task: VSBuild@1
inputs:
platform: 'x86'
solution: '$(solution)'
configuration: '$(buildConfiguration)'
msbuildArgs: '/p:AppxBundlePlatforms="$(buildPlatform)" /p:AppxPackageDir="$(appxPackageDir)" /p:AppxBundle=Always /p:UapAppxPackageBuildMode=StoreUpload'
Шаблон по умолчанию пытается подписать пакет сертификатом, который указан в CSPROJ-файле. Если вы хотите подписать пакет во время сборки, вам потребуется доступ к закрытому ключу. В противном случае подписывание можно отключить, добавив параметр /p:AppxPackageSigningEnabled=false в раздел msbuildArgs YAML-файла.
Добавление сертификата проекта в библиотеку защищенных файлов
Не следует отправлять сертификаты в репозиторий, если это возможно. По умолчанию GIT игнорирует их. Для управления безопасной обработкой конфиденциальных файлов, таких как сертификаты, Azure DevOps поддерживает функцию защищенных файлов.
Чтобы отправить сертификат для автоматизированной сборки, выполните следующие действия.
В Azure Pipelines разверните узел Конвейеры в области навигации и щелкните элемент Библиотека.
Перейдите на вкладку Защищенные файлы и щелкните + Secure file (+ Защищенный файл).
Перейдите к файлу сертификата и нажмите кнопку ОК.
После отправки сертификата выберите его и просмотрите его свойства. В разделе Разрешения конвейера включите переключатель Авторизовать использование во всех конвейерах.
Если у закрытого ключа в сертификате есть пароль, рекомендуется сохранить пароль в Azure Key Vault, а затем связать пароль с группой переменных. Для доступа к паролю из конвейера можно использовать переменную. Обратите внимание, что пароль поддерживается только для закрытого ключа. Использование файла сертификата, защищенного паролем, сейчас не поддерживается.
Примечание.
Начиная с Visual Studio 2019 временный сертификат больше не создается в проектах UWP. Чтобы создать или экспортировать сертификаты, используйте командлеты PowerShell, описанные в этой статье.
Настройка задачи сборки решения
Эта задача компилирует в двоичные файлы все решения, размещенные в рабочей папке, и создает выходной файл пакета приложения. Эта задача использует аргументы MSBuild. Вам необходимо указать значение этих аргументов. Используйте следующую таблицу для справки.
| Аргумент MSBuild | Стоимость | Description |
|---|---|---|
| AppxPackageDir | $(Build.ArtifactStagingDirectory)\AppxPackages | Определяет папку для хранения созданных артефактов. |
| AppxBundlePlatforms | $(Build.BuildPlatform) | Позволяет указать платформы, в которые будет включен пакет. |
| Appxbundle | Всегда | Создает объединенный пакет MSIXBUNDLE или APPXBUNDLE с файлами MSIX или APPX для указанной платформы. |
| UapAppxPackageBuildMode | StoreUpload | Создает файл MSIXBUNDLE или APPXBUNDLE и папку _Test для загрузки неопубликованных приложений. |
| UapAppxPackageBuildMode | CI | Создает только файл MSIXBUNDLE или APPXBUNDLE. |
| UapAppxPackageBuildMode | SideloadOnly | Создает папку _Test только для загрузки неопубликованных приложений. |
| AppxPackageSigningEnabled | true | Включает подписывание пакетов. |
| PackageCertificateThumbprint | Отпечаток сертификата | Это значение должно соответствовать отпечатку в сертификате для подписи, или строка должна быть пустой. |
| PackageCertificateKeyFile | Путь | Путь к файлу сертификата. Это значение извлекается из метаданных защищенного файла. |
| PackageCertificatePassword | Password | Пароль для закрытого ключа в сертификате. Рекомендуется сохранить пароль в Azure Key Vault и связать пароль с группой переменных. Можно передать переменную в этот аргумент. |
Настройка сборки
Если вы хотите выполнить сборку решения из командной строки или с помощью другой системы сборки, запустите MSBuild с этими аргументами.
/p:AppxPackageDir="$(Build.ArtifactStagingDirectory)\AppxPackages\\"
/p:UapAppxPackageBuildMode=StoreUpload
/p:AppxBundlePlatforms="$(Build.BuildPlatform)"
/p:AppxBundle=Always
Настройка подписывания пакета
Чтобы подписать пакет MSIX (или APPX), конвейеру необходимо получить сертификат для подписи. Для этого добавьте задачу DownloadSecureFile перед задачей VSBuild.
Это обеспечит доступ к сертификату для подписи с помощью signingCert.
- task: DownloadSecureFile@1
name: signingCert
displayName: 'Download CA certificate'
inputs:
secureFile: '[Your_Pfx].pfx'
Затем обновите задачу VSBuild, чтобы она ссылалась на сертификат для подписи:
- task: VSBuild@1
inputs:
platform: 'x86'
solution: '$(solution)'
configuration: '$(buildConfiguration)'
msbuildArgs: '/p:AppxBundlePlatforms="$(buildPlatform)"
/p:AppxPackageDir="$(appxPackageDir)"
/p:AppxBundle=Always
/p:UapAppxPackageBuildMode=StoreUpload
/p:AppxPackageSigningEnabled=true
/p:PackageCertificateThumbprint=""
/p:PackageCertificateKeyFile="$(signingCert.secureFilePath)"'
Примечание.
В качестве меры предосторожности для аргумента PackageCertificateThumbprint намеренно задана пустая строка. Если отпечаток задан в проекте, но не соответствует сертификату для подписи, сборка завершится ошибкой: Certificate does not match supplied signing thumbprint.
Проверка параметров
Параметры, определенные с использованием синтаксиса $() — это переменные, заданные в определении сборки, которые меняются в других системах сборки.
Все предопределенные переменные см. в статье Use predefined variables (Предварительно заданные переменные сборки).
Настройка задачи публикации артефактов сборки
Конвейер UWP по умолчанию не сохраняет созданные артефакты. Чтобы добавить возможность публикации в определение YAML, добавьте следующие задачи.
- task: CopyFiles@2
displayName: 'Copy Files to: $(build.artifactstagingdirectory)'
inputs:
SourceFolder: '$(system.defaultworkingdirectory)'
Contents: '**\bin\$(BuildConfiguration)\**'
TargetFolder: '$(build.artifactstagingdirectory)'
- task: PublishBuildArtifacts@1
displayName: 'Publish Artifact: drop'
inputs:
PathtoPublish: '$(build.artifactstagingdirectory)'
Созданные артефакты можно просмотреть в параметре Артефакты на странице результатов сборки.
Так как мы присвоили аргументу UapAppxPackageBuildMode значение StoreUpload, папка артефактов содержит пакет для отправки в Store (.msixupload/.appxupload). Обратите внимание, что в Store можно также отправить стандартный пакет приложения (.msix/appx) или пакет приложений (.msixbundle/.appxbundle/). В этой статье мы будем использовать файл .appxupload.
Устранение ошибок в пакете приложений
Если добавить в решение несколько проектов UWP и попробовать создать пакет, может возникнуть следующая ошибка:
MakeAppx(0,0): Error : Error info: error 80080204: The package with file name "AppOne.UnitTests_0.1.2595.0_x86.appx" and package full name "8ef641d1-4557-4e33-957f-6895b122f1e6_0.1.2595.0_x86__scrj5wvaadcy6" is not valid in the bundle because it has a different package family name than other packages in the bundle
Эта ошибка возникает, поскольку на уровне решения неясно, какое приложение должно быть в пакете. Чтобы решить эту проблему, откройте каждый файл проекта и добавьте следующие свойства в конец первого элемента <PropertyGroup>.
| Проект | Свойства |
|---|---|
| App | <AppxBundle>Always</AppxBundle> |
| UnitTests | <AppxBundle>Never</AppxBundle> |
Затем удалите аргумент MSBuild AppxBundle из этапа сборки.
См. также
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по