From 3878590428e8a99e0a5c1814d3a8f1c766300234 Mon Sep 17 00:00:00 2001 From: Olli-Pekka Puolitaival Date: Tue, 9 Oct 2018 16:01:06 +0300 Subject: [PATCH 1/9] Ci documentation added --- docs.json | 4 +++ docs/reference/contributing/guidelines/ci.md | 25 +++++++++++++++++++ .../contributing/guidelines/workflow.md | 2 +- 3 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 docs/reference/contributing/guidelines/ci.md diff --git a/docs.json b/docs.json index 177b1faebb..a8a438c07b 100644 --- a/docs.json +++ b/docs.json @@ -741,6 +741,10 @@ { "type": "markdown", "url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/reference/contributing/guidelines/workflow.md" + }, + { + "type": "markdown", + "url": "https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/reference/contributing/guidelines/ci.md" } ] } diff --git a/docs/reference/contributing/guidelines/ci.md b/docs/reference/contributing/guidelines/ci.md new file mode 100644 index 0000000000..b6f758bdfb --- /dev/null +++ b/docs/reference/contributing/guidelines/ci.md @@ -0,0 +1,25 @@ +## Continuous integration + +Continuous integration (CI) means mainly automatic testing for pull requests + +### Travis CI + +In Mbed OS [Travis CI](https://travis-ci.org/) is used as primary automatic testing and checking run environment. + +Travis configuration is located in .travis.yml file in Mbed OS root directory. Mbed OS use public travis so test results are publicly available and there are public [documentation available](https://docs.travis-ci.com/). + +### Jenkins + +[Jenkins](https://jenkins.io/) is used to run tests behind firewall. There are multiple reasons to run tests in Jenkins but typically those are related to high amount of concurrent builds or shared secrets. + +#### How it works: +* Jenkins uses [scripted pipeline syntax](https://jenkins.io/doc/book/pipeline/) +* There is Jenkinsfile in Mbed OS root folder but that is just trigger for tests. Jenkins scripts are not publicly available at the moment. +* Jenkins select required tests dynamically based on the code changes. For example. no tests are executed if only markdown (.md) file changes +* Jenkins run first small amount of tests to provide fast feedback and then more tests + +#### What kind of tests jenkins runs? + +* **continuous-integration/jenkins/pr-head** Jenkins main pipeline script execution status +* **jenkins-ci/cloud-client-test** - Test the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example) +* **jenkins-ci/unittests** - Run [unit tests](/docs/tools/testing/unit_testing.html) diff --git a/docs/reference/contributing/guidelines/workflow.md b/docs/reference/contributing/guidelines/workflow.md index e1a3ebbef3..507b50e017 100644 --- a/docs/reference/contributing/guidelines/workflow.md +++ b/docs/reference/contributing/guidelines/workflow.md @@ -186,7 +186,7 @@ Time: 3 days for reviewers to leave feedback after the maintainers add the "need #### The CI (Continuous Integration) testing -There are many CI systems available. Which CI tests we run against a particular pull request depends on the effect that pull request has on the code base. Irrespective of which CI tests run, Mbed OS has an all green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request. +There are many [CI systems available](/docs/reference/contributing/guidelines/ci.html). Which CI tests we run against a particular pull request depends on the effect that pull request has on the code base. Irrespective of which CI tests run, Mbed OS has an all green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request. Label: `needs: review` Time: 1 day for CI to complete and report back results. From be2b507d70bd14693e8b9f4f4a5532f602366476 Mon Sep 17 00:00:00 2001 From: Olli-Pekka Puolitaival Date: Wed, 10 Oct 2018 16:17:24 +0300 Subject: [PATCH 2/9] Add travis test list and links --- docs/reference/contributing/guidelines/ci.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/reference/contributing/guidelines/ci.md b/docs/reference/contributing/guidelines/ci.md index b6f758bdfb..35432d91d8 100644 --- a/docs/reference/contributing/guidelines/ci.md +++ b/docs/reference/contributing/guidelines/ci.md @@ -4,9 +4,23 @@ Continuous integration (CI) means mainly automatic testing for pull requests ### Travis CI -In Mbed OS [Travis CI](https://travis-ci.org/) is used as primary automatic testing and checking run environment. +In Mbed OS [Travis CI](https://travis-ci.org/ARMmbed/mbed-os) is used as primary automatic testing and checking run environment. -Travis configuration is located in .travis.yml file in Mbed OS root directory. Mbed OS use public travis so test results are publicly available and there are public [documentation available](https://docs.travis-ci.com/). +Travis configuration is located in [.travis.yml](https://github.com/ARMmbed/mbed-os/blob/master/.travis.yml) file in Mbed OS root directory. Mbed OS use public travis so test results are publicly available and there are public [documentation available](https://docs.travis-ci.com/). + +#### Tests + +* **continuous-integration/travis-ci/pr** - Main run main +* **travis-ci/astyle** - Check code style using [astyle](http://astyle.sourceforge.net/) +* **travis-ci/docs** - [Doxygen](http://www.doxygen.org/) and naming checks: +** Assert that the Doxygen build produced no warnings +** Assert that all binary libraries are named correctly +** Assert that all assebler files are named correctly +* **travis-ci/events** - Check that Mbed OS compiles and run events tests +* **travis-ci/gitattributestest** - Check that no changes after clone. This check that .gitattributes is used right way +* **travis-ci/licence_check** - Checking that there is no GPL licence text in code +* **travis-ci/littlefs** - Testing littlefs without embedded hardware +* **travis-ci/tools-py2.7** - Run python tools tests with python 2.7 ### Jenkins @@ -18,7 +32,7 @@ Travis configuration is located in .travis.yml file in Mbed OS root directory. M * Jenkins select required tests dynamically based on the code changes. For example. no tests are executed if only markdown (.md) file changes * Jenkins run first small amount of tests to provide fast feedback and then more tests -#### What kind of tests jenkins runs? +#### Tests * **continuous-integration/jenkins/pr-head** Jenkins main pipeline script execution status * **jenkins-ci/cloud-client-test** - Test the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example) From c2778a03211b237a46499e3467f20c100921dd08 Mon Sep 17 00:00:00 2001 From: Olli-Pekka Puolitaival Date: Mon, 22 Oct 2018 14:19:48 +0300 Subject: [PATCH 3/9] Add checks which are coming soon --- docs/reference/contributing/guidelines/ci.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/reference/contributing/guidelines/ci.md b/docs/reference/contributing/guidelines/ci.md index 35432d91d8..6b555d1647 100644 --- a/docs/reference/contributing/guidelines/ci.md +++ b/docs/reference/contributing/guidelines/ci.md @@ -37,3 +37,16 @@ Travis configuration is located in [.travis.yml](https://github.com/ARMmbed/mbed * **continuous-integration/jenkins/pr-head** Jenkins main pipeline script execution status * **jenkins-ci/cloud-client-test** - Test the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example) * **jenkins-ci/unittests** - Run [unit tests](/docs/tools/testing/unit_testing.html) +* **jenkins-ci/greentea-test** - Run [greentea tests](/docs/tools/testing/testing_greentea.html) +* **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM. Related commands: + * `mbed test --compile -t -m ` + * `python -u mbed-os/tools/test/examples/examples.py compile --mcu ` +* **jenkins-ci/build-ARM** - Build Mbed OS and examples with ARM +* **jenkins-ci/build-IAR** - Build Mbed OS and examples with IAR +* **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM. Related commands: + * `python tools/build_release.py -p -t ` +* **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with ARM +* **jenkins-ci/mbed2-build-IAR** - Build Mbed OS 2 with IAR +* **jenkins-ci/exporter** - Export and build exported code. Related commands: + * `python -u mbed-os/tools/test/examples/examples.py export --mcu ` +* **jenkins-ci/dynamic-memory-usage** - Report dynamic memory usage compared to the master branch From 7637fc87f9d38f113c612a0a57df743e12f75d96 Mon Sep 17 00:00:00 2001 From: Olli-Pekka Puolitaival Date: Mon, 22 Oct 2018 16:31:30 +0300 Subject: [PATCH 4/9] Sort checks and add tools tests --- docs/reference/contributing/guidelines/ci.md | 23 +++++++++++--------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/reference/contributing/guidelines/ci.md b/docs/reference/contributing/guidelines/ci.md index 6b555d1647..95a3ebffc7 100644 --- a/docs/reference/contributing/guidelines/ci.md +++ b/docs/reference/contributing/guidelines/ci.md @@ -35,18 +35,21 @@ Travis configuration is located in [.travis.yml](https://github.com/ARMmbed/mbed #### Tests * **continuous-integration/jenkins/pr-head** Jenkins main pipeline script execution status -* **jenkins-ci/cloud-client-test** - Test the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example) -* **jenkins-ci/unittests** - Run [unit tests](/docs/tools/testing/unit_testing.html) -* **jenkins-ci/greentea-test** - Run [greentea tests](/docs/tools/testing/testing_greentea.html) -* **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM. Related commands: +* **jenkins-ci/build-ARM** - Build Mbed OS and examples with ARM * `mbed test --compile -t -m ` * `python -u mbed-os/tools/test/examples/examples.py compile --mcu ` -* **jenkins-ci/build-ARM** - Build Mbed OS and examples with ARM +* **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM. Related commands: * **jenkins-ci/build-IAR** - Build Mbed OS and examples with IAR -* **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM. Related commands: - * `python tools/build_release.py -p -t ` -* **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with ARM -* **jenkins-ci/mbed2-build-IAR** - Build Mbed OS 2 with IAR +* **jenkins-ci/cloud-client-test** - Test the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example) +* **jenkins-ci/dynamic-memory-usage** - Report dynamic memory usage compared to the master branch * **jenkins-ci/exporter** - Export and build exported code. Related commands: * `python -u mbed-os/tools/test/examples/examples.py export --mcu ` -* **jenkins-ci/dynamic-memory-usage** - Report dynamic memory usage compared to the master branch +* **jenkins-ci/greentea-test** - Run [greentea tests](/docs/tools/testing/testing_greentea.html) +* **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with ARM + * `python tools/build_release.py -p -t ` +* **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM. Related commands: +* **jenkins-ci/mbed2-build-IAR** - Build Mbed OS 2 with IAR +* **jenkins-ci/unittests** - Run [unit tests](/docs/tools/testing/unit_testing.html) +* **tools-test-linux** - Test that tools works on Linux +* **tools-test-mac** - Test that tools works on Mac +* **tools-test-windows** - Test that tools works on Windows From 10ee044dc0ebbeb51fbf773f71043dff34238a0b Mon Sep 17 00:00:00 2001 From: Olli-Pekka Puolitaival Date: Wed, 24 Oct 2018 15:15:27 +0300 Subject: [PATCH 5/9] Changes based on github comments --- docs/reference/contributing/guidelines/ci.md | 20 +++++++++---------- .../contributing/guidelines/workflow.md | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/reference/contributing/guidelines/ci.md b/docs/reference/contributing/guidelines/ci.md index 95a3ebffc7..7bc6d6685a 100644 --- a/docs/reference/contributing/guidelines/ci.md +++ b/docs/reference/contributing/guidelines/ci.md @@ -6,7 +6,7 @@ Continuous integration (CI) means mainly automatic testing for pull requests In Mbed OS [Travis CI](https://travis-ci.org/ARMmbed/mbed-os) is used as primary automatic testing and checking run environment. -Travis configuration is located in [.travis.yml](https://github.com/ARMmbed/mbed-os/blob/master/.travis.yml) file in Mbed OS root directory. Mbed OS use public travis so test results are publicly available and there are public [documentation available](https://docs.travis-ci.com/). +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/). #### Tests @@ -24,30 +24,30 @@ Travis configuration is located in [.travis.yml](https://github.com/ARMmbed/mbed ### Jenkins -[Jenkins](https://jenkins.io/) is used to run tests behind firewall. There are multiple reasons to run tests in Jenkins but typically those are related to high amount of concurrent builds or shared secrets. +[Jenkins](https://jenkins.io/) is used as internal testing and checking environment. Tests which have special requirements for execution enviroment are executed in internal Jenkins. In most cases test logs are published. #### How it works: -* Jenkins uses [scripted pipeline syntax](https://jenkins.io/doc/book/pipeline/) -* There is Jenkinsfile in Mbed OS root folder but that is just trigger for tests. Jenkins scripts are not publicly available at the moment. -* Jenkins select required tests dynamically based on the code changes. For example. no tests are executed if only markdown (.md) file changes -* Jenkins run first small amount of tests to provide fast feedback and then more tests +* Jenkins uses a [scripted pipeline syntax](https://jenkins.io/doc/book/pipeline/) +* Jenkins scripts are not publicly available. There is Jenkinsfile in Mbed OS root folder but that is just trigger for tests. +* Jenkins selects required tests dynamically based on the code changes. For example: no tests are executed if only markdown (.md) file are changed +* Jenkins run first small amount of tests to provide fast feedback and then additional tests #### Tests * **continuous-integration/jenkins/pr-head** Jenkins main pipeline script execution status -* **jenkins-ci/build-ARM** - Build Mbed OS and examples with ARM +* **jenkins-ci/build-ARM** - Build Mbed OS and examples with ARM. Related commands: * `mbed test --compile -t -m ` * `python -u mbed-os/tools/test/examples/examples.py compile --mcu ` -* **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM. Related commands: +* **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM * **jenkins-ci/build-IAR** - Build Mbed OS and examples with IAR * **jenkins-ci/cloud-client-test** - Test the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example) * **jenkins-ci/dynamic-memory-usage** - Report dynamic memory usage compared to the master branch * **jenkins-ci/exporter** - Export and build exported code. Related commands: * `python -u mbed-os/tools/test/examples/examples.py export --mcu ` * **jenkins-ci/greentea-test** - Run [greentea tests](/docs/tools/testing/testing_greentea.html) -* **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with ARM +* **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with ARM. Related commands: * `python tools/build_release.py -p -t ` -* **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM. Related commands: +* **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM * **jenkins-ci/mbed2-build-IAR** - Build Mbed OS 2 with IAR * **jenkins-ci/unittests** - Run [unit tests](/docs/tools/testing/unit_testing.html) * **tools-test-linux** - Test that tools works on Linux diff --git a/docs/reference/contributing/guidelines/workflow.md b/docs/reference/contributing/guidelines/workflow.md index 507b50e017..7782f180ac 100644 --- a/docs/reference/contributing/guidelines/workflow.md +++ b/docs/reference/contributing/guidelines/workflow.md @@ -186,7 +186,7 @@ Time: 3 days for reviewers to leave feedback after the maintainers add the "need #### The CI (Continuous Integration) testing -There are many [CI systems available](/docs/reference/contributing/guidelines/ci.html). Which CI tests we run against a particular pull request depends on the effect that pull request has on the code base. Irrespective of which CI tests run, Mbed OS has an all green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request. +There are many [CI systems available](/docs/reference/contributing/guidelines/ci.html) for testing Mbed OS pull requests and braches. Which CI tests we run against a particular pull request depends on the effect that pull request has on the code base. Irrespective of which CI tests run, Mbed OS has an all green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request. Label: `needs: review` Time: 1 day for CI to complete and report back results. From 161f36e9100ba18524899314aa0c0ce984f8e315 Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Wed, 31 Oct 2018 10:56:18 -0500 Subject: [PATCH 6/9] Edit ci.md Make initial edits to file. --- docs/reference/contributing/guidelines/ci.md | 77 ++++++++++---------- 1 file changed, 39 insertions(+), 38 deletions(-) diff --git a/docs/reference/contributing/guidelines/ci.md b/docs/reference/contributing/guidelines/ci.md index 7bc6d6685a..f9284fedfc 100644 --- a/docs/reference/contributing/guidelines/ci.md +++ b/docs/reference/contributing/guidelines/ci.md @@ -1,6 +1,6 @@ -## Continuous integration +

