code-push/docs/tutorials.html at gh-pages · r2dev/code-push

History

1206 lines (665 loc) · 49.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<head>

<title>

Tutorials · CodePush

</title>

</head>

<body>

<span class="sr-only">Toggle navigation</span>

</button>

<sup class="navbar-logo-text">PREVIEW</sup>

</image>

</a>

</div>

<li class=""><a href="/code-push/index.html#getting_started">Getting Started</a></li>

<li class="active"><a href="/code-push/docs/index.html">Documentation</a></li>

<li class=""><a href="/code-push/community/friends.html">Showcase</a></li>

</ul>

</div>

</div>

</nav>

</header>

<h2 class="site-toc-title">Table of Contents</h2>

<li>

Getting Started

</a>

</li>

<li>

Tutorials

</a>

</li>

<li>

Management CLI

</a>

</li>

<li>

Management SDK

</a>

</li>

<li>

Cordova Client SDK

</a>

</li>

<li>

React Native Client SDK

</a>

</li>

<li>

VSTS Extension

</a>

</li>

</ul>

</div>

<h2 class="site-toc-title">Table of Contents</h2>

Select topic

</a>

<li>

<a href=/code-push/docs/getting-started.html>Getting Started</a>

</li>

<li>

<a href=/code-push/docs/tutorials.html>Tutorials</a>

</li>

<li>

<a href=/code-push/docs/cli.html>Management CLI</a>

</li>

<li>

<a href=/code-push/docs/node.html>Management SDK</a>

</li>

<li>

<a href=/code-push/docs/cordova.html>Cordova Client SDK</a>

</li>

<li>

<a href=/code-push/docs/react-native.html>React Native Client SDK</a>

</li>

<li>

<a href=/code-push/docs/vsts-extension.html>VSTS Extension</a>

</li>

</ul>

</div>

</nav>

</div>

<h1 class="doc-title">Tutorials</h1>

</header>

<h2>Update experience configuration</h2>

<p>CodePush provides Cordova and React Native developers with multiple options to configure the end users update experience.</p>

<p>This tutorial covers three potential “update modes” or deployment strategies for CodePush updates: Silent, Active and Custom. Leveraging these options allow developers to control when (and how often) to check for updates as well as how to present any update notifications to end users.</p>

<p><strong>Note:</strong> This tutorial does not cover how to enable CodePush on an app. If you need help setting up CodePush, visit the <a href="http://microsoft.github.io/code-push/docs/cordova.html#link-2">Cordova</a> or <a href="http://microsoft.github.io/code-push/docs/react-native.html#link-3">React Native</a> “Getting Started” sections.</p>

</blockquote>

<h3>1. Silent mode</h3>

<p>Silent mode updates are the simplest way to update an app and the least invasive experience for the end users.</p>

<div class="highlight"><pre><code class="language-javascript" data-lang="javascript">codePush.sync();

</code></pre></div>

<p>If an update is available, it will be silently downloaded, and installed the next time the app is restarted (either explicitly by the end user or by the OS). However, developers can modify the install behavior if they so choose, by leveraging the <code>installMode</code> parameter:</p>

<ul>

<li><strong>IMMEDIATE</strong>: The update will be applied to the running application immediately. The application will be reloaded with the new content immediately.</li>

<li><strong>ON_NEXT_RESTART</strong>: The update is downloaded but not installed immediately. The new content will be available the next time the application is started.</li>

<li><strong>ON_NEXT_RESUME</strong>: The update is downloaded but not installed immediately. The new content will be available the next time the application is resumed or restarted, whichever event happens first.</li>

</ul>

<p>For example, to download and install an update immediately, developers can use the <code>installMode</code> parameter as follows:</p>

<div class="highlight"><pre><code class="language-javascript" data-lang="javascript">codePush.sync({installMode: InstallMode.IMMEDIATE});

</code></pre></div>

<h4>Recommendation</h4>

<p>Depending on the complexity of the app, pushing an update immediately might be a jarring experience for end users (e.g. changing the UI or losing the current state can be frustrating and confusing). Because of this, we recommend updates are installed only after a certain period of app inactivity has been reached. To achieve this experience, developers can use the InstallMode.ON_NEXT_RESUME and minimumBackgroundDuration parameters as follows:</p>

<div class="highlight"><pre><code class="language-javascript" data-lang="javascript">// Download the update silently, but install on next

// app resume and after 10 minutes of app inactivity

// We recommend doing this call on app start (e.g. `componentDidMount` event on React Native or `deviceready` on Cordova)

codePush.sync({ installMode: InstallMode.ON_NEXT_RESUME, minimumBackgroundDuration: 60 * 10 });

