Skip to content

Commit f3bb5c2

Browse files
committed
Add documentation to <magentoCron> command
1 parent f618972 commit f3bb5c2

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/test/actions.md

+23
Original file line numberDiff line numberDiff line change
@@ -1274,6 +1274,29 @@ Attribute|Type|Use|Description
12741274
<magentoCLI command="indexer:reindex" stepKey="reindex"/>
12751275
```
12761276

1277+
### magentoCron
1278+
1279+
Used to execute Magento Cron jobs. Groups may be provided optionally. Internal mechanism of `<magentoCron>` ensures that Cron Job of single group is ran with 60 seconds interval.
1280+
1281+
Attribute|Type|Use|Description
1282+
---|---|---|---
1283+
`groups`|string |optional| Run only specified groups of Cron Jobs
1284+
`arguments`|string |optional| Unescaped arguments to be passed in with the CLI command.
1285+
`timeout`|string|optional| Number of seconds CLI command can run without outputting anything.
1286+
`stepKey`|string|required| A unique identifier of the action.
1287+
`before`|string|optional| `stepKey` of action that must be executed next.
1288+
`after`|string|optional| `stepKey` of preceding action.
1289+
1290+
1291+
#### Example
1292+
```xml
1293+
<magentoCron stepKey="runStagingCronJobs" groups="staging"/>
1294+
<!-- No interval here -->
1295+
<magentoCron stepKey="runIndexCronJobs" groups="index"/>
1296+
<!-- 60 seconds interval takes place here -->
1297+
<magentoCron stepKey="runAllCronJobs"/>
1298+
```
1299+
12771300
### makeScreenshot
12781301

12791302
See [makeScreenshot docs on codeception.com](http://codeception.com/docs/modules/WebDriver#makeScreenshot).

0 commit comments

Comments
 (0)