Doc & Travis

Author: EddyVerbruggen

.travis.yml

@@ -1,38 +1,52 @@
-language: android
-
-jdk: oraclejdk8
+matrix:
+ include:
+ - stage: "Lint"
+ language: node_js
+ os: linux
+ node_js: "8"
+ script: cd src && npm run ci.tslint
+ - stage: "WebPack, Build"
+ os: osx
+ env:
+ - WebPack="iOS"
+ osx_image: xcode10.0
+ language: node_js
+ node_js: "8"
+ jdk: oraclejdk8
+ script: cd demo && npm run build.plugin && npm i && tns build ios --bundle --env.uglify
+ - language: android
+ env:
+ - BuildAndroid="28"
+ os: linux
+ jdk: oraclejdk8
+ before_install: nvm install stable
+ script:
+ - cd src && npm i && npm run preparedemo && cd ../demo && tns build android
+ - os: osx
+ env:
+ - BuildiOS="12"
+ - Xcode="10.0"
+ osx_image: xcode10.0
+ language: node_js
+ node_js: "8"
+ jdk: oraclejdk8
+ script:
+ - cd src && npm i && npm run preparedemo && cd ../demo && tns build ios
 
 android:
  components:
  - tools
  - platform-tools
- - build-tools-25.0.2
- - android-25
+ - build-tools-28.0.3
+ - android-28
  - extra-android-m2repository
  - sys-img-armeabi-v7a-android-21
 
-before_cache:
- - rm -f $HOME/.gradle/caches/modules-2/modules-2.lock
-
-cache:
- directories:
- - .nvm
- - $HOME/.gradle/caches/
- - $HOME/.gradle/wrapper/
+before_install:
+ - sudo pip install --upgrade pip
+ - sudo pip install six
 
 install:
- - nvm install node
- - npm install -g nativescript
- - tns usage-reporting disable
- - tns error-reporting disable
- - npm install
-
-before_script:
- - echo no | android create avd --force -n test -t android-21 -b armeabi-v7a
- - emulator -avd test -no-audio -no-window &
- - android-wait-for-emulator
-
-script:
- - cd src
- - npm run setup
- - npm test
+ - echo no | npm install -g nativescript
+ - tns usage-reporting disable
+ - tns error-reporting disable

README.md

