App Center extension for VS Code
Перейти к файлу
Anna Kocheshkova d6ca6ec7f7 Update Readme (#34)
* Update README

* Add Test section

* Several fixes

* Update README.md

* Update README.md
2018-04-23 09:33:10 +03:00
.vscode Add vsts profile management 2018-04-09 20:18:09 +03:00
images updated README 2018-03-29 13:29:46 +03:00
src Update initial AC menu prompt. 2018-04-20 11:35:38 -07:00
test Fix test 2018-04-12 17:20:40 +03:00
.gitignore replaced appcenter-node-client with autorest 2018-04-11 16:28:29 +03:00
.vscodeignore tsconfig/tslint other changes 2018-03-19 15:40:29 +03:00
CHANGELOG.md initial commit 2018-03-16 11:34:18 +03:00
LICENSE Initial commit 2018-03-15 19:20:51 -07:00
README.md Update Readme (#34) 2018-04-23 09:33:10 +03:00
gulpfile.js Modified gulp task (#22) 2018-04-13 13:08:29 +03:00
package-lock.json Add UI tests runner (#29) 2018-04-20 17:13:16 +03:00
package.json Update Readme (#34) 2018-04-23 09:33:10 +03:00
tsconfig.json replaced appcenter-node-client with autorest 2018-04-11 16:28:29 +03:00
tslint.json Refactored creating new app. Added ideaName prompt. 2018-04-19 18:33:21 +03:00

README.md

VSCode App Center Tools · Build Status

This extension provides development support for App Center projects.

NOTE: Currently it supports only React-Native based apps.

Getting Started

  • Install VS Code.
  • Install the extension
  • If you haven't already, please also install:
    • react-native-cli
    • git

How it works

There are several possible scenarios this extension solves:

  1. Start development of a new React Native application with App Center already configured:

    • Clone a new empty repository to your machine or log into the extension with a VSTS access token.

    • Login to the App Center using the new status bar icon.

      Login to App Center

    • After logging in click the App Center status bar to show possible menu options

      AppCenter Menu

    • You will be prompted to enter a new for your project and select user or organization where you would like to create app in App Center

      • App Center sample app will be cloned into the repository you have provided (it will also have preconfigured for App Center Analytics/Crashes/CodePush SDK's)
      • Two React Native apps (for iOS and Android) will be created in App Center (project-name-ios and project-name-android)
      • CodePush deployments will be created for both apps
      • Apps will be automatically linked with corresponding iOS/Android secret keys and CodePush deployment keys
      • Changes will be pushed to your remote repository
      • New Testers Distribution Group will be created for every new app in App Center
      • App will be connected to your GH repository master branch and new build will be started
    • You will be notified when finished and also we will automatically run npm install for you

  2. Link an existing react-native application to App Center. You will see a "Set Current App" option, when logged in. You can either choose an app from App Center or choose it to be created for you. When you pick "Create an App Center app" option, several options are available:

    • Create an app for Android
    • Create an app for iOS
    • Create apps for both platforms If you choose one of the first two, the app will be created and automatically set as current. If you choose to create two apps, you will have to pick one of them as current when a prompt is shown.

    When the app is linked to App Center, several new options appear in the menu:

    • Build
    • Test
    • Distribute
    • Crashes
    • Analytics They all open the corresponding App Center tabs for the application. "Distribute" also contains CodePush stuff.
  3. You would like to open already existing react-native application with CodePush installed. When logged in, the following App Center Menu options should be avaliable under "Distribute > CodePush":

    • Set current app for CodePush
    • Change current Deployment
    • Change target binary verson
    • Change if release should be mandatory
    • Make new CodePush release

Test

If your React Native application has UI tests you can run it in the App Center cloud using the extension.

Preparing tests

In order to run the tests in App Center cloud you need App Center CLI. To install it run npm install -g appcenter-cli in terminal.

iOS

Currently, extension supports running of XCUI tests only. Please, follow the instructions for App Center portal docs to prepare tests for uploading to the App Center cloud.

Running tests

  1. Open App Center menu and then click Test button.

TODO image

  1. To run tests you can use two options: Run UI tests and Run UI tests asynchronously. Command Run UI tests will start to build your application for testing, upload it together with tests to App Center cloud and then run it there waiting for tests to be done. Command Run UI tests asynchronously does the same thing except it exits the command when tests are uploaded, without waiting for test results. Choose the one you prefer the most. Also, you can track progress of command below in status bar.

TODO image

  1. Select device configuration for tests.

TODO image

  1. After that, Output->React Native window will be opened where you can monitor the progress of the build, upload and run the tests.

TODO image

Contributing

There are a couple of ways you can contribute to this repo:

  • Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads.
  • Documentation: Found a typo or strangely worded sentences? Submit a PR!
  • Code: Contribute bug fixes, features or design changes.

Before we can accept your pull request you will need to sign a Contribution License Agreement. All you need to do is to submit a pull request, then the PR will get appropriately labelled (e.g. cla-required, cla-norequired, cla-signed, cla-already-signed). If you already signed the agreement we will continue with reviewing the PR, otherwise system will tell you how you can sign the CLA. Once you sign the CLA all future PR's will be labeled as cla-signed.

Code of conduct

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.

License

MIT