Helm first release

.github/workflows/helm-doc.yaml

@@ -0,0 +1,41 @@
+---
+name: documentation
+
+on:
+  push:
+    branches:
+      - devel
+  workflow_dispatch:
+
+jobs:
+  release:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+      - uses: addnab/docker-run-action@v3
+        with:
+          options: -v ${{ github.workspace }}/charts:/helm-docs
+          image: jnorwood/helm-docs:v1.14.2
+          run: /usr/bin/helm-docs --skip-version-footer
+      - run: |
+          git add .
+          if ! git diff --cached --quiet; then
+            git commit -m "Automated chart README.md update"
+            git push
+          else
+            echo "No changes to commit."
+          fi
+      # # Commit all changed files back to the repository
+      # - uses: stefanzweifel/git-auto-commit-action@v5
+      #   with:
+      #     commit_message: Update Chart readme

.github/workflows/helm-releaser.yaml

@@ -0,0 +1,29 @@
+---
+name: Release Charts
+
+on:
+  push:
+    tags:
+      - '*'  # Triggers on any tag push
+  workflow_dispatch:
+
+jobs:
+  release:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

README.md

@@ -12,6 +12,18 @@ Kubernetes manifest files for simulation of a Robotnik RB-theron on ROS2
 
 ### Helm chart
 
