From 8de2137ea20fda10e10a6631935eaa2d433ec651 Mon Sep 17 00:00:00 2001 From: Felix Exner Date: Fri, 7 Mar 2025 13:18:17 +0100 Subject: [PATCH 1/4] Add build_status page to documentation --- doc/build_status.html | 279 ++++++++++++++++++++++++++++++++++++++++++ doc/build_status.rst | 24 ++++ index.rst | 1 + 3 files changed, 304 insertions(+) create mode 100644 doc/build_status.html create mode 100644 doc/build_status.rst diff --git a/doc/build_status.html b/doc/build_status.html new file mode 100644 index 0000000..a6b4da5 --- /dev/null +++ b/doc/build_status.html @@ -0,0 +1,279 @@ + + + + + UR ROS build status + + + + +

ROS 2

+

ur_robot_driver

+ + + + + + + + + + + + + + + + + + + + + +
HumbleJazzyRolling
humblemainmain
+ + Humble Binary Main +
+ + Humble Binary Testing +
+ + Humble Semi-Binary Main +
+ + Humble Semi-Binary Testing + + 		+ + Jazzy Binary Main +
+ + Jazzy Binary Testing +
+ + Jazzy Semi-Binary Main +
+ + Jazzy Semi-Binary Testing + + 		+ + Rolling Binary Main +
+ + Rolling Binary Testing +
+ + Rolling Semi-Binary Main +
+ + Rolling Semi-Binary Testing + +
+
+
+
+
+ + 		+
+
+
+
+ + 		+
+
+
+
+ +
+ +

ur_description

+ + + + + + + + + + + + + + + + + + + + + +
HumbleJazzyRolling
humblerollingrolling
+ + Humble Binary Main +
+ + Humble Binary Testing +
+ 		+ + Jazzy Binary Main +
+ + Jazzy Binary Testing +
+ 		+ + Rolling Binary Main +
+ + Rolling Binary Testing +
+
+ + + + + +
+ +

ur_simulation_gz

+ + + + + + + + + + + + + + + + + + + + + +
HumbleJazzyRolling
humbleros2ros2
+ + Humble Binary Main +
+ + Humble Binary Testing +
+ + Humble Semi-Binary Main +
+ + Humble Semi-Binary Testing + + 		+ + Jazzy Binary Main +
+ + Jazzy Binary Testing +
+ + Jazzy Semi-Binary Main +
+ + Jazzy Semi-Binary Testing + + 		+ + Rolling Binary Main +
+ + Rolling Binary Testing +
+ + Rolling Semi-Binary Main +
+ + Rolling Semi-Binary Testing + +
+ + + + + +
+ +

ROS 1

+

ur_robot_driver

