diff --git a/README.md b/README.md index 65f35fe..81d7024 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,9 @@ Allows you to authenticate with Semaloop using an API key, and remove any existi ### `semaloop build push` -Allows you to push an iOS build artifact (`.app` or `.ipa`) for testing. +Allows you to push a build artifact for testing: an `.app` or `.ipa` for iOS, or a standalone `.apk` for Android. -Android `.apk` uploads are in a limited beta; talk to us before using them. +App bundles (`.aab`), XAPK or APK-set containers, and split APKs aren't accepted. You can specify `--git-repo`, `--git-commit` and `--git-ref`, which allows Semaloop to report the results back as a status check on the commit or pull request. You must have connected your repository to Semaloop via our web dashboard for this to work. All three arguments must be specified. @@ -54,7 +54,7 @@ Some of the `semaloop cli` commands come with a pre-packaged GitHub Action that Allows a build to be pushed to Semaloop. Arguments like `--git-repo` are deduced automatically. See [`actions/build-push`](./actions/build-push/action.yml) for the full list of inputs and outputs. -#### Example +#### iOS example ```yaml - uses: semaloop/cli/actions/build-push@v1 @@ -63,6 +63,15 @@ Allows a build to be pushed to Semaloop. Arguments like `--git-repo` are deduced api-key: ${{ secrets.SEMALOOP_API_KEY }} ``` +#### Android example + +```yaml +- uses: semaloop/cli/actions/build-push@v1 + with: + path: app/build/outputs/apk/release/app-release.apk + api-key: ${{ secrets.SEMALOOP_API_KEY }} +``` + ## Contributing Information on contributing can be found in [CONTRIBUTING.md](./CONTRIBUTING.md). diff --git a/actions/build-push/action.yml b/actions/build-push/action.yml index cd62ca9..1bd2c30 100644 --- a/actions/build-push/action.yml +++ b/actions/build-push/action.yml @@ -1,11 +1,11 @@ # yaml-language-server: $schema=https://json.schemastore.org/github-action.json name: 'Semaloop: push build' -description: 'Upload an iOS build artifact to Semaloop for continuous testing' +description: 'Upload an iOS or Android build artifact to Semaloop for continuous testing' author: 'Semaloop' inputs: path: - description: 'Path to the build artifact to upload (.app or .ipa).' + description: 'Path to the build artifact to upload (.app or .ipa for iOS, or a standalone .apk for Android).' required: true api-key: description: 'Semaloop API key. Store this as a repository or organization secret.' diff --git a/cmd/semaloop/build.go b/cmd/semaloop/build.go index 4f24bb7..dfc19f3 100644 --- a/cmd/semaloop/build.go +++ b/cmd/semaloop/build.go @@ -20,7 +20,7 @@ type BuildCmd struct { // group makes Kong reject a partial set (e.g. --git-repo without --git-commit) // at parse time. type BuildPushCmd struct { - File string `arg:"" help:"Path to the build artifact to upload (.app or .ipa)." type:"path"` + File string `arg:"" help:"Path to the build artifact to upload (.app or .ipa for iOS, or a standalone .apk for Android)." type:"path"` GitRepo string `help:"Source repository (owner/name) the build was produced from." name:"git-repo" and:"gitref"` GitCommit string `help:"Commit SHA the build was produced from." name:"git-commit" and:"gitref"` GitRef string `help:"Git ref (e.g. refs/heads/main) the build was produced from." name:"git-ref" and:"gitref"`