Finished action

Adding the monolith node_modules dir for deployment
This commit is contained in:
Drew Heavner
2019-12-04 09:58:34 -05:00
parent d665ce5758
commit a29f8cd536
8629 changed files with 2587149 additions and 190 deletions

123
README.md
View File

@@ -1,113 +1,50 @@
# Create a JavaScript Action using TypeScript
# Upload Android release to the Play Store
Use this template to bootstrap the creation of a JavaScript action.:rocket:
This action will help you upload an Android `.apk` or `.aab` (Android App Bundle) file to the Google Play Console using the Google Play Developer API v3.
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)
### `serviceAccountJson`
## Create an action from this template
**Required:** The service account json private key file to authorize the upload request
Click the `Use this Template` and provide the new repo details for your action
### `packageName`
## Code in Master
**Required:** The package name, or Application Id, of the app you are uploading
Install the dependencies
```bash
$ npm install
```
### `releaseFile`
Build the typescript
```bash
$ npm run build
```
**Required:** The Android release file to upload (.apk or .aab)
Run the tests :heavy_check_mark:
```bash
$ npm test
### `track`
PASS ./index.test.js
✓ throws invalid number (3ms)
✓ wait 500 ms (504ms)
✓ test runs (95ms)
**Required:** The track in which you want to assign the uploaded app.
**Default:** `production`
_Values:_ `alpha`, `beta`, `internal`, `production`
...
```
### `userFraction`
## Change action.yml
Portion of users who should get the staged version of the app. Accepts values between 0.0 and 1.0 (exclusive-exclusive). Omitting this value will execute a full rollout.
The action.yml contains defines the inputs and output for your action.
### `whatsNewDirectory`
Update the action.yml with your name, description, inputs and outputs for your action.
The directory of localized whats new files to upload as the release notes. Using the pattern `whatsnew-<LOCALE>`
i.e. `whatsnew-en-US`
See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
### `mappingFile`
## Change the Code
The mapping.txt file used to de-obfuscate your stack traces from crash reports
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. 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: r0adkll/upload-google-play@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
```
serviceAccountJson: ${{ SERVICE_ACCOUNT_JSON }}
packageName: com.example.MyApp
releaseFile: ${{ SIGNED_RELEASE_FILE}}
track: beta
userFraction: 0.33
whatsNewDirectory: /distribution/whatsnew
mappingFile: /app/build/outputs/mapping/release/mapping.txt
```