Skip to content

Add info on last tested commit #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
j3soon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add info on last tested commit #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/aloha-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
![Docker image version](https://img.shields.io/docker/v/j3soon/ros2-aloha-ws)
![Docker image size](https://img.shields.io/docker/image-size/j3soon/ros2-aloha-ws)

> Last tested on commit [d24f0a1](https://github.com/j3soon/ros2-essentials/commit/d24f0a12609ffb2aea245cba4462e46b18577e4e) by [@j3soon](https://github.com/j3soon).

## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/delto-gripper-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

This repository will help you configure the environment for Delto Gripper quickly.

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace the TODO with a concrete commit reference.
User-facing docs shouldn’t ship with a placeholder; please include the tested commit hash and author (matching the format used elsewhere).

🤖 Prompt for AI Agents 
In `@docs/delto-gripper-ws/index.md` at line 14, Replace the placeholder line
"Last tested on TODO." with the actual commit reference and author info used
elsewhere in the docs: insert the full commit hash and the author name/email in
the same format as other entries (e.g., "Last tested on <commit-hash> by <Author
Name>"), ensuring you copy the exact commit hash from the repository history for
the tested state and replace the TODO text accordingly.


## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/docker-modules/cartographer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

ROS2 Cartographer. (Only installed by default for the template workspace.)

> Last tested on TODO.

To enable Cartographer, set the `CARTOGRAPHER` argument to `YES` in the `compose.yaml` file of your desired workspace (e.g., `husky_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image.

> TODO: Remove duplicate content from the template workspace below.
Expand Down
2 changes: 2 additions & 0 deletions docs/docker-modules/claude-code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Claude Code CLI for AI-assisted development directly inside workspace containers.

> Last tested on commit [d43ad1c](https://github.com/j3soon/ros2-essentials/commit/d43ad1c11075808d5fbf194c5979ffedec213b5e) by [@j3soon](https://github.com/j3soon).

To enable Claude Code CLI, set the `CLAUDE_CODE` argument to `YES` in the `compose.yaml` file of your desired workspace (e.g., `template_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image.

## Installation
Expand Down
2 changes: 2 additions & 0 deletions docs/docker-modules/codex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Codex CLI for AI-assisted development directly inside workspace containers.

> Last tested on commit [d43ad1c](https://github.com/j3soon/ros2-essentials/commit/d43ad1c11075808d5fbf194c5979ffedec213b5e) by [@j3soon](https://github.com/j3soon).

To enable Codex CLI, set the `CODEX` argument to `YES` in the `compose.yaml` file of your desired workspace (e.g., `template_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image.

## Installation
Expand Down
2 changes: 2 additions & 0 deletions docs/docker-modules/cuda-toolkit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

CUDA Toolkit 12.6 Deb Install. (Not installed by default.)

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

Please fill in the actual last tested commit so the note is actionable.

🤖 Prompt for AI Agents 
In `@docs/docker-modules/cuda-toolkit.md` at line 7, Replace the placeholder text
"Last tested on TODO." with a concrete identifier such as a commit hash (e.g.,
abc1234), a full date (e.g., 2026-02-05), or both so the note is actionable;
update the line containing "Last tested on TODO." to read something like "Last
tested on <commit-hash> (<YYYY-MM-DD>)" or your chosen format.


To enable CUDA Toolkit, set the `CUDA_TOOLKIT_VERSION` argument to `12.6` in the `compose.yaml` file of your desired workspace (e.g., `template_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image.

Make sure your GPU driver version supports the CUDA Toolkit version you want to install. For example, CUDA 12.6 requires Linux driver version >=560.35.05 on x86_64. See [Table 3 in the CUDA Toolkit Release Notes](https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html) for more information.
Expand Down
2 changes: 2 additions & 0 deletions docs/docker-modules/isaac-lab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Isaac Lab 2.1.0 Git Install.

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

This should point to the tested commit so readers can reproduce the doc state.

🤖 Prompt for AI Agents 
In `@docs/docker-modules/isaac-lab.md` at line 7, Replace the placeholder "TODO"
in the "Last tested on TODO." line with a concrete identifier of the tested
state (either a full commit hash like "Last tested on commit abc1234..." or an
exact date like "Last tested on 2025-02-05"); ensure the entry points to the
specific commit or tag used to verify the docs so readers can reproduce the
exact documented state.


Depends on:

- Vulkan Configuration
Expand Down
2 changes: 2 additions & 0 deletions docs/docker-modules/isaac-ros.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

Isaac ROS 3.2. (Not installed by default.)

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace the TODO with a concrete commit reference.
Please provide the tested commit hash and author, matching the format used in other docs.

🤖 Prompt for AI Agents 
In `@docs/docker-modules/isaac-ros.md` at line 9, Replace the placeholder "Last
tested on TODO." with the concrete commit reference in the same format used
elsewhere (commit hash and author), e.g. "Last tested on <commit-hash> by
<author-name>." Ensure the commit hash is the exact tested commit and the author
matches the repo attribution formatting used in other docs.


Depends on:

- ROS 2 Humble
Expand Down
2 changes: 2 additions & 0 deletions docs/docker-modules/isaac-sim.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Isaac Sim 5.0.0 Binary Install.

> Last tested on commit [d43ad1c](https://github.com/j3soon/ros2-essentials/commit/d43ad1c11075808d5fbf194c5979ffedec213b5e) by [@j3soon](https://github.com/j3soon).

Depends on:

- Vulkan Configuration
Expand Down
2 changes: 2 additions & 0 deletions docs/docker-modules/ros2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/blob/main/docker_modules/install_ros.sh)

Robot Operating System 2 (ROS 2) Humble Apt Install.

> Last tested on commit [d43ad1c](https://github.com/j3soon/ros2-essentials/commit/d43ad1c11075808d5fbf194c5979ffedec213b5e) by [@j3soon](https://github.com/j3soon).
2 changes: 2 additions & 0 deletions docs/docker-modules/rtabmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

[![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/blob/main/docker_modules/install_rtabmap.sh)

> Last tested on TODO.

Comment on lines +5 to +6
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

Readers need a specific commit hash or exact test date to reproduce the documented state.

🤖 Prompt for AI Agents 
In `@docs/docker-modules/rtabmap.md` around lines 5 - 6, Replace the placeholder
"TODO" in the line containing "Last tested on TODO." with a concrete
reproducible identifier: either a full git commit hash (e.g., 40-char SHA) or an
exact test date and time (YYYY-MM-DD or YYYY-MM-DD HH:MM UTC); update the
sentence to read like "Last tested on <commit SHA>" or "Last tested on
<YYYY-MM-DD>" so readers can reproduce the documented state and verify which
commit/date was used.

## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/gazebo-world-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

This repository contains several Gazebo worlds, which are valuable for testing robots or agents in both indoor and outdoor environments.

> Last tested on TODO.

## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/go2-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

> Please note that this workspace is only tested in simulation.

> Last tested on TODO.

## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/h1-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

> Please note that this workspace is only tested in simulation.

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace the TODO with a concrete commit reference.
User-facing docs should avoid placeholders; please add the tested commit hash and author.

🤖 Prompt for AI Agents 
In `@docs/h1-ws/index.md` at line 14, Replace the placeholder text "Last tested on
TODO." with a concrete commit reference and author so the docs are actionable;
update the line containing "Last tested on TODO." to something like "Last tested
on <commit-hash> by <author-name>" (use the full commit SHA and the
committer/author name) and ensure the commit hash is accurate for the tested
state referenced in the rest of the doc.


## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/husky-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

This repository will help you configure the environment for Husky quickly.

> Last tested on TODO.

## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/kobuki-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

This repository facilitates the quick configuration of the simulation environment and real robot driver for Kobuki.

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

Please fill in the tested commit so users can reset their tree accurately.

🤖 Prompt for AI Agents 
In `@docs/kobuki-ws/index.md` at line 14, Replace the placeholder "TODO" in the
"Last tested on TODO." line with a concrete commit hash or ISO date so users can
reproduce the tested tree; update the sentence to read e.g. "Last tested on
<commit-hash>" or "Last tested on YYYY-MM-DD" (use the commit SHA from the repo
at test time or the exact date of testing) and ensure the commit hash is
full/short SHA consistently used across docs.


## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/orbslam3-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
![Docker image version](https://img.shields.io/docker/v/j3soon/ros2-orbslam3-ws)
![Docker image size](https://img.shields.io/docker/image-size/j3soon/ros2-orbslam3-ws)

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

The PR objective is to record the last tested commit; leaving a TODO defeats that purpose. Please fill in a specific commit hash (and optionally a date).

🤖 Prompt for AI Agents 
In `@docs/orbslam3-ws/index.md` at line 12, Replace the placeholder "Last tested
on TODO." in docs/orbslam3-ws/index.md with a concrete Git commit hash (and
optionally a date) that was used to verify the PR; locate the exact string "Last
tested on TODO." in the file and update it to something like "Last tested on
<commit-hash> (<YYYY-MM-DD>)" so the documentation records the specific tested
revision.


## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/ros1-bridge-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

This workspace is utilized to create a bridge between ROS1 and ROS2-humble.

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

Please provide the actual last tested commit (and optionally the date) so users can reset their tree as intended.

🤖 Prompt for AI Agents 
In `@docs/ros1-bridge-ws/index.md` at line 19, Replace the placeholder "Last
tested on TODO." in the docs header with a concrete identifier: update the exact
line containing "Last tested on TODO." to include the actual last-tested git
commit hash (e.g. abc1234) and optionally the date (e.g. 2026-02-05) so it reads
like "Last tested on abc1234 (2026-02-05)"; ensure you use the real commit used
for verification and keep the wording/format consistent with other docs.


## ◻️ Introduction ◻️

`ros1_bridge` provides a network bridge that enables the exchange of messages between ROS 1 and ROS 2.
Expand Down
2 changes: 2 additions & 0 deletions docs/stretch3-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

> Please note that this workspace is only tested in simulation.

> Last tested on commit [a9e1166](https://github.com/j3soon/ros2-essentials/commit/a9e116664353b8d874d7e559d023c625b08c9dd1) by [@j3soon](https://github.com/j3soon).

## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/template-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

This template will help you set up a ROS-Humble environment quickly.

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

To make debugging reproducible, this should reference the tested commit hash (and optionally the date).

🤖 Prompt for AI Agents 
In `@docs/template-ws/index.md` at line 14, Replace the placeholder "TODO" in the
"Last tested on TODO." line with a concrete identifier: the commit SHA
(preferred) and optionally the date used for testing (e.g., "Last tested on
commit abc1234 (2026-02-05)"); update the text exactly where the phrase appears
so it reads with the chosen commit hash and/or date to make the test reference
reproducible.


## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/turtlebot3-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

> Please note that this workspace is only tested in simulation.

> Last tested on TODO.

## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down
2 changes: 2 additions & 0 deletions docs/vlp-ws/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
![Docker image version](https://img.shields.io/docker/v/j3soon/ros2-vlp-ws)
![Docker image size](https://img.shields.io/docker/image-size/j3soon/ros2-vlp-ws)

> Last tested on TODO.
Copy link

@coderabbitai coderabbitai bot Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace the TODO with a concrete commit reference.
Please include the tested commit hash and author to keep the note actionable.

🤖 Prompt for AI Agents 
In `@docs/vlp-ws/index.md` at line 12, Replace the placeholder "Last tested on
TODO." with a concrete commit reference: include the short or full commit hash
and the author (e.g., "Last tested on <commit-hash> by <author-name>") and
optionally the commit date; update the line in docs/vlp-ws/index.md so the note
reads a specific, actionable reference rather than TODO.


## 🐳 Start Container

> Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.
Expand Down