</code></pre></div>

<p><strong>Note:</strong> If <code>codePush.sync()</code> is not called on app start (e.g. <code>componentDidMount</code> event on React Native or <code>deviceready</code> on Cordova), developers will need to notify the update was successfully installed by calling the <code>codePush.notifyApplicationReady()</code> method. Otherwise the CodePush runtime will assume the installed update has failed and roll back to the previous version.</p>

<p><strong>Note:</strong> For Cordova, the first parameter that <code>codePush.sync()</code> expects is a <code>syncStatusCallback</code>, so to do the same thing, you should insert <code>null</code> as the first parameter to the call, i.e:</p>

</blockquote>

<div class="highlight"><pre><code class="language-javascript" data-lang="javascript">codePush.sync(null, { installMode: InstallMode.ON_NEXT_RESUME, minimumBackgroundDuration: 60 * 10 });

</code></pre></div>

<h3>2. Active mode</h3>

<p>In contrast to the silent mode updates, active mode updates prompt end users about available updates and thus require user interaction.</p>

<p>The difference is introduced by the usage of the <code>updateDialog</code> parameter.</p>

<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"> codePush.sync({ updateDialog: true });

</code></pre></div>

<p>If an update is available, the app automatically launches a native prompt asking end users for permission to download and install the update. Once the user accepts, the update is silently downloaded and inmmediatly applied., and installed the next time the app is restarted (either explicitly by the end user or by the OS).</p>

<h4>Update dialog customization</h4>

<p>To customize the update dialog, developers can create an updateDialogOption object and pass it to the <code>codePush.sync()</code> call as follows:</p>

var updateDialogOptions = {

updateTitle: "You have an update",

optionalUpdateMessage: "Update available. Install?",

optionalIgnoreButtonLabel: "Nop",

optionalInstallButtonLabel: "Yep",

};

codePush.sync({ updateDialog: updateDialogOptions});

</code></pre></div>

<p>Visit the <a href="http://microsoft.github.io/code-push/docs/cordova.html#link-5">Cordova</a> or <a href="http://microsoft.github.io/code-push/docs/react-native.html#link-8">React Native</a> API Reference pages for a full description of all the avaiable UpdateDialogOptions options.</p>

<p><strong>Note:</strong> While Apple’s developer agreement fully allows performing over-the-air updates of JavaScript and assets (which is what enables CodePush!), it is against their policy for an app to display an update prompt. Because of this, we recommend that App Store-distributed apps don’t enable the updateDialog option when calling sync, whereas Google Play and internally distributed apps (e.g. Enterprise, Fabric, HockeyApp) can choose to enable/customize it.</p>

</blockquote>

<h3>3. Custom mode</h3>

<p>Custom mode provides the flexibility to customize any stage of the update experience such as providing a custom “checking for updates” or “downloading” notification.</p>

<h4>Update cycle notifications</h4>

<p>The <code>codePush.sync()</code> method allows the use of a call back to hook into the overall update process and thus provide a custom experience on each stage of the update process as follows.</p>

