Skip to content

Commit 82286c4

Browse files
author
Amanda Butler
authored
Edit ci.md
Add final edits, mostly for parallelism and consistent tense.
1 parent 3b75a5c commit 82286c4

File tree

1 file changed

+30
-30
lines changed
  • docs/reference/contributing/guidelines

1 file changed

+30
-30
lines changed
Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
<h2 id="ci">Continuous integration</h2>
1+
<h2 id="ci">Continuous integration (CI) testing</h2>
22

3-
Continuous integration (CI) means mainly automatic testing for pull requests.
3+
Continuous integration (CI) testing is an integral part of the Mbed OS contribution workflow. CI testing refers mainly to automatic testing for pull requests.
44

55
### Travis CI
66

7-
In Mbed OS [Travis CI](https://travis-ci.org/ARMmbed/mbed-os) is used as primary automatic testing and checking run environment.
7+
Mbed OS uses [Travis CI](https://travis-ci.org/ARMmbed/mbed-os) as the primary automatic testing and checking run environment.
88

9-
Travis configuration is located in the [.travis.yml](https://github.com/ARMmbed/mbed-os/blob/master/.travis.yml) file in Mbed OS root directory. Mbed OS uses public travis so test results are publicly available and there are public [documentation available](https://docs.travis-ci.com/).
9+
Travis configuration is located in the [.travis.yml](https://github.com/ARMmbed/mbed-os/blob/master/.travis.yml) file in the Mbed OS root directory. Mbed OS uses public Travis, so [test results and documentation](https://docs.travis-ci.com/) are publicly available.
1010

1111
#### Tests
1212

13-
- **continuous-integration/travis-ci/pr** - Travis run main.
14-
- **travis-ci/astyle** - Check code style using [astyle](http://astyle.sourceforge.net/).
13+
- **continuous-integration/travis-ci/pr** - Travis runs main.
14+
- **travis-ci/astyle** - Checks code style using [astyle](http://astyle.sourceforge.net/).
1515
- **travis-ci/docs** - [Doxygen](http://www.doxygen.org/) and naming checks:
16-
- Assert that the Doxygen build produces no warnings.
17-
- Assert that all binary libraries are named correctly.
18-
- Assert that all assembler files are named correctly.
19-
- **travis-ci/doxy-spellcheck** - Check Doxygen comments for spelling errors. Runs on header files in:
16+
- Asserts the Doxygen build produces no warnings.
17+
- Asserts all binary libraries are named correctly.
18+
- Asserts all assembler files are named correctly.
19+
- **travis-ci/doxy-spellcheck** - Checks Doxygen comments for spelling errors. Runs on header files in:
2020
- Drivers.
2121
- Platform.
2222
- RTOS.
2323
- Events.
2424
- Features/netsocket.
25-
- **travis-ci/events** - Check that Mbed OS compiles and run events tests.
26-
- **travis-ci/gitattributestest** - Check there are no changes after clone. This checks that `.gitattributes` is used correctly.
27-
- **travis-ci/licence_check** - Check there is no GPL licence text in the code.
28-
- **travis-ci/littlefs** - Test littlefs without embedded hardware.
29-
- **travis-ci/tools-py2.7** - Run Python tools tests with Python 2.7.
25+
- **travis-ci/events** - Checks that Mbed OS compiles and run events tests.
26+
- **travis-ci/gitattributestest** - Checks there are no changes after clone. This checks that `.gitattributes` is used correctly.
27+
- **travis-ci/licence_check** - Checks there is no GPL license text in the code.
28+
- **travis-ci/littlefs** - Tests littlefs without embedded hardware.
29+
- **travis-ci/tools-py2.7** - Runs Python tools tests with Python 2.7.
3030
- **travis-ci/psa-autogen** - Runs PSA SPM code generator.
3131
- Asserts that all PSA manifests in the tree are in correct form.
3232
- Asserts that no changes need to be made.
@@ -40,26 +40,26 @@ How it works:
4040
- Jenkins uses a [scripted pipeline syntax](https://jenkins.io/doc/book/pipeline/).
4141
- Jenkins scripts are not publicly available. There is a Jenkinsfile in the Mbed OS root folder, but that is just a trigger for tests.
4242
- Jenkins selects required tests dynamically based on the code changes. For example, no tests execute if only markdown (.md) files change.
43-
- Jenkins runs a first small number of tests to provide fast feedback, and then it runs additional tests.
43+
- Jenkins first runs a small number of tests to provide fast feedback, and then it runs additional tests.
4444

4545
#### Tests
4646

4747
- **continuous-integration/jenkins/pr-head** - Jenkins main pipeline script execution status.
48-
- **jenkins-ci/build-ARM** - Build Mbed OS and examples with [ARM compiler](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler). Related commands:
48+
- **jenkins-ci/build-ARM** - Builds Mbed OS and examples with the [ARM compiler](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler). Related commands:
4949
- `mbed test --compile -t <toolchain> -m <target> `.
5050
- `python -u mbed-os/tools/test/examples/examples.py compile <toolchain> --mcu <target>`.
51-
- **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM.
52-
- **jenkins-ci/build-IAR** - Build Mbed OS and examples with IAR.
53-
- **jenkins-ci/cloud-client-test** - Test the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using the [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example).
54-
- **jenkins-ci/dynamic-memory-usage** - Report dynamic memory use compared to the master branch.
55-
- **jenkins-ci/exporter** - Export and build exported code. Related commands:
51+
- **jenkins-ci/build-GCC_ARM** - Builds Mbed OS and examples with GCC_ARM.
52+
- **jenkins-ci/build-IAR** - Builds Mbed OS and examples with IAR.
53+
- **jenkins-ci/cloud-client-test** - Tests the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using the [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example).
54+
- **jenkins-ci/dynamic-memory-usage** - Reports dynamic memory use compared to the master branch.
55+
- **jenkins-ci/exporter** - Exports and builds exported code. Related commands:
5656
- `python -u mbed-os/tools/test/examples/examples.py export <exporter> --mcu <target>`.
57-
- **jenkins-ci/greentea-test** - Run [greentea tests](../tools/greentea-testing-applications.html).
58-
- **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with [ARM compiler](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler). Related commands:
57+
- **jenkins-ci/greentea-test** - Runs [greentea tests](../tools/greentea-testing-applications.html).
58+
- **jenkins-ci/mbed2-build-ARM** - Builds Mbed OS 2 with the [ARM compiler](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler). Related commands:
5959
- `python tools/build_release.py -p <target> -t <toolchain>`.
60-
- **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM.
61-
- **jenkins-ci/mbed2-build-IAR** - Build Mbed OS 2 with IAR.
62-
- **jenkins-ci/unittests** - Run [unit tests](../tools/unit-testing.html).
63-
- **tools-test-linux** - Test that tools work on Linux.
64-
- **tools-test-mac** - Test that tools work on macOS.
65-
- **tools-test-windows** - Test that tools work on Windows.
60+
- **jenkins-ci/mbed2-build-GCC_ARM** - Builds Mbed OS 2 with GCC_ARM.
61+
- **jenkins-ci/mbed2-build-IAR** - Builds Mbed OS 2 with IAR.
62+
- **jenkins-ci/unittests** - Runs [unit tests](../tools/unit-testing.html).
63+
- **tools-test-linux** - Tests tools work on Linux.
64+
- **tools-test-mac** - Tests tools work on macOS.
65+
- **tools-test-windows** - Tests tools work on Windows.

0 commit comments

Comments
 (0)