Initial Release

README.md

@@ -1,113 +1,47 @@
-# Create a JavaScript Action using TypeScript
+# Sign Android Release Action
 
-Use this template to bootstrap the creation of a JavaScript action.:rocket:
+This action will help you sign an Android `.apk` or `.aab` (Android App Bundle) file for release.
 
-This template includes compilication support, tests, a validation workflow, publishing, and versioning guidance.  
+## Inputs
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+### `releaseDirectory`
 
-## Create an action from this template
+**Required:** The relative directory path in your project where your Android release file will be located
 
-Click the `Use this Template` and provide the new repo details for your action
+### `signingKeyBase64`
 
-## Code in Master
+**Required:** The base64 encoded signing key used to sign your app
 
-Install the dependencies  
-```bash
-$ npm install
-```
+### `alias`
 
-Build the typescript
-```bash
-$ npm run build
-```
+**Required:** The alias of your signing key 
 
-Run the tests :heavy_check_mark:  
-```bash
-$ npm test
+### `keyStorePassword`
 
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
+**Required:** The password to your signing keystore
 
-...
-```
+### `keyPassword`
 
-## Change action.yml
+**Required:** The private key password for your signing keystore
 
-The action.yml contains defines the inputs and output for your action.
+## Outputs
 
-Update the action.yml with your name, description, inputs and outputs for your action.
+### `signedReleaseFile`
 
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
+The path to the signed release file from this action
 
-## Change the Code
+### ENV: `SIGNED_RELEASE_FILE`
 
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
+This also set's an environment variable that points to the signed release file
 
-```javascript
-import * as core from '@actions/core';
-...
-
-async function run() {
-  try { 
-      ...
-  } 
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
-
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
-
-## Publish to a distribution branch
-
-Actions are run from GitHub repos.  We will create a releases branch and only checkin production modules (core in this case). 
-
-Comment out node_modules in .gitignore and create a releases/v1 branch
-```bash
-# comment out in distribution branches
-# node_modules/
-```
-
-```bash
-$ git checkout -b releases/v1
-$ git commit -a -m "prod dependencies"
-```
-
-```bash
-$ npm prune --production
-$ git add node_modules
-$ git commit -a -m "prod dependencies"
-$ git push origin releases/v1
-```
-
-Your action is now published! :rocket: 
-
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
-
-## Validate
-
-You can now validate the action by referencing the releases/v1 branch
+## Example usage
 
 ```yaml
-uses: actions/typescript-action@releases/v1
+uses: actions/sign-android-release@v1
 with:
-  milliseconds: 1000
-```
-
-See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
-
-## Usage:
-
-After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and tested action
-
-```yaml
-uses: actions/typescript-action@v1
-with:
-  milliseconds: 1000
-```
+  releaseDirectory: /app/build/outputs/apk/release
+  signingKeyBase64: ${{ secrets.SIGNING_KEY }}
+  alias: ${{ secrets.ALIAS }}
+  keyStorePassword: ${{ secrets.KEY_STORE_PASSWORD }}
+  keyPassword: ${{ secrets.KEY_PASSWORD }}
+```