chore: update from ros_dist to ros_distro added to readme description of images produced

Author: cooperj

.github/workflows/_build-image.yaml

@@ -11,7 +11,7 @@ on:
         description: Image name on the LCAS registry
         required: true
         type: string
-      ros_dist:
+      ros_distro:
         required: true
         type: string
       dockerfile:
@@ -52,16 +52,16 @@ jobs:
         with:
           flavor: latest=false
           labels: |
-            org.opencontainers.image.description=AOC Docker Image (${{ inputs.push_image }}, ${{ inputs.ros_dist }})
+            org.opencontainers.image.description=AOC Docker Image (${{ inputs.push_image }}, ${{ inputs.ros_distro }})
             org.opencontainers.image.authors=L-CAS Team
           images: lcas.lincoln.ac.uk/${{ inputs.push_image }}
           tags: |
-            type=raw,value=${{ inputs.ros_dist }}-staging
-            type=raw,enable=${{ github.event_name != 'pull_request' }},value=${{ inputs.ros_dist }}-latest
-            type=ref,enable=${{ github.event_name != 'pull_request' }},event=branch,prefix=${{ inputs.ros_dist }}-
-            type=semver,pattern={{version}},prefix=${{ inputs.ros_dist }}-
-            type=semver,pattern={{major}}.{{minor}},prefix=${{ inputs.ros_dist }}-
-            type=semver,pattern={{major}},prefix=${{ inputs.ros_dist }}-
+            type=raw,value=${{ inputs.ros_distro }}-staging
+            type=raw,enable=${{ github.event_name != 'pull_request' }},value=${{ inputs.ros_distro }}-latest
+            type=ref,enable=${{ github.event_name != 'pull_request' }},event=branch,prefix=${{ inputs.ros_distro }}-
+            type=semver,pattern={{version}},prefix=${{ inputs.ros_distro }}-
+            type=semver,pattern={{major}}.{{minor}},prefix=${{ inputs.ros_distro }}-
+            type=semver,pattern={{major}},prefix=${{ inputs.ros_distro }}-
 
       - uses: docker/setup-buildx-action@v3
 
@@ -73,10 +73,10 @@ jobs:
           file: ./${{ inputs.dockerfile }}
           platforms: ${{ inputs.architectures }}
           push: true
-          cache-from: type=registry,ref=lcas.lincoln.ac.uk/cache/${{ inputs.push_image }}:${{ inputs.ros_dist }}
-          cache-to:   type=registry,ref=lcas.lincoln.ac.uk/cache/${{ inputs.push_image }}:${{ inputs.ros_dist }},mode=max
+          cache-from: type=registry,ref=lcas.lincoln.ac.uk/cache/${{ inputs.push_image }}:${{ inputs.ros_distro }}
+          cache-to:   type=registry,ref=lcas.lincoln.ac.uk/cache/${{ inputs.push_image }}:${{ inputs.ros_distro }},mode=max
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           build-args: |
             BASE_IMAGE=${{ inputs.base_image }}
-            ROS_DISTRO=${{ inputs.ros_dist }}
+            ROS_DISTRO=${{ inputs.ros_distro }}

.github/workflows/docker-build-and-push.yaml

@@ -17,7 +17,7 @@ jobs:
     with:
       base_image:    ros:humble
       push_image:    ros
-      ros_dist:      humble
+      ros_distro:    humble
       dockerfile:    base.dockerfile
       architectures: linux/amd64,linux/arm64
     secrets: inherit
@@ -27,7 +27,7 @@ jobs:
     with:
       base_image:    ros:jazzy
       push_image:    ros
-      ros_dist:      jazzy
+      ros_distro:    jazzy
       dockerfile:    base.dockerfile
       architectures: linux/amd64,linux/arm64
     secrets: inherit
@@ -37,7 +37,7 @@ jobs:
     with:
       base_image:    nvidia/cuda:11.8.0-runtime-ubuntu22.04
       push_image:    ros_cuda
-      ros_dist:      humble
+      ros_distro:      humble
       dockerfile:    cuda.dockerfile
       architectures: linux/amd64
     secrets: inherit
@@ -47,7 +47,7 @@ jobs:
     with:
       base_image:    nvidia/cuda:12.6.3-cudnn-devel-ubuntu24.04
       push_image:    ros_cuda
-      ros_dist:      jazzy
+      ros_distro:    jazzy
       dockerfile:    cuda.dockerfile
       architectures: linux/amd64
     secrets: inherit
@@ -61,7 +61,7 @@ jobs:
       # Digest is immutable — no staging tag, no race condition, no cleanup
       base_image:    lcas.lincoln.ac.uk/ros_cuda@${{ needs.ros-cuda-humble.outputs.digest }}
       push_image:    ros_cuda_desktop
-      ros_dist:      humble
+      ros_distro:      humble
       dockerfile:    cuda_desktop.dockerfile
       architectures: linux/amd64
     secrets: inherit
@@ -72,7 +72,7 @@ jobs:
     with:
       base_image:    lcas.lincoln.ac.uk/ros_cuda@${{ needs.ros-cuda-jazzy.outputs.digest }}
       push_image:    ros_cuda_desktop
-      ros_dist:      jazzy
+      ros_distro:      jazzy
       dockerfile:    cuda_desktop.dockerfile
       architectures: linux/amd64
     secrets: inherit

README.md

@@ -1,2 +1,9 @@
 # aoc_container_base
-A repository of verstile ROS-enabled Docker containers
+
+A repository of verstile ROS-enabled Docker containers, orginally developed as apart of the [Agri-OpenCore (AOC) project](https://agri-opencore.org).
+
+| Container Name                        | Tags                  | Purpose                                                                                                                           |
+| ------------------------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| `lcas.lincoln.ac.uk/ros`              | { `humble`, `jazzy` } | Base ROS Container, the minimal environment you need for ROS                                                                      |
+| `lcas.lincoln.ac.uk/ros_cuda`         | { `humble`, `jazzy` } | ROS + Nvidia. When you need to use a GPU in your ROS environment for either better quality simulation or AI workloads.            |
+| `lcas.lincoln.ac.uk/ros_cuda_desktop` | { `humble`, `jazzy` } | ROS + Nvidia + Packages. Installs the `ros-{distro}-desktop` varient so there is the full ROS stack available.                    |