+ + + + + + + +
+ + +
+ + +
+ + +
+ + +
+
+ +
+ + + diff --git a/doc/build_status.rst b/doc/build_status.rst new file mode 100644 index 0000000..69e6767 --- /dev/null +++ b/doc/build_status.rst @@ -0,0 +1,24 @@ +Build status +============ + +ur_client_library +----------------- + +.. image:: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/ci.yml/badge.svg + :alt: Integration Tests + :target: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/ci.yml + +.. image:: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/industrial-ci.yml/badge.svg + :alt: Industrial CI (all ROS distributions) + :target: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/industrial-ci.yml + +.. image:: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/win-build.yml/badge.svg + :alt: Windows Build + :target: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/win-build.yml + +.. image:: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/sphinx_build.yml/badge.svg + :alt: Documentation Build + :target: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/sphinx_build.yml + +.. raw:: html + :file: build_status.html diff --git a/index.rst b/index.rst index 9f7736f..2d60bd2 100644 --- a/index.rst +++ b/index.rst @@ -17,3 +17,4 @@ This repositorycontains documentation and ROS 2 packages for Universal Robots. ur_simulation_gz Tutorial examples doc/migration_notes.rst + doc/build_status From c31bd4cfb75af369e879c15b9fe783e23c7ecbcf Mon Sep 17 00:00:00 2001 From: Felix Exner Date: Fri, 7 Mar 2025 13:24:23 +0100 Subject: [PATCH 2/4] Add explanations about the different builds --- doc/build_status.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/build_status.rst b/doc/build_status.rst index 69e6767..aa5dd2c 100644 --- a/doc/build_status.rst +++ b/doc/build_status.rst @@ -1,6 +1,8 @@ Build status ============ +This page gives a detailed overview of the build status of the full ROS-related software stack. Please note that due to upstream changes some pipelines might turn red temporarily which can be expected behavior, especially the binary-main builds. + ur_client_library ----------------- @@ -22,3 +24,22 @@ ur_client_library .. raw:: html :file: build_status.html + +Explanations +------------ + +There are different stages checking current and future compatibility of the packages. + +- Binary builds - against released packages (main and testing) in ROS distributions. Shows that + direct local build is possible and integration tests work against the released state. Released + upstream packages land in testing directly after being built by the ROS buildfarm, while main + receives updates on discrete manually triggered events. This is why the binary-main pipeline + might turn red temporarily while the binary-testing pipelines are green. This means that no + further action is required from the maintainers, this will sort itself out with the next sync. + +- Semi-binary builds - against released core ROS packages (main and testing), but the immediate + dependencies are pulled from source. Shows that local build with dependencies is possible and if + this fails we can expect that after the next package sync we will not be able to build. For + example, if upstream changes would make the current branch fail and those changes have **not** + been released, yet, we might adapt to these changes already leaving us also with a failing + binary-testing build, while the semi-binary builds should turn green. From b05459dc41810827bb8cfe4354418c71bc2f0d9b Mon Sep 17 00:00:00 2001 From: Felix Exner Date: Thu, 13 Mar 2025 09:23:04 +0100 Subject: [PATCH 3/4] Use rst-only build status The tables are kept as inline HTML for maintenance reasons. To my knowledge there is no rst table structure that allows grouping all badges for a distribution together. --- doc/build_status.html | 279 ----------------------------------------- doc/build_status.rst | 283 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 280 insertions(+), 282 deletions(-) delete mode 100644 doc/build_status.html diff --git a/doc/build_status.html b/doc/build_status.html deleted file mode 100644 index a6b4da5..0000000 --- a/doc/build_status.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - UR ROS build status - - - - -

ROS 2

-

ur_robot_driver

- - - - - - - - - - - - - - - - - - - - - -
HumbleJazzyRolling
humblemainmain
- - Humble Binary Main -
- - Humble Binary Testing -
- - Humble Semi-Binary Main -
- - Humble Semi-Binary Testing - - 		- - Jazzy Binary Main -
- - Jazzy Binary Testing -
- - Jazzy Semi-Binary Main -
- - Jazzy Semi-Binary Testing - - 		- - Rolling Binary Main -
- - Rolling Binary Testing -
- - Rolling Semi-Binary Main -
- - Rolling Semi-Binary Testing - -
-
-
-
-
- - 		-
-
-
-
- - 		-
-
-
-
- -
- -

ur_description

- - - - - - - - - - - - - - - - - - - - - -
HumbleJazzyRolling
humblerollingrolling
- - Humble Binary Main -
- - Humble Binary Testing -
- 		- - Jazzy Binary Main -
- - Jazzy Binary Testing -
- 		- - Rolling Binary Main -
- - Rolling Binary Testing -
-
- - - - - -
- -

ur_simulation_gz

- - - - - - - - - - - - - - - - - - - - - -
HumbleJazzyRolling
humbleros2ros2
- - Humble Binary Main -
- - Humble Binary Testing -
- - Humble Semi-Binary Main -
- - Humble Semi-Binary Testing - - 		- - Jazzy Binary Main -
- - Jazzy Binary Testing -
- - Jazzy Semi-Binary Main -
- - Jazzy Semi-Binary Testing - - 		- - Rolling Binary Main -
- - Rolling Binary Testing -
- - Rolling Semi-Binary Main -
- - Rolling Semi-Binary Testing - -
- - - - - -
- -

ROS 1

-

ur_robot_driver

