You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/guidelines/ci.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ Continuous integration (CI) testing is an integral part of the Mbed OS contribut
4
4
5
5
## Github Actions
6
6
7
-
Mbed OS uses Github actions as the primary automatic testing and checking run environment.
7
+
Mbed OS uses Github Actions as the primary automatic testing and checking run environment.
8
8
9
-
Its configuration is located in the [github/workflows/basic_checks.yml](https://github.com/ARMmbed/mbed-os/blob/master/.github/workflows/basic_checks.yml) file in the Mbed OS root directory.
9
+
The configuration is located in the [github/workflows/basic_checks.yml](https://github.com/ARMmbed/mbed-os/blob/master/.github/workflows/basic_checks.yml) file in the Mbed OS root directory.
10
10
11
11
### Tests
12
12
@@ -22,7 +22,7 @@ Its configuration is located in the [github/workflows/basic_checks.yml](https://
22
22
23
23
## Jenkins
24
24
25
-
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.
25
+
We use [Jenkins](https://jenkins.io/) as an internal testing and checking environment. We execute tests that have special requirements for the execution environment in our internal Jenkins. In most cases, we publish test logs.
Copy file name to clipboardExpand all lines: docs/tools/docker/docker.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -19,17 +19,17 @@ The image is built and tested for the following architectures:
19
19
20
20
### Selecting the appropriate Docker tag
21
21
22
-
The Docker images are built, tested and published by GitHub Actions. When using the Docker image, make sure you are using the appropriate Docker tag that is compatible with Mbed OS version of your project. [Design document](https://github.com/ARMmbed/mbed-os/tree/master/docs/design-documents/docker_management) contains the detailed explanation of Docker image versioning strategy.
22
+
The Docker images are built, tested and published by GitHub Actions. When using the Docker image, make sure you are using the appropriate Docker tag that is compatible with the Mbed OS version of your project. [Design document](https://github.com/ARMmbed/mbed-os/tree/master/docs/design-documents/docker_management) contains a detailed explanation of Docker image versioning strategy.
23
23
24
-
As a quick overview, use `ghcr.io/armmbed/mbed-os-env:mbed-os-6-latest` for Docker image compatible with released version of Mbed OS, or `ghcr.io/armmbed/mbed-os-env:latest` for Docker image compatible with `HEAD` of Mbed OS `master branch`.
24
+
As a quick overview, use `ghcr.io/armmbed/mbed-os-env:mbed-os-6-latest` for a Docker image compatible with the released version of Mbed OS, or `ghcr.io/armmbed/mbed-os-env:latest` for a Docker image compatible with `HEAD` of Mbed OS `master branch`.
25
25
26
26
### Command line
27
27
28
-
The Mbed OS Docker container can be used using Docker Desktop on any supported platform (Windows, Linux & Mac).
28
+
The Mbed OS Docker container can be used via Docker Desktop on any supported platform (Windows, Linux, and Mac).
29
29
30
30
#### Examples
31
31
32
-
Run interactively in current directory and compile the current application:
32
+
Run interactively in the current directory and compile the current application:
33
33
34
34
```
35
35
git clone https://github.com/ARMmbed/mbed-os-example-blinky.git && cd mbed-os-example-blinky
<spanclass="tips">**Tip:** When building the Mbed OS project inside Docker container with shared workspace from Docker host, there could be performance issues as the filesystem needs to be synced between Docker host and container. For better performance ensure `gRPC FUSE for file sharing`[is enabled in Docker settings](https://www.docker.com/blog/deep-dive-into-new-docker-desktop-filesharing-implementation/).</span>
43
+
<spanclass="tips">**Tip:** When building the Mbed OS project inside a Docker container with a shared workspace from Docker host, there could be performance issues as the filesystem needs to be synced between the Docker host and container. For better performance ensure `gRPC FUSE for file sharing`[is enabled in Docker settings](https://www.docker.com/blog/deep-dive-into-new-docker-desktop-filesharing-implementation/).</span>
44
44
45
45
### Continuous integration
46
46
47
-
We are in the process of moving our CI to use the GitHub Actions, and this can provide a great basis for your own CI for your Mbed-based projects.
47
+
We are in the process of moving our CI to use GitHub Actions, and this can provide a great basis for your own CI for your Mbed-based projects.
48
48
49
49
#### Examples
50
50
@@ -55,19 +55,19 @@ For a real-life example you can check out the [GitHub Actions workflow](https://
55
55
56
56
### Running GreenTea against USB devices in Docker Container
57
57
58
-
There are various limitations with connecting USB devices to a Docker container. Depending on the host machines, complexity to setup such environment will vary. On Mac, you will need to capture the device first in the underlying VM.
58
+
There are various limitations with connecting USB devices to a Docker container. Depending on the host machines, the complexity to setup such environment will vary. On Mac, you will need to capture the device first in the underlying VM.
59
59
60
60
For this reason, running GreenTea from the Docker container is not trivial at the moment! We will be looking at future-proof solutions.
61
61
62
-
Having said that, if you are running Docker container in Linux host machine, you will be able to connect and run GreenTea tests by following these steps:
62
+
Having said that, if you are running a Docker container on a Linux host machine, you will be able to connect and run GreenTea tests by following these steps:
0 commit comments