Skip to content

Commit

Permalink
Merge pull request #20 from builttoroam/nickr/fixreleasenotes
Browse files Browse the repository at this point in the history
Updating docs
  • Loading branch information
nickrandolph authored Mar 6, 2020
2 parents aa843a7 + 5b6d9cb commit dae1d5d
Show file tree
Hide file tree
Showing 8 changed files with 284 additions and 78 deletions.
10 changes: 5 additions & 5 deletions azure/mobile/build-xamarin-android.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: []
Expand Down
10 changes: 5 additions & 5 deletions azure/mobile/build-xamarin-ios.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: []
Expand Down
20 changes: 6 additions & 14 deletions azure/mobile/build-xamarin-windows.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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: []
Expand All @@ -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 }}
Expand Down
75 changes: 75 additions & 0 deletions docs/build/XamarinAndroid.md
Original file line number Diff line number Diff line change
@@ -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

<table><thead><tr><th>Argument</th><th>Description</th></tr></thead>
<tr><td>stage_name</td><td>(Optional) The name of the stage, so that it can be referenced elsewhere (eg for dependsOn property). Defaults to 'Build_Android'</td></tr>
<tr><td>depends_on</td><td>(Optional) The array of stages that this stage depends on. Default is that this stage does not depend on any other stage</td></tr>
<tr><td>build_android_enabled</td><td>(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</td></tr>
<tr><td>build_number</td><td>(Optional) The build number to be applied to the application. Defaults to Build.BuildId built in variable</td></tr>
<tr><td>full_version_number</td><td>(Optional) The full application version number. Defaults to 1.0.XXX where XXX is the same as the build_number</td></tr>
<tr><td>solution_filename</td><td>(Required) The relative path to the solution file that should be built</td></tr>
<tr><td>solution_build_configuration</td><td>(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</td></tr>
<tr><td>solution_target_platform</td><td>(Optional) The target platform that the solution build will use. Defaults to Any CPU</td></tr>
<tr><td>android_manifest_filename</td><td>(Optional) The relative path to the AndroidManifest.xml file that defines the application manifest. If not specified, template will search for AndroidManifest.xml file</td></tr>
<tr><td>secure_file_keystore_filename</td><td>(Required) The keystore file used to sign the application. This is the name of the keystore in Secure Files</td></tr>
<tr><td>keystore_alias</td><td>(Required) The alias of the keystore. </td></tr>
<tr><td>keystore_password</td><td>(Required) The password to access the keystore</td></tr>
<tr><td>artifact_name</td><td>(Optional) The name of the artifact to copy application to</td></tr>
<tr><td>artifact_folder</td><td>(Optional) The name of the folder to copy application to in the artifact</td></tr>
<tr><td>application_package</td><td>(Optional) The name of the application package to output</td></tr>
<tr><td>onStart</td><td>Steps to be executed before stage starts</td></tr>
<tr><td>preBuild</td><td>Steps to be executed before the build starts</td></tr>
<tr><td>postBuild</td><td>Steps to be executed after the build has been invoked</td></tr>
<tr><td>prePublish</td><td>Steps to be executed before application package is published to artifact</td></tr>
<tr><td>onEnd</td><td>Steps to be executed at the end of the stage</td></tr>
<tr><td>nuget_version</td><td>(Optional) Use to override the NuGet version (defaults to 4.4.1)</td></tr>
<tr><td>net_core_version</td><td>(Optional) Use to override the .NET Core version (defaults to 3.0.x)</td></tr>


</table>

## Open source

This template is open source [on GitHub](https://github.com/builttoroam/pipeline_templates). Feedback and contributions are welcome.
78 changes: 78 additions & 0 deletions docs/build/XamarinWindows.md
Original file line number Diff line number Diff line change
@@ -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

<table><thead><tr><th>Argument</th><th>Description</th></tr></thead>

<tr><td>stage_name</td><td>(Optional) The name of the stage, so that it can be referenced elsewhere (eg for dependsOn property). Defaults to 'Build_Windows'</td></tr>
<tr><td>depends_on</td><td>(Optional) The array of stages that this stage depends on. Default is that this stage does not depend on any other stage</td></tr>
<tr><td>build_windows_enabled</td><td>(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</td></tr>
<tr><td>build_number</td><td>(Optional) The build number to be applied to the application. Defaults to Build.BuildId built in variable</td></tr>
<tr><td>full_version_number</td><td>(Optional) The full application version number. Defaults to 1.0.XXX where XXX is the same as the build_number</td></tr>
<tr><td>solution_filename</td><td>(Required) The relative path to the solution file that should be built</td></tr>
<tr><td>solution_build_configuration</td><td>(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</td></tr>
<tr><td>solution_target_platform</td><td>(Optional) The target platform that the solution build will use. Defaults to 'x86'</td></tr>
<tr><td>uwpPackagePlatforms</td><td>(Optional) The platforms the the application package will include. Defaults to 'x86|x64|ARM'</td></tr>
<tr><td>windows_package_manifest_filename</td><td>(Optional) The relative path to the package.appxmanifest file that defines the application manifest. If not specified, template will search for package.appxmanifest file</td></tr>
<tr><td>windows_cert_securefiles_filename</td><td>(Required) The certificate file used to sign the application. This is the name of the certificate in Secure Files</td></tr>
<tr><td>windows_cert_password</td><td>(Optional) The password to unlock the certificate so it can be used. This is required if the certificate has a password set</td></tr>
<tr><td>artifact_name</td><td>(Optional) The name of the artifact to copy application to</td></tr>
<tr><td>artifact_folder</td><td>(Optional) The name of the folder to copy application to in the artifact</td></tr>
<tr><td>application_package</td><td>(Optional) The name of the application package to output</td></tr>
<tr><td>windows_upload_name</td><td>(Optional) The name of the upload package that can be submitted to the Microsoft Store</td></tr>
<tr><td>onStart</td><td>(Optional) Steps to be executed before stage starts</td></tr>
<tr><td>preBuild</td><td>(Optional) Steps to be executed before the build starts</td></tr>
<tr><td>postBuild</td><td>(Optional) Steps to be executed after the build has been invoked</td></tr>
<tr><td>prePublish</td><td>(Optional) Steps to be executed before application package is published to artifact</td></tr>
<tr><td>onEnd</td><td>(Optional) Steps to be executed at the end of the stage</td></tr>

<tr><td>nuget_version</td><td>(Optional) Use to override the NuGet version (defaults to 4.4.1)</td></tr>


</table>

## Open source

This template is open source [on GitHub](https://github.com/builttoroam/pipeline_templates). Feedback and contributions are welcome.
80 changes: 80 additions & 0 deletions docs/build/XamariniOS.md
Original file line number Diff line number Diff line change
@@ -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

<table><thead><tr><th>Argument</th><th>Description</th></tr></thead>

<tr><td>stage_name</td><td>(Optional) The name of the stage, so that it can be referenced elsewhere (eg for dependsOn property). Defaults to 'Build_iOS'</td></tr>
<tr><td>depends_on</td><td>(Optional) The array of stages that this stage depends on. Default is that this stage does not depend on any other stage</td></tr>
<tr><td>build_ios_enabled</td><td>(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</td></tr>
<tr><td>build_number</td><td>(Optional) The build number to be applied to the application. Defaults to Build.BuildId built in variable</td></tr>
<tr><td>full_version_number</td><td>(Optional) The full application version number. Defaults to 1.0.XXX where XXX is the same as the build_number</td></tr>
<tr><td>solution_filename</td><td>(Required) The relative path to the solution file that should be built</td></tr>
<tr><td>solution_build_configuration</td><td>(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</td></tr>
<tr><td>ios_plist_filename</td><td>(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.</td></tr>
<tr><td>ios_cert_securefiles_filename</td><td>(Required) The certificate file used to sign the application. This is the name of the certificate in Secure Files</td></tr>
<tr><td>ios_cert_password</td><td>(Optional) The password to unlock the certificate so it can be used. This is required if the certificate has a password set</td></tr>
<tr><td>ios_provisioning_profile_securefiles_filename</td><td>(Required) The provisioning profile to use when signing the application. This is the name of the provisioning profile in Secure Files</td></tr>
<tr><td>ios_signing_identity</td><td>(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.</td></tr>
<tr><td>ios_provisioning_profile_id</td><td>(Optional) The id of the provisioning profile. If not provided, the template will use the value extracted during the installation of the provisioning profile</td></tr>
<tr><td>artifact_name</td><td>(Optional) The name of the artifact to copy application to</td></tr>
<tr><td>artifact_folder</td><td>(Optional) The name of the folder to copy application to in the artifact</td></tr>
<tr><td>application_package</td><td>(Optional) The name of the application package to output</td></tr>
<tr><td>onStart</td><td>(Optional) Steps to be executed before stage starts</td></tr>
<tr><td>preBuild</td><td>(Optional) Steps to be executed before the build starts</td></tr>
<tr><td>postBuild</td><td>(Optional) Steps to be executed after the build has been invoked</td></tr>
<tr><td>prePublish</td><td>(Optional) Steps to be executed before application package is published to artifact</td></tr>
<tr><td>onEnd</td><td>(Optional) Steps to be executed at the end of the stage</td></tr>
<tr><td>nuget_version</td><td>(Optional) Use to override the NuGet version (defaults to 4.4.1)</td></tr>
<tr><td>net_core_version</td><td>(Optional) Use to override the .NET Core version (defaults to 3.0.x)</td></tr>
<tr><td>xamarin_sdk_version</td><td>(Optional) Use to override the Xamarin SDK version (defaults to 6.4.0)</td></tr>


</table>

## Open source

This template is open source [on GitHub](https://github.com/builttoroam/pipeline_templates). Feedback and contributions are welcome.
Loading

0 comments on commit dae1d5d

Please sign in to comment.