add readme

Author: Maxim Lobanov

.github/workflows/workflow.yml

@@ -24,8 +24,8 @@ jobs:
     - name: Build
       run: npm run build
 
-    #- name: Run tests
-    #  run: npm run test
+    - name: Run tests
+      run: npm run test
 
-    #- name: Lint
-    #  run: npm run lint
+    - name: Lint
+      run: npm run lint

LICENSE

@@ -0,0 +1,22 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2020 Maxim Lobanov and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,2 +1,58 @@
-# setup-android
-Set up Android tools in GitHub Actions workflow with cache
+# setup-android-tools
+This action is intended to install Android tools on Hosted images in GitHub Actions.  
+It wraps `sdkmanager` and automate [caching](https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows) of installed packages.
+
+### Available parameters
+|Parameter|Description|
+|-|-|
+|`packages`|Specify the package or list of packages to install [Mandatory parameter]If package is already installed, and update is available, action will update it|
+|`cache`|Enable to cache installed packages (see details below)(`true` or `false`)(`false` by default)| 
+
+### Usage
+Install the single package:
+```
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: setup-android-tools
+      uses: maxim-lobanov/setup-android-tools@1.0
+      with:
+        packages: ndk;19.2.5345600
+```
+
+Install multiple packages:
+```
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: maxim-lobanov/setup-android-tools@1.0
+      with:
+        packages: |
+          platforms;android-29
+          platforms;android-30
+          system-images;android-30;google_apis;x86
+```
+
+Install package with enabled cache:
+```
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: maxim-lobanov/setup-android-tools@1.0
+      with:
+        packages: ndk;19.2.5345600
+        cache: true
+```
+
+### Cache packages
+With `cache: true`, action will automatically cache all downloaded packages via [@actions/cache](https://github.com/actions/toolkit/tree/main/packages/cache). In some cases, it could significantly speed up your builds.  
+> Note that GitHub will remove any cache entries that have not been accessed in over 7 days. There is no limit on the number of caches you can store, but the total size of all caches in a repository is limited to 5 GB. If you exceed this limit, GitHub will save your cache but will begin evicting caches until the total size is less than 5 GB.
+
+See "[Caching dependencies to speed up workflows](https://help.github.com/github/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows)" for how caching works.
+
+
+### License
+The scripts and documentation in this project are released under the [MIT License](LICENSE)

action.yml

@@ -1,6 +1,6 @@
 name: 'Setup Android tools'
 author: 'Maxim Lobanov'
-description: 'Set up Android tools in GitHub Actions workflow with cache'
+description: 'Set up Android tools in GitHub Actions workflow with caching'
 inputs:
   packages:
     description: 'Packages to install'

dist/index.js

@@ -47608,6 +47608,9 @@ const run = async () => {
                 core.info("  Package is already installed and update is not required");
                 continue;
             }
+            if (foundPackage.update) {
+                core.info("  Package is already installed but update is required");
+            }
             if (enableCache) {
                 if (await restoreCache(sdkmanager, foundPackage)) {
                     core.info("  Package is restored from cache");

src/setup-android-tools.ts

@@ -68,6 +68,10 @@ const run = async(): Promise<void> => {
                 continue;
             }
 
+            if (foundPackage.update) {
+                core.info("  Package is already installed but update is required");
+            }
+
             if (enableCache) {
                 if (await restoreCache(sdkmanager, foundPackage)) {
                     core.info("  Package is restored from cache");

src/utils.ts

@@ -16,4 +16,4 @@ export const getBooleanInput = (inputName: string): boolean => {
 
 export const getPackageCacheKey = (packageInfo: AndroidPackageInfo): string => {
     return `${packageInfo.name} ${packageInfo.remoteVersion}/1`;
-}
+};