Continuous integration

-Continuous integration (CI) means mainly automatic testing for pull requests +Continuous integration (CI) means mainly automatic testing for pull requests. ### Travis CI @@ -10,46 +10,47 @@ Travis configuration is located in the [.travis.yml](https://github.com/ARMmbed/ #### Tests -* **continuous-integration/travis-ci/pr** - Main run main -* **travis-ci/astyle** - Check code style using [astyle](http://astyle.sourceforge.net/) -* **travis-ci/docs** - [Doxygen](http://www.doxygen.org/) and naming checks: -** Assert that the Doxygen build produced no warnings -** Assert that all binary libraries are named correctly -** Assert that all assebler files are named correctly -* **travis-ci/events** - Check that Mbed OS compiles and run events tests -* **travis-ci/gitattributestest** - Check that no changes after clone. This check that .gitattributes is used right way -* **travis-ci/licence_check** - Checking that there is no GPL licence text in code -* **travis-ci/littlefs** - Testing littlefs without embedded hardware -* **travis-ci/tools-py2.7** - Run python tools tests with python 2.7 +- **continuous-integration/travis-ci/pr** - Main run main. +- **travis-ci/astyle** - Check code style using [astyle](http://astyle.sourceforge.net/). +- **travis-ci/docs** - [Doxygen](http://www.doxygen.org/) and naming checks: + - Assert that the Doxygen build produces no warnings. + - Assert that all binary libraries are named correctly. + - Assert that all assembler files are named correctly. +- **travis-ci/events** - Check that Mbed OS compiles and run events tests. +- **travis-ci/gitattributestest** - Check there are no changes after clone. This checks that `.gitattributes` is used correctly. +- **travis-ci/licence_check** - Check there is no GPL licence text in the code. +- **travis-ci/littlefs** - Test littlefs without embedded hardware. +- **travis-ci/tools-py2.7** - Run Python tools tests with Python 2.7. ### Jenkins -[Jenkins](https://jenkins.io/) is used as internal testing and checking environment. Tests which have special requirements for execution enviroment are executed in internal Jenkins. In most cases test logs are published. +We use [Jenkins](https://jenkins.io/) as an internal testing and checking environment. We execute tests that have special requirements for the execution enviroment in our internal Jenkins. In most cases, we publish test logs. -#### How it works: -* Jenkins uses a [scripted pipeline syntax](https://jenkins.io/doc/book/pipeline/) -* Jenkins scripts are not publicly available. There is Jenkinsfile in Mbed OS root folder but that is just trigger for tests. -* Jenkins selects required tests dynamically based on the code changes. For example: no tests are executed if only markdown (.md) file are changed -* Jenkins run first small amount of tests to provide fast feedback and then additional tests +How it works: + +- Jenkins uses a [scripted pipeline syntax](https://jenkins.io/doc/book/pipeline/). +- Jenkins scripts are not publicly available. There is a Jenkinsfile in the Mbed OS root folder, but that is just a trigger for tests. +- Jenkins selects required tests dynamically based on the code changes. For example, no tests execute if only markdown (.md) files change. +- Jenkins runs a first small number of tests to provide fast feedback, and then it runs additional tests. #### Tests -* **continuous-integration/jenkins/pr-head** Jenkins main pipeline script execution status -* **jenkins-ci/build-ARM** - Build Mbed OS and examples with ARM. Related commands: - * `mbed test --compile -t -m ` - * `python -u mbed-os/tools/test/examples/examples.py compile --mcu ` -* **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM -* **jenkins-ci/build-IAR** - Build Mbed OS and examples with IAR -* **jenkins-ci/cloud-client-test** - Test the change with [mbed-cloud-client](https://github.com/ARMmbed/mbed-cloud-client) using [mbed-cloud-client-example](https://github.com/ARMmbed/mbed-cloud-client-example) -* **jenkins-ci/dynamic-memory-usage** - Report dynamic memory usage compared to the master branch -* **jenkins-ci/exporter** - Export and build exported code. Related commands: - * `python -u mbed-os/tools/test/examples/examples.py export --mcu ` -* **jenkins-ci/greentea-test** - Run [greentea tests](/docs/tools/testing/testing_greentea.html) -* **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with ARM. Related commands: - * `python tools/build_release.py -p -t ` -* **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM -* **jenkins-ci/mbed2-build-IAR** - Build Mbed OS 2 with IAR -* **jenkins-ci/unittests** - Run [unit tests](/docs/tools/testing/unit_testing.html) -* **tools-test-linux** - Test that tools works on Linux -* **tools-test-mac** - Test that tools works on Mac -* **tools-test-windows** - Test that tools works on Windows +- **continuous-integration/jenkins/pr-head** - Jenkins main pipeline script execution status. +- **jenkins-ci/build-ARM** - Build Mbed OS and examples with ARM. Related commands: + - `mbed test --compile -t -m `. + - `python -u mbed-os/tools/test/examples/examples.py compile --mcu `. +- **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM. +- **jenkins-ci/build-IAR** - Build Mbed OS and examples with IAR. +- **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). +- **jenkins-ci/dynamic-memory-usage** - Report dynamic memory use compared to the master branch. +- **jenkins-ci/exporter** - Export and build exported code. Related commands: + - `python -u mbed-os/tools/test/examples/examples.py export --mcu `. +- **jenkins-ci/greentea-test** - Run [greentea tests](/docs/tools/testing/testing_greentea.html). +- **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with ARM. Related commands: + - `python tools/build_release.py -p -t `. +- **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM. +- **jenkins-ci/mbed2-build-IAR** - Build Mbed OS 2 with IAR. +- **jenkins-ci/unittests** - Run [unit tests](/docs/tools/testing/unit_testing.html). +- **tools-test-linux** - Test that tools work on Linux. +- **tools-test-mac** - Test that tools work on macOS. +- **tools-test-windows** - Test that tools work on Windows. From 79994f3f2defcff375418409b38a281f19d9eb2c Mon Sep 17 00:00:00 2001 From: Olli-Pekka Puolitaival Date: Wed, 31 Oct 2018 18:12:43 +0200 Subject: [PATCH 7/9] Fix arm compiler and add link to that --- docs/reference/contributing/guidelines/ci.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/contributing/guidelines/ci.md b/docs/reference/contributing/guidelines/ci.md index f9284fedfc..a3f447b786 100644 --- a/docs/reference/contributing/guidelines/ci.md +++ b/docs/reference/contributing/guidelines/ci.md @@ -36,7 +36,7 @@ How it works: #### Tests - **continuous-integration/jenkins/pr-head** - Jenkins main pipeline script execution status. -- **jenkins-ci/build-ARM** - Build Mbed OS and examples with ARM. Related commands: +- **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: - `mbed test --compile -t -m `. - `python -u mbed-os/tools/test/examples/examples.py compile --mcu `. - **jenkins-ci/build-GCC_ARM** - Build Mbed OS and examples with GCC_ARM. @@ -46,7 +46,7 @@ How it works: - **jenkins-ci/exporter** - Export and build exported code. Related commands: - `python -u mbed-os/tools/test/examples/examples.py export --mcu `. - **jenkins-ci/greentea-test** - Run [greentea tests](/docs/tools/testing/testing_greentea.html). -- **jenkins-ci/mbed2-build-ARM** - Build Mbed OS 2 with ARM. Related commands: +- **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: - `python tools/build_release.py -p -t `. - **jenkins-ci/mbed2-build-GCC_ARM** - Build Mbed OS 2 with GCC_ARM. - **jenkins-ci/mbed2-build-IAR** - Build Mbed OS 2 with IAR. From ea90b07ecd675970de6781860a614a2e0ff09fef Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Fri, 16 Nov 2018 08:50:13 -0600 Subject: [PATCH 8/9] Update phrasing in ci.md Update phrasing for clarity. --- docs/reference/contributing/guidelines/ci.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/contributing/guidelines/ci.md b/docs/reference/contributing/guidelines/ci.md index a3f447b786..5d41ce8184 100644 --- a/docs/reference/contributing/guidelines/ci.md +++ b/docs/reference/contributing/guidelines/ci.md @@ -10,7 +10,7 @@ Travis configuration is located in the [.travis.yml](https://github.com/ARMmbed/ #### Tests -- **continuous-integration/travis-ci/pr** - Main run main. +- **continuous-integration/travis-ci/pr** - Run other testing jobs. - **travis-ci/astyle** - Check code style using [astyle](http://astyle.sourceforge.net/). - **travis-ci/docs** - [Doxygen](http://www.doxygen.org/) and naming checks: - Assert that the Doxygen build produces no warnings. From ce30733419d5b4adf5f2773d7bfe6ca58db63a2c Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Fri, 16 Nov 2018 08:53:32 -0600 Subject: [PATCH 9/9] Fix link in workflow.md Fix broken link. --- docs/reference/contributing/guidelines/workflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/contributing/guidelines/workflow.md b/docs/reference/contributing/guidelines/workflow.md index 7782f180ac..1c859fb4e1 100644 --- a/docs/reference/contributing/guidelines/workflow.md +++ b/docs/reference/contributing/guidelines/workflow.md @@ -186,7 +186,7 @@ Time: 3 days for reviewers to leave feedback after the maintainers add the "need #### The CI (Continuous Integration) testing -There are many [CI systems available](/docs/reference/contributing/guidelines/ci.html) for testing Mbed OS pull requests and braches. Which CI tests we run against a particular pull request depends on the effect that pull request has on the code base. Irrespective of which CI tests run, Mbed OS has an all green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request. +There are many [CI systems available](../contributing/guidelines/ci.html) for testing Mbed OS pull requests and braches. Which CI tests we run against a particular pull request depends on the effect that pull request has on the code base. Irrespective of which CI tests run, Mbed OS has an all green policy, meaning that all the CI jobs that are triggered must pass before we merge the pull request. Label: `needs: review` Time: 1 day for CI to complete and report back results.