diff --git a/README.md b/README.md index 68d5d07..4183530 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,24 @@ -
+This action exposes the version name and version code in your Android app's `build.gradle` file as env vars. -# Create a JavaScript Action using TypeScript +There are only three inputs: +1. `path`: Specify the path to your `build.gradle`. This one is optional, if not specified it defaults to `app/build.gradle`, which is the location this file is most commonly found if you pull an Android repo during your CI flow. -Use this template to bootstrap the creation of a TypeScript action.:rocket: +2. `expose-version-code`: This expects either **'true'** or **'false'**. Set it to **'true'** if you want the **version code** exposed. +3. `expose-version-name`: This also expects either **'true'** or **'false'**. Set it to **'true'** if you want the **version name** exposed. -This template includes compilation support, tests, a validation workflow, publishing, and versioning guidance. - -If you are new, there's also a simpler introduction. See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action) - -## Create an action from this template - -Click the `Use this Template` and provide the new repo details for your action - -## Code in Main - -> First, you'll need to have a reasonably modern version of `node` handy. This won't work with versions older than 9, for instance. - -Install the dependencies -```bash -$ npm install -``` - -Build the typescript and package it for distribution -```bash -$ npm run build && npm run package +### Example: ``` - -Run the tests :heavy_check_mark: -```bash -$ npm test - - PASS ./index.test.js - ✓ throws invalid number (3ms) - ✓ wait 500 ms (504ms) - ✓ test runs (95ms) - -... +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v2 + - name: Expose version name + uses: michpohl/android-expose-version-name-action@v1.0.0 + with: + expose-version-name: 'true' + expose-version-code: 'false' ``` -## Change action.yml - -The action.yml contains defines the inputs and output for your action. - -Update the action.yml with your name, description, inputs and outputs for your action. - -See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions) - -## Change the Code - -Most toolkit and CI/CD operations involve async operations so the action is run in an async function. - -```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 so we will checkin the packed dist folder. - -Then run [ncc](https://github.com/zeit/ncc) and push the results: -```bash -$ npm run package -$ git add dist -$ git commit -a -m "prod dependencies" -$ git push origin releases/v1 -``` - -Note: We recommend using the `--license` option for ncc, which will create a license file for all of the production node modules used in your project. - -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 `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml)) - -```yaml -uses: ./ -with: - milliseconds: 1000 -``` - -See the [actions tab](https://github.com/actions/typescript-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 latest V1 action +Depending on your set values, and if the `build.gradle` file is found in the specified location, the action will expose the **version code** as an env var named `ANDROID_VERSION_CODE` and the **version name** as an env var named `ANDROID_VERSION_NAME`. diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts deleted file mode 100644 index 62ac756..0000000 --- a/__tests__/main.test.ts +++ /dev/null @@ -1,28 +0,0 @@ -import {wait} from '../src/wait' -import * as process from 'process' -import * as cp from 'child_process' -import * as path from 'path' - -test('throws invalid number', async () => { - const input = parseInt('foo', 10) - await expect(wait(input)).rejects.toThrow('milliseconds not a number') -}) - -test('wait 500 ms', async () => { - const start = new Date() - await wait(500) - const end = new Date() - var delta = Math.abs(end.getTime() - start.getTime()) - expect(delta).toBeGreaterThan(450) -}) - -// shows how the runner will run a javascript action with env / stdout protocol -test('test runs', () => { - process.env['INPUT_MILLISECONDS'] = '500' - const np = process.execPath - const ip = path.join(__dirname, '..', 'lib', 'main.js') - const options: cp.ExecFileSyncOptions = { - env: process.env - } - console.log(cp.execFileSync(np, [ip], options).toString()) -}) diff --git a/action.yml b/action.yml index 99c36f4..ac5a2e2 100644 --- a/action.yml +++ b/action.yml @@ -1,17 +1,17 @@ -name: Your name here -description: Provide a description here -author: Your name or organization here +name: Expose Android version code and name +description: Finds the version code and version name in your build.gradle file and publishes it as env vars. +author: Michael Pohl inputs: path: required: false - description: Path to your app build.gradle + description: Path to your app's build.gradle default: app/build.gradle expose-version-code: required: true - description: expose version code + description: Expose version code expose-version-name: required: true - description: expose version name + description: Expose version name runs: using: node12 main: dist/index.js diff --git a/src/wait.ts b/src/wait.ts deleted file mode 100644 index b169d9a..0000000 --- a/src/wait.ts +++ /dev/null @@ -1,9 +0,0 @@ -export async function wait(milliseconds: number): Promise