feat(ad-api): add release status (#407)

isamu-takagi · mitsudome-r · web-flow · commit 1c3f536dd284 · 2023-07-03T23:05:46.000+09:00
* add release status

Signed-off-by: Takagi, Isamu &lt;isamu.takagi@tier4.jp&gt;

* Update docs/design/autoware-interfaces/templates/autoware-interface.jinja2

---------

Signed-off-by: Takagi, Isamu &lt;isamu.takagi@tier4.jp&gt;
Co-authored-by: Ryohsuke Mitsudome &lt;43976834+mitsudome-r@users.noreply.github.com&gt;
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/fail_safe/mrm_state.md b/docs/design/autoware-interfaces/ad-api/list/api/fail_safe/mrm_state.md
@@ -1,5 +1,6 @@
 ---
 title: /api/fail_safe/mrm_state
+status: not released
 method: notification
 type:
   name: autoware_adapi_v1_msgs/msg/MrmState
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/interface/version.md b/docs/design/autoware-interfaces/ad-api/list/api/interface/version.md
@@ -1,5 +1,6 @@
 ---
 title: /api/interface/version
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_version_msgs/srv/InterfaceVersion
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/localization/initialization_state.md b/docs/design/autoware-interfaces/ad-api/list/api/localization/initialization_state.md
@@ -1,5 +1,6 @@
 ---
 title: /api/localization/initialization_state
+status: v1.0.0
 method: notification
 type:
   name: autoware_adapi_v1_msgs/msg/LocalizationInitializationState
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/localization/initialize.md b/docs/design/autoware-interfaces/ad-api/list/api/localization/initialize.md
@@ -1,5 +1,6 @@
 ---
 title: /api/localization/initialize
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/InitializeLocalization
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/motion/accept_start.md b/docs/design/autoware-interfaces/ad-api/list/api/motion/accept_start.md
@@ -1,5 +1,6 @@
 ---
 title: /api/motion/accept_start
+status: not released
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/AcceptStart
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/motion/state.md b/docs/design/autoware-interfaces/ad-api/list/api/motion/state.md
@@ -1,5 +1,6 @@
 ---
 title: /api/motion/state
+status: not released
 method: notification
 type:
   name: autoware_adapi_v1_msgs/msg/MotionState
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_autonomous.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_autonomous.md
@@ -1,5 +1,6 @@
 ---
 title: /api/operation_mode/change_to_autonomous
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_local.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_local.md
@@ -1,5 +1,6 @@
 ---
 title: /api/operation_mode/change_to_local
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_remote.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_remote.md
@@ -1,5 +1,6 @@
 ---
 title: /api/operation_mode/change_to_remote
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_stop.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/change_to_stop.md
@@ -1,5 +1,6 @@
 ---
 title: /api/operation_mode/change_to_stop
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/disable_autoware_control.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/disable_autoware_control.md
@@ -1,5 +1,6 @@
 ---
 title: /api/operation_mode/disable_autoware_control
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/enable_autoware_control.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/enable_autoware_control.md
@@ -1,5 +1,6 @@
 ---
 title: /api/operation_mode/enable_autoware_control
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/ChangeOperationMode
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/state.md b/docs/design/autoware-interfaces/ad-api/list/api/operation_mode/state.md
@@ -1,5 +1,6 @@
 ---
 title: /api/operation_mode/state
+status: v1.0.0
 method: notification
 type:
   name: autoware_adapi_v1_msgs/msg/OperationModeState
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/planning/steering_factors.md b/docs/design/autoware-interfaces/ad-api/list/api/planning/steering_factors.md
@@ -1,5 +1,6 @@
 ---
 title: /api/planning/steering_factors
+status: not released
 method: realtime stream
 type:
   name: autoware_adapi_v1_msgs/msg/SteeringFactorArray
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/planning/velocity_factors.md b/docs/design/autoware-interfaces/ad-api/list/api/planning/velocity_factors.md
@@ -1,5 +1,6 @@
 ---
 title: /api/planning/velocity_factors
+status: not released
 method: realtime stream
 type:
   name: autoware_adapi_v1_msgs/msg/VelocityFactorArray
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/routing/clear_route.md b/docs/design/autoware-interfaces/ad-api/list/api/routing/clear_route.md
@@ -1,5 +1,6 @@
 ---
 title: /api/routing/clear_route
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/ClearRoute
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/routing/route.md b/docs/design/autoware-interfaces/ad-api/list/api/routing/route.md
@@ -1,5 +1,6 @@
 ---
 title: /api/routing/route
+status: v1.0.0
 method: notification
 type:
   name: autoware_adapi_v1_msgs/msg/Route
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/routing/set_route.md b/docs/design/autoware-interfaces/ad-api/list/api/routing/set_route.md
@@ -1,5 +1,6 @@
 ---
 title: /api/routing/set_route
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/SetRoute
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/routing/set_route_points.md b/docs/design/autoware-interfaces/ad-api/list/api/routing/set_route_points.md
@@ -1,5 +1,6 @@
 ---
 title: /api/routing/set_route_points
+status: v1.0.0
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/SetRoutePoints
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/routing/state.md b/docs/design/autoware-interfaces/ad-api/list/api/routing/state.md
@@ -1,5 +1,6 @@
 ---
 title: /api/routing/state
+status: v1.0.0
 method: notification
 type:
   name: autoware_adapi_v1_msgs/msg/RouteState
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/vehicle/dimensions.md b/docs/design/autoware-interfaces/ad-api/list/api/vehicle/dimensions.md
@@ -1,5 +1,6 @@
 ---
 title: /api/vehicle/dimensions
+status: not released
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/GetVehicleDimensions
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/vehicle/doors/layout.md b/docs/design/autoware-interfaces/ad-api/list/api/vehicle/doors/layout.md
@@ -1,5 +1,6 @@
 ---
 title: /api/vehicle/doors/layout
+status: not released
 method: function call
 type:
   name: autoware_adapi_v1_msgs/srv/GetDoorLayout
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/vehicle/doors/status.md b/docs/design/autoware-interfaces/ad-api/list/api/vehicle/doors/status.md
@@ -1,5 +1,6 @@
 ---
 title: /api/vehicle/doors/status
+status: not released
 method: notification
 type:
   name: autoware_adapi_v1_msgs/msg/DoorStatusArray
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/vehicle/kinematics.md b/docs/design/autoware-interfaces/ad-api/list/api/vehicle/kinematics.md
@@ -1,5 +1,6 @@
 ---
 title: /api/vehicle/kinematics
+status: not released
 method: realtime stream
 type:
   name: autoware_adapi_v1_msgs/msg/VehicleKinematics
diff --git a/docs/design/autoware-interfaces/ad-api/list/api/vehicle/status.md b/docs/design/autoware-interfaces/ad-api/list/api/vehicle/status.md
@@ -1,5 +1,6 @@
 ---
 title: /api/vehicle/status
+status: not released
 method: notification
 type:
   name: autoware_adapi_v1_msgs/msg/VehicleStatus
diff --git a/docs/design/autoware-interfaces/templates/autoware-interface.jinja2 b/docs/design/autoware-interfaces/templates/autoware-interface.jinja2
@@ -1,7 +1,10 @@
 # {{ title }}
 
+## Status
+
+- Latest Version: {{ status }}
 - Method: {{ method }}
-- Type: {{ create_relative_link(type.name, 'design/autoware-interfaces/ad-api/types/' + type.name) }}
+- Data Type: {{ create_relative_link(type.name, 'design/autoware-interfaces/ad-api/types/' + type.name) }}
 
 ## Description
 
diff --git a/tools/autoware-interfaces/generate.py b/tools/autoware-interfaces/generate.py
@@ -36,10 +36,17 @@ def load_markdown_metadata(path: Path):
     lines = path.read_text().splitlines()
     if (2 < len(lines)) and (lines[0] == "---"):
         data = lines[1:lines.index("---", 1)]
-        return yaml.safe_load("\n".join(data))
+        data = yaml.safe_load("\n".join(data))
+        return test_markdown_metadata(data, path)
     return None
 
 
+def test_markdown_metadata(data, path):
+    if "status" not in data:
+        raise KeyError(f"status in {path}")
+    return data
+
+
 def is_documentation_msg(name: str):
     targets = set(["autoware_adapi_version_msgs", "autoware_adapi_v1_msgs"])
     return name.split("/")[0] in targets
@@ -89,12 +96,12 @@ def main():
     adapi = Path("docs/design/autoware-interfaces/ad-api/list/api")
     pages = (load_markdown_metadata(path) for path in adapi.glob("**/*.md"))
     pages = [page for page in pages if page]
-    names = (page["type"]["name"] for page in pages)
 
     # Create a field list for each data type.
+    names = (page["type"]["name"] for page in pages)
+    specs = {}
     visited = set()
     depends = set(names)
-    specs = {}
     while depends:
         name = depends.pop()
         parse_rosidl_file(depends, visited, specs, name)
@@ -116,7 +123,9 @@ def main():
 
     # Clean up data type pages.
     base = Path("docs/design/autoware-interfaces/ad-api/types")
-    shutil.rmtree(base)
+    for path in base.iterdir():
+        if path.is_dir():
+            shutil.rmtree(path)
 
     # Generate data type pages.
     for name in specs:
