Skip to content

Commit 2d0c22c

Browse files
authored
Merge pull request #3 from devicecloud-dev/readme-updates
readme updates
2 parents b23319c + 2b72592 commit 2d0c22c

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Device Cloud Action
22

3-
This action is a swap in replacement for the [Maestro Cloud Action](https://github.com/mobile-dev-inc/action-maestro-cloud)
3+
This action is a swap in replacement for the [Maestro Cloud Action](https://github.com/mobile-dev-inc/action-maestro-cloud). The readme is identical where practical to make the switch as straightforward as possible.
44

55
It lets you run your flows on [devicecloud.dev](https://devicecloud.dev) to save money and access extra features.
66

@@ -62,10 +62,10 @@ jobs:
6262
- uses: devicecloud-dev/device-cloud-for-maestro@v1
6363
with:
6464
api-key: ${{ secrets.DCD_API_KEY }}
65-
app-file: <app_name>.app
65+
app-file: <app_name>.zip
6666
```
6767

68-
`app-file` should point to an Apple silicon compatible Simulator .app build, either directly to the file or a glob pattern matching the file name. When using a pattern, the first matched file will be used.
68+
`app-file` should point to an Apple silicon compatible Simulator .app build which has then been zipped, either directly to the file or a glob pattern matching the file name. When using a pattern, the first matched file will be used.
6969

7070
# Custom workspace location
7171

@@ -81,11 +81,7 @@ By default, the action is looking for a `.maestro` folder with Maestro flows in
8181

8282
# Custom name
8383

84-
A name will automatically be provided according to the following order:
85-
86-
1. If it is a Pull Request, use Pull Request title as name
87-
2. If it is a normal push, use commit message as name
88-
3. If for some reason the commit message is not available, use the commit SHA as name
84+
The run name will automatically be populated with the commit message.
8985

9086
If you want to override this behaviour and specify your own name, you can do so by setting the `name` argument:
9187

@@ -125,7 +121,7 @@ If you want to pass environment variables along with your upload, add a multilin
125121

126122
# Using tags
127123

128-
You can use Maestro [Tags](https://maestro.mobile.dev/cli/tags) to filter which Flows to send to Maestro Cloud:
124+
You can use Maestro [Tags](https://maestro.mobile.dev/cli/tags) to filter which Flows to send to device cloud:
129125

130126
You can either pass a single value, or comma-separated (`,`) values.
131127

@@ -142,7 +138,7 @@ You can either pass a single value, or comma-separated (`,`) values.
142138

143139
You can specify what Android API level to use when running in devicecloud.dev using the `android-api-level` parameter.
144140

145-
The default API level is 33. [Refer to docs](https://docs.devicecloud.dev/getting-started/devices-configuration) for available Android emulator API levels.
141+
The default API level is 34. [Refer to docs](https://docs.devicecloud.dev/getting-started/devices-configuration) for available Android emulator API levels.
146142

147143
```yaml
148144
- uses: devicecloud-dev/device-cloud-for-maestro@v1

0 commit comments

Comments
 (0)