Skip to content

Latest commit

 

History

History
217 lines (113 loc) · 19.5 KB

README.md

File metadata and controls

217 lines (113 loc) · 19.5 KB
Raw
Visual Studio Team Services Extension for CodePush
Provides build/release tasks that enable performing continuous delivery to the CodePush service from an automated VSTS build or release definition
Install now!

CodePush is a cloud service that enables Cordova and React Native developers to deploy mobile app updates directly to their users’ devices. It works by acting as a central repository that developers can publish certain updates to (e.g. JS, HTML, CSS and image changes), and that apps can query for updates from using our provided client SDKs for Cordova and React Native.

Visual Studio Team Services Extension for CodePush

This extension contains a set of deployment tasks which allow you to automate the release and promotion of app updates via CodePush from your CI environment. This can reduce the effort needed to keep your dev/alpha/beta/etc. deployments up-to-date, since you can simply push changes to the configured source control branches, and let your automated build take care of the rest. No need to manually release, promote or rollout from the CodePush CLI!

These tasks can be used with either VSTS or TFS 2015 Update 2 and are intended to work with any Cordova or React Native project. Additionally, the tasks can be paired nicely with the Cordova Command task and/or the React Native Bundle task, which allow you to easily "prepare" the platform-specific assets that can be subsequently released to CodePush.

CodePush Task + Cordova

Quick Start

  1. Using the CodePush CLI, generate a new access key whose description indicates it will be used for VSTS CI builds (e.g. code-push access-key create "VSTS CI")

    NOTE: If you provisioned your CodePush account from HockeyApp, you can use the API key that is displayed in the HockeyApp portal, and don't need to generate an additional key via the CodePush CLI.

  2. Install the CodePush extension from the VSTS Marketplace

  3. Go to your Visual Studio Team Services or TFS project, click on the Build tab, and create a new build definition (the "+" icon) that is hooked up to your project's appropriate source repo

    NOTE: If you already have a build definition setup for your app, you can feel free to re-use that. CodePush doesn't require a distinct build/release defintion in order to work.

  4. Click Add build step... and select one of the following tasks from the Deploy category, depending on your app type and/or requirements:

    1. CodePush - Release (Cordova) - Select this if you're releasing updates for a Cordova app. See the reference docs for details about how it works.

    2. CodePush - Release - Select this if you're not releasing updates for a Cordova app or you want additional flexibility beyond what the platform-specific tasks provide you. See the reference docs for details about how it works.

  5. Configure the release task with the access key created or retrieved in step #1, specifying your app name (e.g. MyApp-iOS), deployment name and all other required parameters. See the reference docs below in order to find details on each option.

  6. Click the Queue Build button or push a change to your repo in order to run the newly defined build pipeline

  7. Run your CodePush-ified app to see the change that was automatically deployed!

Moving forward, you can choose to take advantage of the CodePush - Promote task for automating the release of updates to one deployment (e.g. Staging) and then automating the promotion of it to another deployment (e.g. Production) as appropriate. This task pairs really well with the VSTS Release Management capabilities, where you can define multiple environments (each with their own deployment pipeline), as well as manual approvers, which allows you to automate updates, without sacrificing any of the control you want in terms of validation.

Globally Configuring Your Credentials

In addition to specifying your access key directly within each build task instance (as illustrated in the getting started section), you can also configure your CodePush credentials globally and refer to them within each build or release definition as needed. This can simplify the use of CodePush across a team, and increase security, since every build and release definition doesn't need to manually configure the account credentials. To do this, simply perform the following steps:

  1. Generate or retrieve your access key as described above

    NOTE: If you need to retrieve a previously generated access key, you can run the code-push access-key ls command and look for the key with the description you specified when initially creating it.

  2. Go into your Visual Studio Team Services or TFS project and click on the gear icon in the upper right corner

  3. Click on the Services tab

  4. Click on New Service Endpoint and select CodePush

    NOTE: If you're using CodePush as part of an integration with HockeyApp, you can also select the HockeyApp service endpoint type instead.

  5. Give the new endpoint a name (e.g. "MyApp-iOS") and enter the access key you generated in step #1

    Service endpoint

  6. Select this endpoint via the name you chose in #5 whenever you add a CodePush task to a build or release definition.

  7. Release app updates!

Task Reference

