Skip to content

Commit 6d1e929

Browse files
committed
rework on documentation.
1 parent 4fc499b commit 6d1e929

File tree

3 files changed

+6
-10
lines changed

3 files changed

+6
-10
lines changed

.github/workflows/docker_management.branch.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,6 @@ jobs:
196196

197197
run: |
198198
uname -m
199-
ls
200-
#./mbed-os/docker_images/mbed-os-env/test.sh DEVELOPMENT ${{ steps.build_info.outputs.MBED_OS_VERSION }}
201199
cd mbed-os-example-blinky
202200
mbed deploy
203201
# build using CLI1

docker_images/mbed-os-env/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To make sure your Mbed targets have been detected, you might want to manually ru
4242
mount /dev/sdb /mnt
4343
mbedls
4444
```
45-
If `mbedls` detected your connected target, then you should be able to run Mbed tests/examples as recommended in Mbed documentation.
45+
If `mbedls` detected your connected target, then you should be able to run Mbed tests/examples as recommended in the Mbed documentation.
4646
``` bash
4747
mbed clone https://github.com/ARMmbed/mbed-os.git
4848
cd mbed-os

docs/design-documents/docker_management/README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
### Overview and background
55

6-
The docker image mbed-os-env bundles all the necessary tools to provide a minimal environment to build and test mbed-os applications. This docker image shall be used in Continuous Integration pipelines or in other use cases where mbed-os tools and dependencies are required. This document explains versioning strategy of the docker image and github action workflows that creates these docker images.
6+
The docker image mbed-os-env bundles all the necessary tools to provide a minimal environment to build and test mbed-os applications. This docker image shall be used in Continuous Integration pipelines or in other use cases where mbed-os tools and dependencies are required. This document explains versioning strategy of the docker image and GitHub action workflows that creates these docker images.
77

88

99
### Types of docker images
@@ -106,15 +106,13 @@ There are some details worth mentioning though.
106106

107107
docker buildx command is used for creating multi architecture docker image. To build docker image using buildx, one needs to push the image to a remote repository while building it. Since, we need to "test" before release, the resulting images are pushed to a temporary docker repository just after building.
108108

109-
github container registry doesn't implement yet all the docker manifest APIs. Hence, a few features like deleting tag from an image is not available yet. Once these are implemented, we may remove temporary repository and add temporary tags to the image and delete the temporary tags after workflow.
109+
GitHub container registry doesn't implement yet all the docker manifest APIs. Hence, a few features like deleting tag from an image is not available yet. Once these are implemented, we may remove temporary repository and add temporary tags to the image and delete the temporary tags after workflow.
110110

111111
**Test**
112-
Once temporary images are built, we need to verify whether image built is same as the image already available as our intended docker image version. This is achieved by comparing the docker digest of two images. Obviously, if digest is same, there is no need to make another release as docker image available as released version is already up to date.
113-
114-
If the digest is different, (means, new version of docker image is built), test.sh script takes care of all the testing.
112+
After the temporary docker image is built, GitHub Actions tests the image prior to deploying the image to the production Docker repository. Please refer to the `test-container` job in the workflow for details on the test plan.
115113

116114
**Deploy**
117-
In Deploy job, depending on the result of test job, temporary images are moved to production repository.
115+
In `Deploy` job, depending on the result of test job, temporary images are moved to production repository.
118116

119117
### Docker repository
120118
GitHub provides free docker image storage for public repositories in GitHub packages. The workflows make use of {{ secrets.GITHUB_TOKEN }} https://docs.github.com/en/actions/reference/authentication-in-a-workflow
@@ -127,7 +125,7 @@ There are two repositories being created or used for managing docker image
127125

128126
**mbed-os-env** This is the public repository user can pull the images from.
129127

130-
**mbed-os-env-tmp** This is a private repository created for temporary management of docker images while docker images are being tested. This is a staging area. Unfortunately, github container registry do no support renaming docker tags, hence the need for a temporary repository.
128+
**mbed-os-env-tmp** This is a private repository created for temporary management of docker images while docker images are being tested. This is a staging area. Unfortunately, GitHub container registry do no support renaming docker tags, hence the need for a temporary repository.
131129

132130
### Workflow for forks
133131

0 commit comments

Comments
 (0)