Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand All @@ -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).
Expand Down
4 changes: 2 additions & 2 deletions actions/build-push/action.yml
Original file line number Diff line number Diff line change
@@ -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.'
Expand Down
2 changes: 1 addition & 1 deletion cmd/semaloop/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"`
Expand Down
Loading