Skip to content

Commit 55ebd13

Browse files
committed
Update running in docker instructions
1 parent d664373 commit 55ebd13

File tree

6 files changed

+16
-7
lines changed

6 files changed

+16
-7
lines changed

.env.sample

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ARTEFACTS_KEY=

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ artefacts-client
88
.vscode
99
.DS_Store
1010
rosbag2
11-
.venv
11+
.venv
12+
.env

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,18 @@ artefacts run all
7474
7575
# Run test remotely
7676
artefacts run-remote all --description "Test Navigation2"
77+
```
78+
### Run test locally with Docker
7779

78-
# Run test locally with Docker
79-
docker build -t nav2-gz .
80-
# ARTEFACTS_KEY can be generated at the project-settings page of the Artefacts CI dashboard
81-
docker run --rm -e ARTEFACTS_JOB_NAME=all -e ARTEFACTS_KEY=${ARTEFACTS_KEY} nav2-gz
80+
1. Build container
81+
```sh
82+
docker/build.sh
83+
```
84+
2. Save `.env.sample` as `.env` and fill the missing variables
85+
- ARTEFACTS_KEY can be generated at the project-settings page of the Artefacts CI dashboard
86+
3. Run the selected tests in docker
87+
```sh
88+
docker run --rm --env-file=.env -e ARTEFACTS_JOB_NAME=nav2 nav2-gz
8289
```
8390

8491
## Visualize navigation with **Rerun.io** (experimental)

artefacts.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,4 @@ jobs:
3434
-s &&
3535
pkill -f gz &&
3636
pkill -f rviz
37+

docker/run.bash

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ fi
6060

6161
docker run \
6262
"${DOCKER_OPTIONS[@]}" \
63-
"${ISAAC_OPTIONS[@]}" \
6463
nav2-gz \
6564
"${CMD_ARGS[@]}"
6665

src/sam_bot_nav2_gz/test/test_follow_waypoints.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,4 +193,4 @@ def generate_charts(request, rosbag_recording):
193193
chart_name="odometry_position",
194194
)
195195
image_topics.extract_camera_image(rosbag_filepath, "/sky_cam")
196-
image_topics.extract_video(rosbag_filepath, "/sky_cam", "output/sky_cam.webm")
196+
image_topics.extract_video(rosbag_filepath, "/sky_cam", "output/sky_cam.mp4")

0 commit comments

Comments
 (0)