Skip to content

Commit 00ad145

Browse files
authored
fix(docker): Add docker tag to run scripts in 5.3 branch (espressif#236)
* fix(docker): Add docker tag to run scripts in 5.3 branch * Add additional info
1 parent 7977581 commit 00ad145

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

Diff for: tools/docker/README.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Multiple tags of this image are maintained:
2424
## Basic Usage
2525

2626
```bash
27-
docker run --rm -it -e "TERM=xterm-256color" -v <path to arduino-esp32>:/arduino-esp32 espressif/esp32-arduino-lib-builder:latest
27+
docker run --rm -it -e "TERM=xterm-256color" -v <path to arduino-esp32>:/arduino-esp32 espressif/esp32-arduino-lib-builder:release-v5.3
2828
```
2929

3030
The above command explained:
@@ -35,18 +35,16 @@ The above command explained:
3535
- `-t`: Allocates a pseudo-TTY.
3636
- `-e "TERM=xterm-256color"`: Optional. Sets the terminal type to `xterm-256color` to display colors correctly.
3737
- `-v <path to arduino-esp32>:/arduino-esp32`: Optional. Mounts the Arduino Core for ESP32 repository at `/arduino-esp32` inside the container. Replace `<path to arduino-esp32>` with the path to the repository on the host machine. If not provided, the container will not copy the compiled libraries to the host machine.
38-
- `espressif/esp32-arduino-lib-builder:latest`: The Docker image to use.
38+
- `espressif/esp32-arduino-lib-builder:release-v5.3`: The Docker image to use.
3939

4040
After running the above command, you will be inside the container and can build the libraries using the user interface.
4141

4242
By default the docker container will run the user interface script. If you want to run a specific command, you can pass it as an argument to the docker run command. For example, to run a terminal inside the container, you can run:
4343

4444
```bash
45-
docker run -it espressif/esp32-arduino-lib-builder:latest /bin/bash
45+
docker run -it espressif/esp32-arduino-lib-builder:release-v5.3 /bin/bash
4646
```
4747

4848
## Documentation
4949

50-
<!-- Pending: Add link to the full documentation. -->
51-
52-
For more information about this image and the detailed usage instructions, please refer to the Arduino Core for ESP32 documentation.
50+
For more information about this image and the detailed usage instructions, please refer to the [Arduino Core for ESP32 documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/lib_builder.html#docker-image).

Diff for: tools/docker/run.ps1

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# This is an example of how to run the docker container.
22
# This script is not part of the container, it is meant to be run on the host machine.
3+
# Note that this file will build the release/v5.3 branch. For other branches, change the tag accordingly.
4+
# You can check the available tags at https://hub.docker.com/r/espressif/esp32-arduino-lib-builder/tags
5+
# As this script is unsigned, you may need to run `Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass` before running it.
36
# Usage: .\run.ps1 <path_to_arduino_esp32>
47

58
# Exit on error
@@ -58,4 +61,4 @@ if ($env:LIBBUILDER_GIT_SAFE_DIR) {
5861
}
5962

6063
Write-Output "Running: docker run $($DOCKER_ARGS -join ' ') espressif/esp32-arduino-lib-builder"
61-
docker run @($DOCKER_ARGS) espressif/esp32-arduino-lib-builder
64+
docker run @($DOCKER_ARGS) espressif/esp32-arduino-lib-builder:release-v5.3

Diff for: tools/docker/run.sh

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
# This is an example of how to run the docker container.
44
# This script is not part of the container, it is meant to be run on the host machine.
5+
# Note that this file will build the release/v5.3 branch. For other branches, change the tag accordingly.
6+
# You can check the available tags at https://hub.docker.com/r/espressif/esp32-arduino-lib-builder/tags
57
# Usage: ./run.sh <path_to_arduino_esp32>
68

79
if ! [ -x "$(command -v docker)" ]; then
@@ -31,4 +33,4 @@ if [ -n "$LIBBUILDER_GIT_SAFE_DIR" ]; then
3133
fi
3234

3335
echo "Running: docker run ${DOCKER_ARGS[@]} espressif/esp32-arduino-lib-builder"
34-
docker run ${DOCKER_ARGS[@]} espressif/esp32-arduino-lib-builder
36+
docker run ${DOCKER_ARGS[@]} espressif/esp32-arduino-lib-builder:release-v5.3

0 commit comments

Comments
 (0)