Skip to content

Commit cf297c4

Browse files
authored
Grammar and formatting
1 parent 87f246a commit cf297c4

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/guides/cicd.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The overall workflow that tests should follow is:
1111
- Set options for single or parallel running.
1212
- Delegate and run tests and gather test-run artifacts.
1313
- Re-run options.
14-
- Generate the Allure reports from results.
14+
- Generate the Allure reports from the results.
1515

1616
## Obtain a Magento instance
1717

@@ -29,7 +29,7 @@ composer create-project --repository=https://repo.magento.com/ magento/project-c
2929

3030
For more information on installing magento see [Install Magento using Composer][].
3131

32-
After installing the Magento instance, you need to set a couple of configurations to the magento instance:
32+
After installing the Magento instance, set a couple of configurations to the Magento instance:
3333

3434
```bash
3535
bin/magento config:set general/locale/timezone America/Los_Angeles
@@ -38,13 +38,13 @@ bin/magento config:set admin/security/use_form_key 0
3838
bin/magento config:set cms/wysiwyg/enabled disabled
3939
```
4040

41-
These help set the `default` state of the Magento instance. If you wish to change the default state of the application (and have updated your tests sufficiently to account for it), this is the step in which you would do it.
41+
These set the default state of the Magento instance. If you wish to change the default state of the application (and have updated your tests sufficiently to account for it), this is the step to do it.
4242

4343
If your magento instance has Two-Factor Authentication enabled, see [Configure 2FA][] to configure MFTF tests.
4444

45-
## Install allure
45+
## Install Allure
4646

47-
This will be required to generate the report after your test runs. See [Allure][] for details.
47+
This is required for generating the report after your test runs. See [Allure][] for details.
4848

4949
## Generate tests
5050

@@ -56,7 +56,7 @@ Generate tests based on what you want to run:
5656
vendor/bin/mftf generate:tests
5757
```
5858

59-
This will generate all tests and a single manifest file under `dev/tests/acceptance/tests/functional/Magento/_generated/testManifest.txt`
59+
This will generate all tests and a single manifest file under `dev/tests/acceptance/tests/functional/Magento/_generated/testManifest.txt`.
6060

6161
### Parallel execution
6262

@@ -66,7 +66,7 @@ To generate all tests for use in parallel nodes:
6666
vendor/bin/mftf generate:tests --config parallel
6767
```
6868

69-
This will generate a folder under `dev/tests/acceptance/tests/functional/Magento/_generated/groups`. This folder contains several `group#.txt` files that can be used later with the `mftf run:manifest` command.
69+
This generates a folder under `dev/tests/acceptance/tests/functional/Magento/_generated/groups`. This folder contains several `group#.txt` files that can be used later with the `mftf run:manifest` command.
7070

7171
## Delegate and run tests
7272

@@ -84,25 +84,25 @@ You can optimize your pipeline by running tests in parallel across multiple node
8484

8585
Tests can be split up into roughly equal running groups using `--config parallel`.
8686

87-
You don't want perform installation on each node again and build it. So, to save time, stash pre-made artifacts from earlier steps and un-stash on the nodes.
87+
You do not want to perform installations on each node again and build it. So, to save time, stash pre-made artifacts from earlier steps and un-stash on the nodes.
8888

8989
The groups can be then distributed on each of the nodes and run separately in an isolated environment.
9090

91-
- Stash artifacts from main node and un-stash on current node.
92-
- Run `vendor/bin/mftf run:manifest <current_group.txt>` on current node.
93-
- Gather artifacts from `dev/tests/acceptance/tests/_output` from current node to main node.
91+
- Stash artifacts from main node and un-stash on current node.
92+
- Run `vendor/bin/mftf run:manifest <current_group.txt>` on current node.
93+
- Gather artifacts from `dev/tests/acceptance/tests/_output` from current node to main node.
9494

9595
### Rerun options
9696

97-
In either single or parallel execution, to re-run failed tests simply add the `run:failed` command after executing a manifest:
97+
In either single or parallel execution, to re-run failed tests, simply add the `run:failed` command after executing a manifest:
9898

9999
```bash
100100
vendor/bin/mftf run:failed
101101
```
102102

103103
### Generate Allure report
104104

105-
In the main node, simply generate using your `<path_to_results>` into a desired output path
105+
In the main node, generate reports using your `<path_to_results>` into a desired output path:
106106

107107
```bash
108108
allure generate <path_to_results> -c -o <path_to_output>

0 commit comments

Comments
 (0)