Merge pull request #7 from microsoft/add-threshold-support

Added support for metrics and thresholds

Author: pkpio

.github/workflows/ci-tests.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, macos-latest] # also include windows-latest once npm install is fixed
 
     steps:
     - uses: actions/checkout@v1

.github/workflows/gh-action-test.yml

@@ -17,9 +17,13 @@ jobs:
     - name: Run App size diff
       uses: ./
       with:
-        baseAppPath: 'test/assets/test.apk'
-        targetAppPath: 'test/assets/test.apk'
+        baseAppPath: test/assets/test.apk
+        baseAppLabel: Base app
+        targetAppPath: test/assets/test.apk
+        targetAppLabel: Target app
         summaryOutputPath: summary.md
+        metrics: apkSize, installSize, arscFile, nativeLibs, dexFiles
+        thresholds: 10, 10, 10, 10, 10
 
     - name: Print summary
       run: cat summary.md

README.md

@@ -28,6 +28,32 @@ This is currently in very early stages so, features offered are very limited. Se
         summaryOutputPath: summary.md
    ```
 
+## Usage API
+The API to use the GitHub action or Azure DevOps task is similar
+
+### 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: ''
 
 # Contributing
 

action.yml

@@ -4,14 +4,30 @@ inputs:
   baseAppPath:
     description: 'Path to base apk. This is the app before changes'
     required: true
-    default: ''
+    default: 'base.apk'
+  baseAppLabel: 
+    description: 'Label to use for the base app in the report'
+    required: false
+    default: 'Base APK'
   targetAppPath:
     description: 'Path to target apk. This is the app after changes'
     required: true
-    default: ''
+    default: 'target.apk'
+  targetAppLabel: 
+    description: 'Label to use for the target app in the report'
+    required: false
+    default: 'Target APK'
   summaryOutputPath:
     description: 'Output file where comparision summary should be written to'
     required: true
+    default: 'summary.md'
+  metrics:
+    description: '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:
+    description: '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: ''
 runs:
   using: 'node12'

ado-extension.json

@@ -2,7 +2,7 @@
     "manifestVersion": 1,
     "id": "android-app-size-diff-utils",
     "name": "Android app size changes",
-    "version": "0.0.25",
+    "version": "0.0.27",
     "publisher": "PraveenPendyala",
     "targets": [
         {

ado-task-test.yml

@@ -8,8 +8,12 @@ steps:
 - task: android-app-size-diff@0
   inputs:
     baseAppPath: test/assets/test.apk
+    baseAppLabel: Base app
     targetAppPath: test/assets/test.apk
+    targetAppLabel: Target app
     summaryOutputPath: summary.md
+    metrics: apkSize, installSize, arscFile, nativeLibs, dexFiles
+    thresholds: 10, 10, 10, 10, 10
   displayName: 'Run APK size comparision'
 
 - script: cat summary.md