- - - - - - - -
- - -
- - -
- - -
- - -
-
- -
- - - diff --git a/doc/build_status.rst b/doc/build_status.rst index aa5dd2c..2cac7c2 100644 --- a/doc/build_status.rst +++ b/doc/build_status.rst @@ -3,6 +3,286 @@ Build status This page gives a detailed overview of the build status of the full ROS-related software stack. Please note that due to upstream changes some pipelines might turn red temporarily which can be expected behavior, especially the binary-main builds. +ROS 2 +----- + +ur_robot_driver +~~~~~~~~~~~~~~~ + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
HumbleJazzyRolling
humblemainmain
+ + Humble Binary Main +
+ + Humble Binary Testing +
+ + Humble Semi-Binary Main +
+ + Humble Semi-Binary Testing + + 		+ + Jazzy Binary Main +
+ + Jazzy Binary Testing +
+ + Jazzy Semi-Binary Main +
+ + Jazzy Semi-Binary Testing + + 		+ + Rolling Binary Main +
+ + Rolling Binary Testing +
+ + Rolling Semi-Binary Main +
+ + Rolling Semi-Binary Testing + +
+
+
+
+
+ + 		+
+
+
+
+ + 		+
+
+
+
+ +
+ +ur_description +~~~~~~~~~~~~~~ + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
HumbleJazzyRolling
humblerollingrolling
+ + Humble Binary Main +
+ + Humble Binary Testing +
+ 		+ + Jazzy Binary Main +
+ + Jazzy Binary Testing +
+ 		+ + Rolling Binary Main +
+ + Rolling Binary Testing +
+
+ + + + + +
+ +ur_simulation_gz +~~~~~~~~~~~~~~~~ + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
HumbleJazzyRolling
humbleros2ros2
+ + Humble Binary Main +
+ + Humble Binary Testing +
+ + Humble Semi-Binary Main +
+ + Humble Semi-Binary Testing + + 		+ + Jazzy Binary Main +
+ + Jazzy Binary Testing +
+ + Jazzy Semi-Binary Main +
+ + Jazzy Semi-Binary Testing + + 		+ + Rolling Binary Main +
+ + Rolling Binary Testing +
+ + Rolling Semi-Binary Main +
+ + Rolling Semi-Binary Testing + +
+ + + + + +
+ +ROS 1 +----- + +ur_robot_driver +~~~~~~~~~~~~~~~ + +.. raw:: html + + + + + + + + +
+ + +
+ + +
+ + +
+ + +
+
+ +
+ ur_client_library ----------------- @@ -22,9 +302,6 @@ ur_client_library :alt: Documentation Build :target: https://github.com/UniversalRobots/Universal_Robots_Client_Library/actions/workflows/sphinx_build.yml -.. raw:: html - :file: build_status.html - Explanations ------------ From 8ec47b7033401f5326cdb33b2e1f78c5c6b321c0 Mon Sep 17 00:00:00 2001 From: Felix Exner Date: Thu, 13 Mar 2025 09:35:54 +0100 Subject: [PATCH 4/4] Make tables more compact by moving the branch name into the header row --- doc/build_status.rst | 39 ++++++++++++--------------------------- 1 file changed, 12 insertions(+), 27 deletions(-) diff --git a/doc/build_status.rst b/doc/build_status.rst index 2cac7c2..6a5337e 100644 --- a/doc/build_status.rst +++ b/doc/build_status.rst @@ -12,17 +12,12 @@ ur_robot_driver .. raw:: html - - - - - - - - - + + + + - + - +
HumbleJazzyRolling
humblemainmain
Humble (branch humble)Jazzy (branch main)Rolling (branch main)


@@ -110,14 +105,9 @@ ur_description - - - - - - - - + + +
HumbleJazzyRolling
humblerollingrollingHumble (branch humble)Jazzy (branch rolling)Rolling (branch rolling)
@@ -171,14 +161,9 @@ ur_simulation_gz - - - - - - - - + + +
HumbleJazzyRolling
humbleros2ros2Humble (branch humble)Jazzy (branch ros2)Rolling (branch ros2)