diff --git a/azure/mobile/build-xamarin-android.yml b/azure/mobile/build-xamarin-android.yml index ce31318..9e24548 100644 --- a/azure/mobile/build-xamarin-android.yml +++ b/azure/mobile/build-xamarin-android.yml @@ -70,23 +70,23 @@ parameters: type: string default: 'SignedAndroid.aab' -# onStart - Steps to be executed before stage starts +# onStart - (Optional) Steps to be executed before stage starts - name: onStart type: stepList default: [] -# preBuild - Steps to be executed before the build starts +# preBuild - (Optional) Steps to be executed before the build starts - name: preBuild type: stepList default: [] -# postBuild - Steps to be executed after the build has been invoked +# postBuild - (Optional) Steps to be executed after the build has been invoked - name: postBuild type: stepList default: [] -# prePublish - Steps to be executed before application package is published to artifact +# prePublish - (Optional) Steps to be executed before application package is published to artifact - name: prePublish type: stepList default: [] -# onEnd - Steps to be executed at the end of the stage +# onEnd - (Optional) Steps to be executed at the end of the stage - name: onEnd type: stepList default: [] diff --git a/azure/mobile/build-xamarin-ios.yml b/azure/mobile/build-xamarin-ios.yml index f8fd662..1835158 100644 --- a/azure/mobile/build-xamarin-ios.yml +++ b/azure/mobile/build-xamarin-ios.yml @@ -78,23 +78,23 @@ parameters: type: string default: 'SignediOS.ipa' -# onStart - Steps to be executed before stage starts +# onStart - (Optional) Steps to be executed before stage starts - name: onStart type: stepList default: [] -# preBuild - Steps to be executed before the build starts +# preBuild - (Optional) Steps to be executed before the build starts - name: preBuild type: stepList default: [] -# postBuild - Steps to be executed after the build has been invoked +# postBuild - (Optional) Steps to be executed after the build has been invoked - name: postBuild type: stepList default: [] -# prePublish - Steps to be executed before application package is published to artifact +# prePublish - (Optional) Steps to be executed before application package is published to artifact - name: prePublish type: stepList default: [] -# onEnd - Steps to be executed at the end of the stage +# onEnd - (Optional) Steps to be executed at the end of the stage - name: onEnd type: stepList default: [] diff --git a/azure/mobile/build-xamarin-windows.yml b/azure/mobile/build-xamarin-windows.yml index 657f0b3..bd9c2a9 100644 --- a/azure/mobile/build-xamarin-windows.yml +++ b/azure/mobile/build-xamarin-windows.yml @@ -36,7 +36,7 @@ parameters: type: string default: Release # solution_target_platform - (Optional) The target platform that the solution build will use. -# Defaults to Any CPU +# Defaults to 'x86' - name: solution_target_platform type: string default: 'x86' @@ -78,23 +78,23 @@ parameters: type: string default: '' -# onStart - Steps to be executed before stage starts +# onStart - (Optional) Steps to be executed before stage starts - name: onStart type: stepList default: [] -# preBuild - Steps to be executed before the build starts +# preBuild - (Optional) Steps to be executed before the build starts - name: preBuild type: stepList default: [] -# postBuild - Steps to be executed after the build has been invoked +# postBuild - (Optional) Steps to be executed after the build has been invoked - name: postBuild type: stepList default: [] -# prePublish - Steps to be executed before application package is published to artifact +# prePublish - (Optional) Steps to be executed before application package is published to artifact - name: prePublish type: stepList default: [] -# onEnd - Steps to be executed at the end of the stage +# onEnd - (Optional) Steps to be executed at the end of the stage - name: onEnd type: stepList default: [] @@ -103,14 +103,6 @@ parameters: - name: nuget_version type: string default: '4.4.1' -# net_core_version - (Optional) Use to override the .NET Core version (defaults to 3.0.x) -- name: net_core_version - type: string - default: '3.0.x' -# xamarin_sdk_version - (Optional) Use to override the Xamarin SDK version (defaults to 6.4.0) -- name: xamarin_sdk_version - type: string - default: '6_4_0' stages: - stage: ${{ parameters.stage_name }} diff --git a/docs/build/XamarinAndroid.md b/docs/build/XamarinAndroid.md index e69de29..53490a0 100644 --- a/docs/build/XamarinAndroid.md +++ b/docs/build/XamarinAndroid.md @@ -0,0 +1,75 @@ +--- +title: Xamarin Android Build Template +description: Template for building a Xamarin Android application +author: Nick Randolph +--- + +# Xamarin Android Build Template + +Use this template to build Android applications from a Visual Studio Solution file (ie Xamarin). + +## YAML snippet + +```yaml +# Xamarin Android Build Template +# Template for building a Xamarin Android application +stages: +- template: azure/mobile/build-xamarin-android.yml@builttoroam_templates + parameters: + solution_filename: + secure_file_keystore_filename: + keystore_alias: + keystore_password: + #stage_name: # Optional + #depends_on: # Optional + #build_android_enabled: # Optional + #build_number: # Optional + #full_version_number: # Optional + #solution_build_configuration: # Optional + #solution_target_platform: # Optional + #android_manifest_filename: # Optional + #artifact_name: # Optional + #artifact_folder: # Optional + #application_package: # Optional + #onStart: # Optional + #preBuild: # Optional + #postBuild: # Optional + #prePublish: # Optional + #onEnd: # Optional + #nuget_version: # Optional + #net_core_version: # Optional +``` + + +## Arguments + + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentDescription
stage_name(Optional) The name of the stage, so that it can be referenced elsewhere (eg for dependsOn property). Defaults to 'Build_Android'
depends_on(Optional) The array of stages that this stage depends on. Default is that this stage does not depend on any other stage
build_android_enabled(Optional) Whether this stages should be executed. Note that setting this to false won't completely cancel the stage, it will merely skip most of the stages. The stage will appear to complete successfully, so any stages that depend on this stage will attempt to execute
build_number(Optional) The build number to be applied to the application. Defaults to Build.BuildId built in variable
full_version_number(Optional) The full application version number. Defaults to 1.0.XXX where XXX is the same as the build_number
solution_filename(Required) The relative path to the solution file that should be built
solution_build_configuration(Optional) The build configuration within the solution that should be invoked. Default is Release but can be overwritten if you want to do say a Debug build
solution_target_platform(Optional) The target platform that the solution build will use. Defaults to Any CPU
android_manifest_filename(Optional) The relative path to the AndroidManifest.xml file that defines the application manifest. If not specified, template will search for AndroidManifest.xml file
secure_file_keystore_filename(Required) The keystore file used to sign the application. This is the name of the keystore in Secure Files
keystore_alias(Required) The alias of the keystore.
keystore_password(Required) The password to access the keystore
artifact_name(Optional) The name of the artifact to copy application to
artifact_folder(Optional) The name of the folder to copy application to in the artifact
application_package(Optional) The name of the application package to output
onStartSteps to be executed before stage starts
preBuildSteps to be executed before the build starts
postBuildSteps to be executed after the build has been invoked
prePublishSteps to be executed before application package is published to artifact
onEndSteps to be executed at the end of the stage
nuget_version(Optional) Use to override the NuGet version (defaults to 4.4.1)
net_core_version(Optional) Use to override the .NET Core version (defaults to 3.0.x)
+ +## Open source + +This template is open source [on GitHub](https://github.com/builttoroam/pipeline_templates). Feedback and contributions are welcome. diff --git a/docs/build/XamarinWindows.md b/docs/build/XamarinWindows.md index e69de29..6ede8e8 100644 --- a/docs/build/XamarinWindows.md +++ b/docs/build/XamarinWindows.md @@ -0,0 +1,78 @@ +--- +title: Windows (UWP) Build Template +description: Template for building a Windows (UWP) application +author: Nick Randolph +--- + +# Windows (UWP) Build Template + +Use this template to build Windows (UWP) applications from a Visual Studio Solution file. + +## YAML snippet + +```yaml +# Windows (UWP) Build Template +# Template for building a Windows (UWP) application +stages: +- template: azure/mobile/build-xamarin-windows.yml@builttoroam_templates + parameters: + solution_filename: + windows_cert_securefiles_filename: + #stage_name: # Optional + #depends_on: # Optional + #build_windows_enabled: # Optional + #build_number: # Optional + #full_version_number: # Optional + #solution_build_configuration: # Optional + #solution_target_platform: # Optional + #uwpPackagePlatforms: # Optional + #windows_package_manifest_filename: # Optional + #windows_cert_password: # Optional + #artifact_name: # Optional + #artifact_folder: # Optional + #application_package: # Optional + #windows_upload_name: # Optional + #onStart: # Optional + #preBuild: # Optional + #postBuild: # Optional + #prePublish: # Optional + #onEnd: # Optional + #nuget_version: # Optional + +``` + + +## Arguments + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentDescription
stage_name(Optional) The name of the stage, so that it can be referenced elsewhere (eg for dependsOn property). Defaults to 'Build_Windows'
depends_on(Optional) The array of stages that this stage depends on. Default is that this stage does not depend on any other stage
build_windows_enabled(Optional) Whether this stages should be executed. Note that setting this to false won't completely cancel the stage, it will merely skip most of the stages. The stage will appear to complete successfully, so any stages that depend on this stage will attempt to execute
build_number(Optional) The build number to be applied to the application. Defaults to Build.BuildId built in variable
full_version_number(Optional) The full application version number. Defaults to 1.0.XXX where XXX is the same as the build_number
solution_filename(Required) The relative path to the solution file that should be built
solution_build_configuration(Optional) The build configuration within the solution that should be invoked. Default is Release but can be overwritten if you want to do say a Debug build
solution_target_platform(Optional) The target platform that the solution build will use. Defaults to 'x86'
uwpPackagePlatforms(Optional) The platforms the the application package will include. Defaults to 'x86|x64|ARM'
windows_package_manifest_filename(Optional) The relative path to the package.appxmanifest file that defines the application manifest. If not specified, template will search for package.appxmanifest file
windows_cert_securefiles_filename(Required) The certificate file used to sign the application. This is the name of the certificate in Secure Files
windows_cert_password(Optional) The password to unlock the certificate so it can be used. This is required if the certificate has a password set
artifact_name(Optional) The name of the artifact to copy application to
artifact_folder(Optional) The name of the folder to copy application to in the artifact
application_package(Optional) The name of the application package to output
windows_upload_name(Optional) The name of the upload package that can be submitted to the Microsoft Store
onStart(Optional) Steps to be executed before stage starts
preBuild(Optional) Steps to be executed before the build starts
postBuild(Optional) Steps to be executed after the build has been invoked
prePublish(Optional) Steps to be executed before application package is published to artifact
onEnd(Optional) Steps to be executed at the end of the stage
nuget_version(Optional) Use to override the NuGet version (defaults to 4.4.1)
+ +## Open source + +This template is open source [on GitHub](https://github.com/builttoroam/pipeline_templates). Feedback and contributions are welcome. diff --git a/docs/build/XamariniOS.md b/docs/build/XamariniOS.md index e69de29..14550ff 100644 --- a/docs/build/XamariniOS.md +++ b/docs/build/XamariniOS.md @@ -0,0 +1,80 @@ +--- +title: Xamarin iOS Build Template +description: Template for building a Xamarin iOS application +author: Nick Randolph +--- + +# Xamarin iOS Build Template + +Use this template to build iOS applications from a Visual Studio Solution file (ie Xamarin). + +## YAML snippet + +```yaml +# Xamarin iOS Build Template +# Template for building a Xamarin iOS application +stages: +- template: azure/mobile/build-xamarin-ios.yml@builttoroam_templates + parameters: + solution_filename: + ios_provisioning_profile_securefiles_filename: + ios_cert_securefiles_filename: + #stage_name: # Optional + #depends_on: # Optional + #build_ios_enabled: # Optional + #build_number: # Optional + #full_version_number: # Optional + #solution_build_configuration: # Optional + #ios_plist_filename: # Optional + #ios_cert_password: # Optional + #ios_signing_identity: # Optional + #ios_provisioning_profile_id: # Optional + #artifact_name: # Optional + #artifact_folder: # Optional + #application_package: # Optional + #onStart: # Optional + #preBuild: # Optional + #postBuild: # Optional + #prePublish: # Optional + #onEnd: # Optional + #nuget_version: # Optional + #net_core_version: # Optional + #xamarin_sdk_version: # Optional +``` + + +## Arguments + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ArgumentDescription
stage_name(Optional) The name of the stage, so that it can be referenced elsewhere (eg for dependsOn property). Defaults to 'Build_iOS'
depends_on(Optional) The array of stages that this stage depends on. Default is that this stage does not depend on any other stage
build_ios_enabled(Optional) Whether this stages should be executed. Note that setting this to false won't completely cancel the stage, it will merely skip most of the stages. The stage will appear to complete successfully, so any stages that depend on this stage will attempt to execute
build_number(Optional) The build number to be applied to the application. Defaults to Build.BuildId built in variable
full_version_number(Optional) The full application version number. Defaults to 1.0.XXX where XXX is the same as the build_number
solution_filename(Required) The relative path to the solution file that should be built
solution_build_configuration(Optional) The build configuration within the solution that should be invoked. Default is Release but can be overwritten if you want to do say a Debug build
ios_plist_filename(Optional) The Info.plist file that contains the application information such as bundle id and version information. If not specified, template will locate the first Info.plist automatically.
ios_cert_securefiles_filename(Required) The certificate file used to sign the application. This is the name of the certificate in Secure Files
ios_cert_password(Optional) The password to unlock the certificate so it can be used. This is required if the certificate has a password set
ios_provisioning_profile_securefiles_filename(Required) The provisioning profile to use when signing the application. This is the name of the provisioning profile in Secure Files
ios_signing_identity(Optional) The signing identity that maps to the signing certificate. If not provided, the template will use the value extracted during the certificate installation process.
ios_provisioning_profile_id(Optional) The id of the provisioning profile. If not provided, the template will use the value extracted during the installation of the provisioning profile
artifact_name(Optional) The name of the artifact to copy application to
artifact_folder(Optional) The name of the folder to copy application to in the artifact
application_package(Optional) The name of the application package to output
onStart(Optional) Steps to be executed before stage starts
preBuild(Optional) Steps to be executed before the build starts
postBuild(Optional) Steps to be executed after the build has been invoked
prePublish(Optional) Steps to be executed before application package is published to artifact
onEnd(Optional) Steps to be executed at the end of the stage
nuget_version(Optional) Use to override the NuGet version (defaults to 4.4.1)
net_core_version(Optional) Use to override the .NET Core version (defaults to 3.0.x)
xamarin_sdk_version(Optional) Use to override the Xamarin SDK version (defaults to 6.4.0)
+ +## Open source + +This template is open source [on GitHub](https://github.com/builttoroam/pipeline_templates). Feedback and contributions are welcome. diff --git a/docs/deploy/AppCenter.md b/docs/deploy/AppCenter.md index de0e5d5..a872d20 100644 --- a/docs/deploy/AppCenter.md +++ b/docs/deploy/AppCenter.md @@ -41,8 +41,6 @@ stages: #postArtifactDownload: # Optional #preAppCenterPublish: # Optional #onEnd: # Optional - - ``` @@ -77,58 +75,6 @@ stages: - - ## Open source This template is open source [on GitHub](https://github.com/builttoroam/pipeline_templates). Feedback and contributions are welcome. diff --git a/docs/steps/NuGetInstallAndRestore.md b/docs/steps/NuGetInstallAndRestore.md index e69de29..ac1ace1 100644 --- a/docs/steps/NuGetInstallAndRestore.md +++ b/docs/steps/NuGetInstallAndRestore.md @@ -0,0 +1,35 @@ +--- +title: NuGet Install and Solution Restore Template +description: Template for installing NuGet and restoring packages for a Visual Studio solution +author: Nick Randolph +--- + +# NuGet Install and Solution Restore Template + +Use this template to install a specific version of NuGet and restore packages for a Visual Studio solution file. + +## YAML snippet + +```yaml +# NuGet Install and Solution Restore Template +# Template for installing NuGet and restoring packages for a Visual Studio solution +stages: +- template: azure/steps/NuGetInstallAndRestore.yml@builttoroam_templates + parameters: + solution_filename: + #nuget_version: # Optional +``` + + +## Arguments + + + + + + +
ArgumentDescription
nuget_version(Optional) Use to override the NuGet version (defaults to 4.4.1)
solution_filenameThe relative path to the solution file that should be built
+ +## Open source + +This template is open source [on GitHub](https://github.com/builttoroam/pipeline_templates). Feedback and contributions are welcome.