<div class="highlight"><pre><code class="language-javascript" data-lang="javascript">var onSyncStatusChange = function(SyncStatus) {

switch (SyncStatus) {

case SyncStatus.CHECKING_FOR_UPDATE:

// Show "Checking for update" notification

break;

case SyncStatus.AWAITING_USER_ACTION:

// Show "Checking for update" notification

break;

case SyncStatus.DOWNLOADING_PACKAGE:

// Show "downloading" notification

break;

case SyncStatus.INSTALLING_UPDATE:

// Show "installing" notification

break;

}

// Prompt the user when an update is available and display a "downloading" modal

codePush.sync({ updateDialog: true }, onSyncStatusChange);

</code></pre></div>

<p>Visit the <a href="http://microsoft.github.io/code-push/docs/cordova.html#syncstatus">Cordova</a> or <a href="http://microsoft.github.io/code-push/docs/react-native.html#syncstatus">React Native</a> SyncStatus enum for a full description of all the available enum values.</p>

<h4>Adding a “downloading” progress indicator</h4>

<p>To provide an enhanced experience, developers can choose to provide a download progress indicator. The <code>codePush.sync()</code> method provides a different call back to make this possible.</p>

var onError = function (error) {

console.log("An error occurred. " + error);

};

var onDownloadProgress = function (downloadProgress) {

if (downloadProgress) {

console.log("Downloading " + downloadProgress.receivedBytes + " of " + downloadProgress

}

};

codePush.sync({ updateDialog: true }, onSyncStatusChange, onDownloadProgress, onError);

</code></pre></div>

<h2>Automate your deployments with VSTS</h2>

<p>Continuous Integration (CI) and Continuous Deployment (CD) are key practices of DevOps. It requires the team to have a mindset to merge all working copies of developers’ code with a shared repository, producing a new build upon code commit. In turn this provides them with the opportunity to leverage the CI output, deploy it to one or more environments, and ultimately serve the end users via app updates.</p>

<p>This tutorial covers how to leverage Visual Studio Team Services (VSTS) and CodePush in order to create a CD environment to automate app updates from an existing CI environment. Even though a “proper” CI build not only compiles the code, but ideally runs code analysis, unit (and sometimes even integration) tests and even could package the code, those CI details won’t be discussed but instead go over the basics of CI integration as well as details of how to setup the CD environment.</p>

<h3>Overview</h3>

<p>VSTS is a collection of services that let teams share code, track work, and ship software—for any language.</p>

<p>From a high-level it provides developers with:</p>

<ul>

<li>Unlimited free private code repositories</li>

<li>Ability to track bugs, work items, feedback, and more</li>

<li>Agile planning tools</li>

<li>Continuous integration builds</li>

<li>Enterprise-grade services scale to any team size</li>

<li>Free for up to five users</li>

</ul>

<p>In addition, VSTS allows developers to extend the service by creating VSTS extensions that can help with tasks covering the full CI and CD spectrum.</p>

<p>The CodePush service provides a VSTS extension with a set of deployment tasks that allows the automation of releases and the promotion of app updates directly from your CI environment.</p>

<p>Leveraging the workflow discussed below can greatly reduce the effort needed to keep your dev/alpha/beta 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!</p>

<h3>Prerequisites</h3>

<p>The following is required to complete this module:</p>

<ul>

<li>VSTS Account (Sign up for a free VSTS account <a href="https://www.visualstudio.com/products/free-developer-offers-vs">here</a>)</li>

<li>CodePush Account (Follow these <a href="http://microsoft.github.io/code-push/docs/getting-started.html#link-0">steps</a> to create an account)</li>

<li>React Native “CodePush ready” <a href="https://github.com/rub8n/VSTSCDSample">sample app</a> (Use your own app or download the “bare bones” sample app to speed things up)</li>

</ul>

<p><strong>Note:</strong> For simplicity purposes, the steps covered below are done using the Android platform of the React Native sample project above. However, most of the steps also apply for both React Native iOS and Cordova projects.</p>

</blockquote>

<h3>1. Register your app with CodePush</h3>

<p>Start by registering your app with the CodePush service:

<code>

code-push app add VSTSCDSample-Android android react-native

</code></p>

<p>The CodePush CLI will provide you with a set of deployment keys:

<p>Save the <code>Staging</code> deployment key as it will be used to set up your project.</p>

<h3>2. Add a CodePush deployment key</h3>

<p>Download the <a href="#">React Native sample project</a> and open the strings.xml file located under the sample app’s <code>android > app > src > main > res > values</code>.</p>

<p>Navigate to line #2 and add the previously recorded <code>Staging</code> deployment key:</p>

<h3>3. Push the source code to a VSTS team project</h3>

<p>Create a new project in VSTS by clicking on <code>New</code>:</p>

<p>Give it a name and ensure <code>Git</code> is selected for <code>Version control</code>:</p>

<p>Once the project is created, copy the remote string as you will use it to update the local repository’s remote URL to point to your new VSTS project:</p>

<p>Update the repository’s remote URL using the following <a href="https://help.github.com/articles/changing-a-remote-s-url">command</a>:</p>

<div class="highlight"><pre><code class="language-text" data-lang="text"> git remote set-url origin replaceWithVSTSRepositoryURL

</code></pre></div>

<p>Once the new remote URL is set, push the repository to VSTS via <a href="https://help.github.com/articles/pushing-to-a-remote/">Git push</a></p>

<div class="highlight"><pre><code class="language-text" data-lang="text"> git push -u origin --all

</code></pre></div>

<p>A few seconds later, the source will be added to your VSTS repository:</p>

<h3>4. Configure the CI environment</h3>

<h4>Install VSTS extension</h4>

<p>To build the project you will need to install an extension from the VSTS Marketplace.</p>

<p>For React Native projects do the following:</p>

<ol>

<li> In the upper right corner, click the Basket icon and select Browse Marketplace.</li>

</ol>

<ol>

<li> Enter the term <code>react</code> in the search box and press enter. Open and install the <code>React Native</code> VSTS extension made by the <code>Visual Studio Client Tools</code> team:</li>

</ol>

<h4>Create a new build definition</h4>

<ol>

<li>In the top menu bar, click BUILD to open the build hub. In the menu on the left, click the green + button to create a new build definition.</li>

</ol>

<ol>

<li>Select <code>Empty</code> from the list of build templates and click <code>Next</code>.</li>

</ol>

<ol>

<li>Make sure that the repo settings are correct (it should be the master branch on the VSTSCDSample repo). Check the <code>Continuous integration</code> checkbox and ensure that the Default agent queue is set to Hosted and click <code>Create</code>.</li>

</ol>

<p><strong>Note</strong>: The <code>Continuous Integration</code> trigger tells VSTS to kick-off an instance of this build each time code is pushed to the <code>master</code> branch.</p>

</blockquote>

<h4>Configure the build task</h4>

<p>As part of the CI build configuration process, you’ll add a series of steps that will build the project and publish an artifact (the Android bundle), which the CD environment will use to update the app.</p>

<p>Create the described build definition by following these steps:</p>

<ol>

<li><p>Install npm dependencies by clicking on <code>Add build step...</code> and adding <code>npm</code> from the <code>Package</code> category. Select it and specify the following settings:</p>

<ul>

<li>Use <code>install</code> as the <code>Command</code></li>

</ul></li>

<li><p>Add a new build step to remove any previously created “artifacts” folder by adding <code>Command Line</code> from the <code>utility</code> category. Select it and specify the following settings:</p>

<ul>

<li>Use <code>-rf artifacts</code> as the <code>Arguments</code></li>

</ul></li>

<li><p>Add a new build step to make a new “artifacts” folder by adding a <code>Command Line</code> from the <code>utility</code> category. Select it and specify the following settings:</p>

<ul>

<li>Use <code>mkdir</code> as the <code>Tool</code></li>

<li>Use <code>artifacts</code> as the <code>Arguments</code></li>

</ul></li>

<li><p>Add a new build step to add <code>React Native Prepare</code> from the <code>Build</code> category. Select it and specify the following settings:</p>

<ul>

<li>Select <code>Android</code> as the <code>Platform</code></li>

<li>Use <code>android/app/build.gradle</code> as the <code>react.gradle Path</code></li>

</ul></li>

<li><p>Add a new build step to add <code>React Native Bundle</code> from the <code>Build</code> category. Select it and specify the following settings:</p>

<ul>

<li>Select <code>Android</code> as the <code>Platform</code></li>

<li>Use <code>index.android.js</code> as the <code>Entry File</code></li>

<li>Use <code>./artifacts/index.android.bundle</code> as the <code>Bundle Output</code></li>

<li>Use <code>./artifacts</code> as the <code>Asset Destination Path</code></li>

</ul></li>

<li><p>Add a new build step to publish the created artifacts (in this context the Android bundle created by running <code>React Native Bundle</code>) by adding <code>Publish Build Artifacts</code> from the <code>utility</code> category. Select it and specify the following settings:</p>

<ul>

<li>Use <code>./artifacts</code> as the <code>Path to Publish</code></li>

<li>Use <code>Artifacts</code> as the <code>Artifact Name</code></li>

<li>Use <code>Server</code> as the <code>Artifact Type</code></li>

</ul></li>

<li><p>Save and name the build definition by pressing the <code>Save</code> toolbar button.</p></li>

</ol>

<p>You can manually queue a new build to test the build process by pressing the <code>Queue build...</code> toolbar button.</p>

<p>Pressing <code>OK</code> on the “Queue build” dialog starts the build process:</p>

<p><strong>Note</strong>: The previously set <code>Continuous Integration</code> trigger ensures new builds are automatically queued every time code is pushed to the <code>master</code> branch.</p>

</blockquote>

<h3>5. Configure the CD environment</h3>

<p>As a best practice, we recommend creating three release environments: “Staging”, “Rollout” and “Production”. This configuration allows you to continuously deploy to “Staging”, rollout to a small percentage of production users and finally release to all production users when confidence is high.</p>

<h4>Install VSTS extension</h4>

<p>To leverage the CodePush service as the release vehicle, you will need to install another extension from the VSTS Marketplace.</p>

<ol>

<li> In the upper right corner, click the Basket icon and select Browse Marketplace.</li>

</ol>

<ol>

<li> Enter the term <code>codepush</code> in the search box and press enter. Open and install the <code>React Native</code> VSTS extension made by the <code>Visual Studio Client Tools</code> team:</li>

</ol>

<h4>Create a new release definition</h4>

<ol>

<li>In the top menu bar, click RELEASE to open the release hub. In the menu on the left, click the green + button to create a new release definition.</li>

</ol>

<ol>

<li>Select <code>Empty</code> from the list of release templates and click <code>Next</code>.</li>

</ol>

<ol>

<li>Make sure that the project settings are correct (the source should point towards the previously created build definition). Check the <code>Continuous deployment</code> checkbox and ensure that the agent queue is set to <code>Hosted</code> and click <code>Create</code>.</li>

</ol>

<p><strong>Note</strong>: The <code>Continuous deployment</code> trigger tells VSTS to kick-off a release each time a successful build completes. This behavior can be modified to release automatically or after a release is formally approved.</p>

</blockquote>

<h4>Configure the deployment task</h4>

<p>For the actual CD tasks, you’ll create a staging environment that will release updates via CodePush after every successful build. Followed by two production environments that will initially target a small fixed amount of production users and eventually all production users.</p>

<p>Create the described release definition by following these steps:</p>

<ol>

<li><p>Rename the default environment to <code>Staging</code> by clicking on the “Environment 1” label, typing the new name and pressing enter.</p></li>

<li><p>Use the <code>CodePush CLI</code> to create an access key for VSTS by typing <code>code-push access-key add "VSTS integration"</code>. Save the key for the next step.</p></li>

<li><p>Back to VSTS, configure the <code>Staging</code> environment to release CodePush updates to users in the “staging ring” by clicking on <code>Add tasks</code> and selecting <code>CodePush - Release</code> from the <code>Deploy</code> category. Select it and specify the following settings:</p>

<ul>

<li>Use <code>Access Key</code> as the <code>Authentication Method</code></li>

<li>Use the key created in the previous step as the <code>Access Key</code></li>

<li>Use <code>VSTSCDSample-android</code> (or the app name used when registering the app with CodePush if different) as the <code>App Name</code></li>

<li>Use <code>Staging</code> as the <code>Deployment</code></li>

<li>Use the browse button to set <code>Update Contents Path</code> to point towards the “Artifacts” folder created during the build process.</li>

</ul></li>

<li><p>Add a second environment and name it <code>Rollout</code> by clicking on <code>Add environment</code> then on “Create new environment”. Select <code>Empty</code>, press <code>Next</code> and specify the following settings:</p>

<ul>

<li>Set <code>Specific users</code> under <code>Pre-deployment approval</code> to control what users decide to approve deployments to the <code>Rollout</code> environment.</li>

<li>Select the <code>trigger</code> to ensure this step kicks off automatically after the <code>Staging</code> release completes.</li>

</ul></li>

<li><p>Configure the environment to target only a fixed number of production users, by clicking on “Add tasks” and selecting <code>CodePush - Promote</code> from the <code>Deploy</code> category. Select it and specify the following settings:</p>

<ul>

<li>Use <code>Access Key</code> as the <code>Authentication Method</code></li>

<li>Use the key created in the previous step as the <code>Access Key</code></li>

<li>Use <code>VSTSCDSample-android</code> (or the app name used when registering the app with CodePush if different) as the <code>App Name</code></li>

<li>Use <code>Staging</code> as the <code>Source Deployment</code></li>

<li>Use <code>Production</code> as the <code>Destination Deployment</code></li>

<li>Use <code>20%</code> for <code>Rollout</code> in order to deploy to only 20% of your production users</li>

</ul></li>

<li><p>Save and name the release definition by pressing the Save toolbar button.</p></li>

<li><p>Add a third environment and name it <code>Production</code> by clicking on <code>Add environment</code> then on “Create new environment”. Select <code>Empty</code>, press <code>Next</code> and specify the following settings:</p>

<ul>

<li>Set <code>Specific users</code> under <code>Pre-deployment approval</code> to control what users decide to approve deployments to the <code>Rollout</code> environment.</li>

<li>Select the <code>trigger</code> to ensure this step kicks off automatically after the <code>Rollout</code> release completes.</li>

</ul></li>

<li><p>Configure the environment to target all remaining production users, by clicking on “Add tasks” and selecting <code>CodePush - Patch</code> from the <code>Deploy</code> category. Select it and specify the following settings:</p>

<ul>

<li>Use <code>Access Key</code> as the <code>Authentication Method</code></li>

<li>Use the key created in the previous step as the <code>Access Key</code></li>

<li>Use <code>VSTSCDSample-android</code> (or the app name used when registering the app with CodePush if different) as the <code>App Name</code></li>

<li>Use <code>Production</code> as the <code>Deployment</code></li>

View remainder of file in raw view

FilesExpand file tree

tutorials.html

Latest commit

History

tutorials.html

File metadata and controls