+[Helm chart documentation](charts/rb-theron-sim/README.md)
+
+### helm repo
+
+```bash
+helm repo add fluidos-robotic-uc https://fluidos-project.github.io/robotic-logistics-use-case
+helm repo update
+helm upgrade --install test fluidos-robotic-uc/rb-theron-sim
+```
+
+### local development
+
 ```bash
 git clone https://github.com/fluidos-project/robotic-logistics-use-case.git
 cd robotic-logistics-use-case/helm

helm/rb-theron-sim/Chart.yaml → charts/rb-theron-sim/Chart.yaml

@@ -2,7 +2,7 @@
 name: rb-theron-sim
 description: Robotnik RB-THERON Simulation on ROS2
 type: application
-version: 0.0.1
+version: 0.0.3
 apiVersion: v2
 keywords:
   - kubernetes
@@ -21,11 +21,12 @@ icon: https://avatars.githubusercontent.com/u/7921985?s=200&v=4
 maintainers:
   - name: Guillem Gari
     url: https://github.com/ggari-robotnik
+    email: [email protected]
 annotations:
   artifacthub.io/changes: |
     - kind: Added
-      description: "first version"
+      description: "Format and repository fixing"
   artifacthub.io/license: BSD 3-Clause
   artifacthub.io/screenshots: |
     - title: Rviz interface
-      url: https://github.com/fluidos-project/robotic-logistics-use-case/blob/main/doc/k8s-ros2-rb-theron-rviz-web.gif
+      url: https://github.com/fluidos-project/robotic-logistics-use-case/blob/8c4578fc15574a765ba5ef047ed9ecc117669d84/doc/k8s-ros2-rb-theron-rviz-web.gif

charts/rb-theron-sim/README.md

@@ -0,0 +1,41 @@
+# rb-theron-sim
+
+![Version: 0.0.3](https://img.shields.io/badge/Version-0.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
+
+Robotnik RB-THERON Simulation on ROS2
+
+**Homepage:** <https://github.com/fluidos-project/robotic-logistics-use-case>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Guillem Gari | <[email protected]> | <https://github.com/ggari-robotnik> |
+
+## Source Code
+
+* <https://github.com/fluidos-project/robotic-logistics-use-case>
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| containers.environment.production | bool | `true` | Removes the debug features. |
+| ros.discovery | string | `"subnet"` | Middleware automatic discovery range. Allowed values: `localhost` `subnet`, `off` or `system_default`. |
+| ros.distro | string | `"humble"` | ROS distribution. Allowed values: `humble` or `iron`. |
+| ros.gazebo.map | string | `"opil_factory"` | Map to use in the simulation. |
+| ros.images.simulation.flavor | string | `"rb-theron-gazebo"` | flavor tag for simulation image |
+| ros.images.simulation.project | string | `"robotnik"` | project for simulation image |
+| ros.images.simulation.registry | string | `"docker.io"` | registry for simulation image |
+| ros.images.simulation.repository | string | `"robotnik-simulations"` | repository for simulation image |
+| ros.images.simulation.version | string | `"0.3.0-rc07"` | version tag for simulation image |
+| ros.images.zenoh.project | string | `"robotnik"` | project for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp` |
+| ros.images.zenoh.registry | string | `"docker.io"` | registry for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp` |
+| ros.images.zenoh.repository | string | `"zenoh-rmw"` | repository for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp` |
+| ros.images.zenoh.version | string | `"0.0.1-rc00"` | version tag for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp` |
+| ros.rmw | string | `"rmw_cyclonedds_cpp"` | ROS MiddleWare Implementation. Allowed values: `rmw_cyclonedds_cpp` `rmw_fastrtps_cpp`, or `rmw_zenoh_cpp`. zenoh is only available in distro `iron` or above |
+| services.gazebo.name | string | `"robots-gazebo"` | Gazebo service name. |
+| services.gazebo.port | int | `11345` | Gazebo service port. |
+| services.zenoh.name | string | `"zenoh-router"` | Zenoh router service name. ignored if `ros.rwm` is not `rmw_zenoh_cpp` |
+| services.zenoh.port | int | `7447` | Zenoh router service port. ignored if `ros.rwm` is not `rmw_zenoh_cpp` |
+| services.zenoh.proto | string | `"TCP"` | Zenoh router service protocol. ignored if `ros.rwm` is not `rmw_zenoh_cpp` |

charts/rb-theron-sim/values-iron-zenoh.yaml

@@ -0,0 +1,52 @@
+---
+## @section Containers parameters
+containers:
+  environment:
+    # -- Removes the debug features.
+    production: false
+## @section ROS parameters
+ros:
+  # -- ROS MiddleWare Implementation. Allowed values: `rmw_cyclonedds_cpp` `rmw_fastrtps_cpp`, or `rmw_zenoh_cpp`. zenoh is only available in distro `iron` or above
+  rmw: rmw_zenoh_cpp
+  # -- Middleware automatic discovery range. Allowed values: `localhost` `subnet`, `off` or `system_default`.
+  discovery: subnet
+  # -- ROS distribution. Allowed values: `humble` or `iron`.
+  distro: iron
+  images:
+    simulation:
+      # -- registry for simulation image
+      registry: "docker.io"
+      # -- project for simulation image
+      project: "robotnik"
+      # -- repository for simulation image
+      repository: "robotnik-simulations"
+      # -- flavor tag for simulation image
+      flavor: "rb-theron-gazebo"
+      # -- version tag for simulation image
+      version: 0.3.0-rc07
+    zenoh:
+      # -- registry for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+      registry: "docker.io"
+      # -- project for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+      project: "robotnik"
+      # -- repository for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+      repository: "zenoh-rmw"
+      # -- version tag for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+      version: 0.0.1-rc00
+  gazebo:
+    # -- Map to use in the simulation.
+    map: opil_factory
+## @section Services parameters
+services:
+  gazebo:
+    # -- Gazebo service name.
+    name: robots-gazebo
+    # -- Gazebo service port.
+    port: 11345
+  zenoh:
+    # -- Zenoh router service name. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+    name: zenoh-router
+    # -- Zenoh router service port. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+    port: 7447
+    # -- Zenoh router service protocol. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+    proto: TCP

charts/rb-theron-sim/values.yaml

@@ -0,0 +1,52 @@
+---
+## @section Containers parameters
+containers:
+  environment:
+    # -- Removes the debug features.
+    production: true
+## @section ROS parameters
+ros:
+  # -- ROS MiddleWare Implementation. Allowed values: `rmw_cyclonedds_cpp` `rmw_fastrtps_cpp`, or `rmw_zenoh_cpp`. zenoh is only available in distro `iron` or above
+  rmw: rmw_cyclonedds_cpp
+  # -- Middleware automatic discovery range. Allowed values: `localhost` `subnet`, `off` or `system_default`.
+  discovery: subnet
+  # -- ROS distribution. Allowed values: `humble` or `iron`.
+  distro: humble
+  images:
+    simulation:
+      # -- registry for simulation image
+      registry: "docker.io"
+      # -- project for simulation image
+      project: "robotnik"
+      # -- repository for simulation image
+      repository: "robotnik-simulations"
+      # -- flavor tag for simulation image
+      flavor: "rb-theron-gazebo"
+      # -- version tag for simulation image
+      version: 0.3.0-rc07
+    zenoh:
+      # -- registry for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+      registry: "docker.io"
+      # -- project for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+      project: "robotnik"
+      # -- repository for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+      repository: "zenoh-rmw"
+      # -- version tag for zenoh-router image. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+      version: 0.0.1-rc00
+  gazebo:
+    # -- Map to use in the simulation.
+    map: opil_factory
+## @section Services parameters
+services:
+  gazebo:
+    # -- Gazebo service name.
+    name: robots-gazebo
+    # -- Gazebo service port.
+    port: 11345
+  zenoh:
+    # -- Zenoh router service name. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+    name: zenoh-router
+    # -- Zenoh router service port. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+    port: 7447
+    # -- Zenoh router service protocol. ignored if `ros.rwm` is not `rmw_zenoh_cpp`
+    proto: TCP

semicolon_delimited_script

@@ -0,0 +1 @@
+/usr/bin/helm-docs --skip-version-footer