@@ -139,78 +139,50 @@ application.on(application.resumeEvent, () => {
 Once your app has been configured and distributed to your users, and you've made some code and/or asset changes,
 it's time to instantly release them!
 
-The easiest way to do this is to use the `release-nativescript` command in our CodePush CLI.
+The easiest way to do this is to use the `release-nativescript` command in our CodePush CLI. Its (most relevant) options are:
+
+|param|alias|default|description
+|---|---|---|---
+|deploymentName|d|Staging|Deploy to either "Staging" or "Production".
+|description|des||Description of the changes made to the app with this release.
+|targetBinaryVersion|t||Semver expression that specifies the binary app version(s) this release is targeting (e.g. 1.1.0, ~1.2.3).
+|rollout|r|100%|Percentage of users this release should be available to. The `%` sign is optional.
 
 ### iOS
 
 ```shell
 nativescript-code-push release-nativescript <codepush-ios-appname> ios # deploy to Staging
 nativescript-code-push release-nativescript <codepush-ios-appname> ios --d Production # deploy to Production (default: Staging)
 nativescript-code-push release-nativescript <codepush-ios-appname> ios --targetBinaryVersion ~1.0.0 # release to users running any 1.x version (default: the exact version in Info.plist)
-nativescript-code-push release-nativescript <codepush-ios-appname> ios --rollout 25 # percentage of users this release should be immediately available to (default: 100) 
+nativescript-code-push release-nativescript <codepush-ios-appname> ios --rollout 25 --description "My awesome iOS version" # percentage of users this release should be immediately available to (default: 100) 
 ```
 
 ### Android
 
 ```shell
-nativescript-code-push release-nativescript <codepush-ios-appname> android # deploy to Staging
-nativescript-code-push release-nativescript <codepush-ios-appname> android --d Production # deploy to Production (default: Staging)
-nativescript-code-push release-nativescript <codepush-ios-appname> android --targetBinaryVersion ~1.0.0 # release to users running any 1.x version (default: the exact version in AndroidManifest.xml)
+nativescript-code-push release-nativescript <codepush-android-appname> android # deploy to Staging
+nativescript-code-push release-nativescript <codepush-android-appname> android --d Production # deploy to Production (default: Staging)
+nativescript-code-push release-nativescript <codepush-android-appname> android --targetBinaryVersion ~1.0.0 # release to users running any 1.x version (default: the exact version in AndroidManifest.xml)
 ```
 
 ### Tips
 > Make sure to create a release build first, so use the same command that you'd use for app store distribution, just don't send it to the AppStore. You can even webpack bundle and uglify your app, it's all transparent to this plugin. 
 
 > When releasing updates to CodePush, you do not need to bump your app's version since you aren't modifying the app store version at all. CodePush will automatically generate a "label" for each release you make (e.g. `v3`) in order to help identify it within your release history.
 
-There are a few options you may want to pass in:
-
-TODO version nr as an additional argument?
+### Did folks install the update?
+Using a command like this will tell you how many apps have the update installed:
 
 ```shell
-# Release an update that targets users running any 1.*.* binary, as opposed to everyone ("*") or a specific version (1.0.0)
-code-push release CodePushDemo-iOS app "~1.0.0"
-
-# Release an update with a changelog
-code-push release CodePushDemo-iOS app "~1.0.0" --description "Fun times!"
-
-# Release a dev Android build to just 1/4 of your end users
-code-push release CodePushDemo-iOS app "~1.0.0" --description "Fun times!" --rollout 25%
+nativescript-code-push deployment history <codepush-ios-appname> Staging
 ```
 
-The CodePush client supports incremental updates, so even though you are releasing your entire app code on every update,
-your end users will only actually download the files they need. The service handles this automatically so that you can focus on
-creating awesome apps and we can worry about optimizing end user downloads.
-
 ## Testing CodePush packages during development
-
-How to test your codepush version works:
-iOS:
-- sim: `tns run ios`
-- device: use the `--release` flag: `tns run ios --release`
-Android:
-- sim: `tns run android`
-- device: untested (TODO)
-
-
 You may want to play with CodePush before using it in production (smart move!).
-Perform these steps once you've pushed an update and added the `sync` command:
-
-- `tns run [ios|android] --no-watch --clean`
-- kill the app after the update is installed
-- restart the app
+Perform these steps once you've pushed an update and added the `sync` command to your app:
 
-> Note that (at least on Android) that `--no-watch` is really required as otherwise LiveSync will mess with your test!
+- `$ tns run [ios|android] # on an iOS device add the --release flag so LiveSync doesn't mess up your test`
+- kill and restart the app after the update is installed
 
 ## Future enhancements
-
-### Fix reporting
-Using a command like this would normally tell you how many apps have the update installed,
-but that's currently work in progress, so don't freak out if it says 'No installs recorded':
-
-```bash
-code-push deployment history <app-name> Staging
-```
-
-### Support on-resume reloads
-I haven't investigated this possibility yet. If it can be pulled off we'll add an option to the `sync` command.
+Support on-resume reloads. I haven't investigated this possibility yet. If it can be pulled off we'll add an option to the `sync` command.

demo/demoapp/app.css

@@ -1 +1 @@
-@import 'nativescript-theme-core/css/core.light.css';
+@import '~nativescript-theme-core/css/core.light.css';

demo/package.json

@@ -25,7 +25,9 @@
  "codepush-clidev.android": "../../code-push/cli/bin/script/./cli.js release-nativescript CodePushDemo-Android android",
  "codepush-clidev.android.release": "../../code-push/cli/bin/script/./cli.js release-nativescript CodePushDemo-Android android -deploymentName Staging --build --isReleaseBuildType --keystorePath \"/Users/eddyverbruggen/Desktop/werkmap/Android dev X-Services/xservices.keystore\" --keystorePassword YOUR_PASSWORD --keystoreAlias xservices --keystoreAliasPassword YOUR_PASSWORD",
  "codepush-clidev.android.rollback": "../../code-push/cli/bin/script/./cli.js rollback CodePushDemo-Android Staging",
- "codepush-clidev.android.clear": "../../code-push/cli/bin/script/./cli.js deployment clear CodePushDemo-Android Staging"
+ "codepush-clidev.android.clear": "../../code-push/cli/bin/script/./cli.js deployment clear CodePushDemo-Android Staging",
+ "build.plugin": "cd ../src && npm run build && npm run package",
+ "ci.tslint": "npm i && tslint --config '../tslint.json' 'demoapp/**/*.ts' --exclude '**/node_modules/**' --exclude '**/typings/**'"
  },
  "dependencies": {
  "nativescript-code-push": "file:../publish/package/nativescript-code-push-2.0.0.tgz",
@@ -44,7 +46,9 @@
  "karma-nativescript-launcher": "^0.4.0",
  "lazy": "1.0.11",
  "nativescript-dev-typescript": "~0.9.0",
+ "nativescript-dev-webpack": "^0.21.2",
  "tns-platform-declarations": "~5.3.2",
+ "tslint": "~5.4.3",
  "typescript": "~3.2.4"
  }
 }

src/package.json

@@ -28,7 +28,6 @@
  "demo.ios.device": "npm run preparedemo && cd ../demo && tns run ios --release",
  "demo.android": "npm run preparedemo && cd ../demo && tns run android",
  "preparedemo": "npm run build && npm run package && cd ../demo && tns plugin add ../publish/package/*.tgz && rimraf platforms/android",
- "disabled-prepublish": "npm run build",
  "setup": "npm i && cd ../demo && npm i && cd ../src && npm run build",
  "tslint": "tslint *.ts",
  "tslint.demo": "tslint ../demo/app/*.ts",