In addition to the custom service endpoint, this extension also contributes the following build and release tasks:

  • CodePush - Release - Allows automating the release of general-purpose content to the CodePush server. This task provides the most flexibility, but should only be used if the platform-specific tasks (e.g. Cordova) aren't appropriate for your needs.

  • CodePush - Release (Cordova) - Allows automating the generation and release of Cordova app updates. Represents a simplified, Cordova-specific version of general-purposes release task, and is recommended for all Cordova scenarios.

  • CodePush - Patch - Allows automating the modification of a previously released update. This can be useful for scenarios such as increasing the rollout of a release that was originally "flighted" (e.g. to 25% of users) or enabling a release that was disabled by default.

  • CodePush - Promote - Allows automating the promotion of a previously released update from one deployment to another (e.g. Staging -> Production).

CodePush - Release

Allows you to release an update to the CodePush server. This task behaves equivalently to the code-push release command in the management CLI, and includes the following options:

  1. Authentication Method - Specifies how you would like to authenticate with the CodePush server. The available options are:

    1. Access Key - Allows you to directly specify an access key to the task. This value can either have been generated by the CodePush CLI, or provided to you by the HockeyApp portal after you auto-provisioned your CodePush account and app.

    2. Service Endpoint (CodePush) - Allows you to reference a globally configured CodePush service endpoint.

    3. Service Endpoint (HockeyApp) - Allows you to reference a globally configured HockeyApp service endpoint.

  2. App Name (String, Required) - Name of the app you want to release the update for (e.g. MyApp-iOS).

  3. Deployment (String, Required) - Name of the deployment you want to release the update to. Defaults to Staging.

  4. Update Contents Path (File path, Required) - Path to the file or directory that contains the update you want to release. For Cordova this should be the platform-specific www folder (e.g platforms/ios/www) and for React Native this should point to either your generated JS bundle file (e.g. ios/main.jsbundle) or a directory containing your JS bundle and assets, depending on if you're using the React Native assets system. View the CLI docs for more details.

  5. Target Binary Version (String, Required) - Semver expression that specifies the binary app version(s) this release is targetting (e.g. 1.1.0, ~1.2.3). View the CLI docs for more details.

Update Metadata

In addition to the basic properties, the follow options provide more advanced control over the release and how it will be distributed to your end users:

  1. Rollout (String) - Percentage of users this release should be immediately available to. Defaults to 100%.

  2. Description (String) - Description of the changes made to the app in this release. When this task is used within a VSTS release definition, this field can be set to the $(Release.ReleaseDescription) variable in order to inherit the description that was given to the release.

  3. Mandatory (Boolean) - Specifies whether this release should be considered mandatory. Defaults to false.

  4. Disabled (Boolean) - Specifies whether this release should be immediately downloadable. Defaults to false.

CodePush - Release (Cordova)

Allows you to release Cordova app updates to the CodePush server. It provides a simplified experience over the general-purpose release task by automatically generating the release contents for you (via cordova prepare), and inferring your app's version in order to appropriately target the update. This task behaves equivalently to the code-push release-cordova command in the management CLI, and includes the following options:

  1. Authentication Method - Specifies how you would like to authenticate with the CodePush server. The available options are:

    1. Access Key - Allows you to directly specify an access key to the task. This value can either have been generated by the CodePush CLI, or provided to you by the HockeyApp portal after you auto-provisioned your CodePush account and app.

    2. Service Endpoint (CodePush) - Allows you to reference a globally configured CodePush service endpoint.

    3. Service Endpoint (HockeyApp) - Allows you to reference a globally configured HockeyApp service endpoint.

  2. App Name (String, Required) - Name of the app you want to release the update for (e.g. MyApp-iOS).

  3. Deployment (String, Required) - Name of the deployment you want to release the update to. Defaults to Staging.

  4. Platform (String, Required) - Specifies whether you want to create an update for Android or iOS. Behind the scenes, this task will run cordova prepare <platform>, where <platform> is determined by the value of this field.

  5. Build (Boolean) - Specifies whether you want the tasks to run cordova build instead of cordova prepare. This can be useful if your app has Cordova build tasks that you need to be triggered. Defaults to false.

Update Metadata

In addition to the basic properties, the follow options provide more advanced control over the release and how it will be distributed to your end users:

  1. Rollout (String) - Percentage of users this release should be immediately available to. Defaults to 100%.

  2. Description (String) - Description of the changes made to the app in this release. When this task is used within a VSTS release definition, this field can be set to the $(Release.ReleaseDescription) variable in order to inherit the description that was given to the release.

  3. Target Binary Version (String, Required) - Semver expression that specifies the binary app version(s) this release is targetting (e.g. 1.1.0, ~1.2.3). View the CLI docs for more details. Selecting Auto-Detect will automatically read the app's version from the config.xml file.

  4. Mandatory (Boolean) - Specifies whether this release should be considered mandatory. Defaults to false.

  5. Disabled (Boolean) - Specifies whether this release should be immediately downloadable. Defaults to false.

