Publish extension as preview on ADO

Author: pkpio

README.md

@@ -9,7 +9,7 @@ These are the minimal checks we run on our own PRs for [SwiftKey](https://play.g
 - In a Azure DevOps Pipeline
 
    ```yml
-    - task: android-app-size-diff@0
+    - task: android-app-size-diff@1
       inputs:
         baseAppPath: test/assets/test.apk
         targetAppPath: test/assets/test.apk
@@ -20,7 +20,7 @@ These are the minimal checks we run on our own PRs for [SwiftKey](https://play.g
 - In a GitHub Workflow
 
    ```yml
-     - uses: microsoft/android-app-size-diff@v0.27
+     - uses: microsoft/android-app-size-diff@v1
        name: Run APK size comparision
        with:
         baseAppPath: test/assets/test.apk

ado-extension.json

@@ -2,25 +2,39 @@
     "manifestVersion": 1,
     "id": "android-app-size-diff-utils",
     "name": "Android app size changes",
-    "version": "0.0.31",
-    "publisher": "PraveenPendyala",
+    "version": "1.0.5",
+    "publisher": "MSSwiftKey",
     "targets": [
         {
             "id": "Microsoft.VisualStudio.Services"
         }
     ],
     "description": "Tools for Android app size changes",
+    "tags": [
+        "Android",
+        "App size",
+        "Developer tools"
+    ],
     "categories": [
         "Azure Pipelines"
     ],
     "icons": {
-        "default": "dist/src/assets/appSizeChangesIcon.png"
+        "default": "src/assets/appSizeChangesIcon.png"
     },
     "files": [
         {
             "path": "dist/src"
         }
     ],
+    "repository": {
+        "type": "git",
+        "uri": "https://github.com/microsoft/android-app-size-diff"
+    },
+    "content": {
+        "details": {
+            "path": "src/assets/overview.md"
+        }
+    },
     "contributions": [
         {
             "id": "android-app-size-diff",
@@ -32,5 +46,8 @@
                 "name": "dist/src"
             }
         }
+    ],
+    "galleryFlags": [
+        "Public"
     ]
 }

package.json

@@ -1,6 +1,6 @@
 {
     "name": "android-app-size-diff",
-    "version": "0.0.32",
+    "version": "1.0.5",
     "description": "Azure DevOps task to measure the size in Android app size by looking at 2 given APKs and AABs",
     "main": "index.js",
     "scripts": {

src/assets/appSizeChangesIcon.png

@@ -0,0 +1,39 @@
+## Usage examples
+
+- In a Azure DevOps Pipeline
+
+   ```yml
+    - task: android-app-size-diff@1
+      inputs:
+        baseAppPath: test/assets/test.apk
+        targetAppPath: test/assets/test.apk
+        summaryOutputPath: summary.md
+      displayName: Run APK size comparision
+   ```
+
+## Inputs
+
+- `baseAppPath`: Path to base apk. This is the app before changes
+  - required: true
+  - default: 'base.apk'
+- `baseAppLabel`: Label to use for the base app in the report
+  - required: false
+  - default: 'Base APK'
+- `targetAppPath`: Path to target apk. This is the app after changes
+  - required: true
+  - default: 'target.apk'
+- `targetAppLabel`: Label to use for the base app in the report
+  - required: false
+  - default: 'Target APK'
+- `summaryOutputPath`: Output file where comparision summary should be written to
+  - required: true
+  - default: 'summary.md'
+- `metrics`: A comma seperated list of size metrics to include in the summary. Possible values are `apkSize`, `installSize`, `dexFiles`, `arscFile`, `nativeLibs`
+  - required: false
+  - default: 'apkSize, installSize, dexFiles, arscFile, nativeLibs'
+- `thresholds`: A comma seperated list of thresholds for each of the metrics in bytes. If this is empty, no thresholding will apply. When this is not empty, the task will fail when any of the given thresholds are crossed
+  - required: false
+  - default: ''
+- `telemetryEnabled`: Set to `false` to disable telemetry
+  - required: false
+  - default: 'true'

src/assets/overview.md

@@ -8,9 +8,9 @@
     "category": "Utility",
     "author": "Microsoft",
     "version": {
-        "Major": 0,
+        "Major": 1,
         "Minor": 0,
-        "Patch": 31
+        "Patch": 5
     },
     "instanceNameFormat": "Android App size change - $(baseAppPath) vs $(targetAppPath)",
     "inputs": [