CodePush - Patch

Allows you to update the metadata for a previously released update. This task behaves equivalently to the code-push patch command in the management CLI, and includes the following options:

  1. Authentication Method - Specifies how you would like to authenticate with the CodePush server. The available options are:

    1. Access Key - Allows you to directly specify an access key to the task. This value can either have been generated by the CodePush CLI, or provided to you by the HockeyApp portal after you auto-provisioned your CodePush account and app.

    2. Service Endpoint (CodePush) - Allows you to reference a globally configured CodePush service endpoint.

    3. Service Endpoint (HockeyApp) - Allows you to reference a globally configured HockeyApp service endpoint.

  2. App Name (String, Required) - Name of the app that includes the release you want to update (e.g. MyApp-iOS).

  3. Deployment (String, Required) - Name of the deployment that includes the release you want to update. Defaults to Staging.

  4. Release Label (String, Required) - Label of the release you want to update the metadata for (e.g. v23). Selecting Latest will update the latest release within the specified deployment. Defaults to Latest.

Update Metadata

By default, no release attributes are modified by the patch operation, so in order to update any metadata, you need to change the default value for one or more of the following options in this group.

  1. Rollout (String) - Percentage of users this release should be immediately available to. Selecting Inherit will leave this attributes unmodified. Defaults to Inherit.

  2. Description (String) - Description of the changes made to the app in this release. Selecting Inherit will leave this attributes unmodified. When this task is used within a VSTS release definition, this field can be set to the $(Release.ReleaseDescription) variable in order to inherit the description that was given to the release. Defaults to Inherit.

  3. Target Binary Version (String, Required) - Semver expression that specifies the binary app version(s) this release is targetting (e.g. 1.1.0, ~1.2.3). View the CLI docs for more details. Selecting Inherit will leave this attributes unmodified. Defaults to Inherit.

  4. Mandatory (Boolean) - Specifies whether this release should be considered mandatory. Selecting Inherit will leave this attributes unmodified. Defaults to Inherit.

  5. Disabled (Boolean) - Specifies whether this release should be immediately downloadable. Selecting Inherit will leave this attributes unmodified. Defaults to Inherit.

CodePush - Promote

Allows you to promote a previously released update from one deployment to another (e.g. Staging -> Production), and enables the use of VSTS Release Management for easily handling multiple app environments from your CI environment. This task behaves equivalently to the code-push promote command in the management CLI, and includes the following options:

  1. Authentication Method - Specifies how you would like to authenticate with the CodePush server. The available options are:

    1. Access Key - Allows you to directly specify an access key to the task. This value can either have been generated by the CodePush CLI, or provided to you by the HockeyApp portal after you auto-provisioned your CodePush account and app.

    2. Service Endpoint (CodePush) - Allows you to reference a globally configured CodePush service endpoint.

    3. Service Endpoint (HockeyApp) - Allows you to reference a globally configured HockeyApp service endpoint.

  2. App Name (String, Required) - Name of the app that has the deployments you are targeting for promotion (e.g. MyApp-iOS).

  3. Source Deployment (String) - Name of the deployment you want to promote the latest release from. Defaults to Staging.

  4. Destination Deployment (String) - Name of the deployment you want to promote the release to. Defaults to Production.

Update Metadata

By default, when a release is promoted from one deployment to another, the newly created release will "inherit" not just the update contents, but also the metadata (e.g. description). This ensures that what is being promoted is the exact same thing that you tested in the source deployment. However, if you need to override one or more properties in the newly created release within the target deployment (e.g. because you use mandatory differently between environments), you can use the following fields:

  1. Rollout (String) - Percentage of users this release should be immediately available to. Defaults to 100%

  2. Description (String) - Description of the changes made to the app in this release. Selecting Inherit will use the description from the release being promoted. When this task is used within a VSTS release definition, this field can be set to the $(Release.ReleaseDescription) variable in order to inherit the description that was given to the release. Defaults to Inherit.

  3. Target Binary Version (String) - Semver expression that specifies the binary app version(s) this release is targetting (e.g. 1.1.0, ~1.2.3). Selecting Inherit will use the target binary version attribute from the release being promoted. Defaults to Inherit. View the CLI docs for more details.

  4. Mandatory (Boolean) - Specifies whether this release should be considered mandatory. Selecting Inherit will use the mandatory attribute from the release being promoted. Defaults to Inherit.

  5. Disabled (Boolean) - Specifies whether this release should be immediately downloadable. Selecting Inherit will use the disabled attribute from the release being promoted. Defaults to Inherit.

Contact Us

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.