Add automatic issue creation on failed CI runs

Felix Exner · urfeex · commit 76c22d8dd7f7 · 2025-02-17T15:13:04.000+01:00
diff --git a/.github/issue_template_failed_ci.md b/.github/issue_template_failed_ci.md
@@ -0,0 +1,32 @@
+---
+title: Failed build job {{ env.UPSTREAM_TYPE }} ({{ env.DISTRO }}/{{ env.REPO }})
+labels: CI
+---
+The scheduled build for branch `{{ env.REF }}` failed.
+
+**Upstream build type:** {{ env.UPSTREAM_TYPE }}
+**ROS DISTRO:** {{ env.DISTRO }}
+**Repo:** {{ env.REPO }}
+
+Please check the log output for details: {{ env.URL }}
+
+Please note that this issue has different implications based on the build type. To get an idea of
+the complete situation, please have a look at the [current build
+status](https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/blob/main/ci_status.md)
+
+- If the *Upstream build type* is "binary":
+  - If the *Repo* is "testing", it is well possible that an upstream package did make an
+    API-breaking change that hasn't been released, yet. If the semi-binary builds are OK, this
+    package has made the necessary changes, already. It is expected to sort itself out by itself,
+    once the upstream package has been released. If the semi-binary builds are failing, as well,
+    this package has to be updated.
+  - If the *Repo* is "main", but the "testing" builds are green, we are only waiting for a Sync
+    to happen.
+- If the *Upstream build type* is "semi-binary":
+  - If both, main and testing, are failing, there has been an API-breaking change in an upstream
+    package. This package should get updated soon. If the upstream package gets released without
+    updating this package, the "binary / testing" builds will also fail. In this case, this package
+    needs to get updated and released ASAP.
+  - If not both, main and testing, are failing, there is an upstream dependency with an API-breaking
+    change that is not part of the upstream workspace. This should rarely happen and needs action
+    from the package maintainers.
diff --git a/.github/workflows/humble-binary-main.yml b/.github/workflows/humble-binary-main.yml
@@ -11,5 +11,6 @@ jobs:
     with:
       ros_distro: humble
       ros_repo: main
+      upstream_type: binary
       upstream_workspace: Universal_Robots_ROS2_Driver-not-released.humble.repos
       ref_for_scheduled_build: humble
diff --git a/.github/workflows/humble-binary-testing.yml b/.github/workflows/humble-binary-testing.yml
@@ -12,5 +12,6 @@ jobs:
     with:
       ros_distro: humble
       ros_repo: testing
+      upstream_type: binary
       upstream_workspace: Universal_Robots_ROS2_Driver-not-released.humble.repos
       ref_for_scheduled_build: humble
diff --git a/.github/workflows/humble-semi-binary-main.yml b/.github/workflows/humble-semi-binary-main.yml
@@ -12,5 +12,6 @@ jobs:
     with:
       ros_distro: humble
       ros_repo: main
+      upstream_type: semi-binary
       upstream_workspace: Universal_Robots_ROS2_Driver.humble.repos
       ref_for_scheduled_build: humble
diff --git a/.github/workflows/humble-semi-binary-testing.yml b/.github/workflows/humble-semi-binary-testing.yml
@@ -12,5 +12,6 @@ jobs:
     with:
       ros_distro: humble
       ros_repo: testing
+      upstream_type: semi-binary
       upstream_workspace: Universal_Robots_ROS2_Driver.humble.repos
       ref_for_scheduled_build: humble
diff --git a/.github/workflows/iron-binary-main.yml b/.github/workflows/iron-binary-main.yml
@@ -17,4 +17,6 @@ jobs:
     with:
       ros_distro: iron
       ros_repo: main
+      upstream_type: binary
+      upstream_workspace: Universal_Robots_ROS2_Driver-not-released.iron.repos
       ref_for_scheduled_build: iron
diff --git a/.github/workflows/jazzy-binary-main.yml b/.github/workflows/jazzy-binary-main.yml
@@ -17,5 +17,6 @@ jobs:
     with:
       ros_distro: jazzy
       ros_repo: main
+      upstream_type: binary
       upstream_workspace: Universal_Robots_ROS2_Driver-not-released.jazzy.repos
       ref_for_scheduled_build: main
diff --git a/.github/workflows/jazzy-binary-testing.yml b/.github/workflows/jazzy-binary-testing.yml
@@ -17,5 +17,6 @@ jobs:
     with:
       ros_distro: jazzy
       ros_repo: testing
+      upstream_type: binary
       upstream_workspace: Universal_Robots_ROS2_Driver-not-released.jazzy.repos
       ref_for_scheduled_build: main
diff --git a/.github/workflows/jazzy-semi-binary-main.yml b/.github/workflows/jazzy-semi-binary-main.yml
@@ -17,5 +17,6 @@ jobs:
     with:
       ros_distro: jazzy
       ros_repo: main
+      upstream_type: semi-binary
       upstream_workspace: Universal_Robots_ROS2_Driver.jazzy.repos
       ref_for_scheduled_build: main
diff --git a/.github/workflows/jazzy-semi-binary-testing.yml b/.github/workflows/jazzy-semi-binary-testing.yml
@@ -17,5 +17,6 @@ jobs:
     with:
       ros_distro: jazzy
       ros_repo: testing
+      upstream_type: semi-binary
       upstream_workspace: Universal_Robots_ROS2_Driver.jazzy.repos
       ref_for_scheduled_build: main
diff --git a/.github/workflows/reusable_ici.yml b/.github/workflows/reusable_ici.yml
@@ -9,7 +9,10 @@ on:
         default: ''
         required: false
         type: string
-
+      upstream_type:
+        description: 'Binary or semi-binary build'
+        required: true
+        type: string
       upstream_workspace:
         description: 'UPSTREAM_WORKSPACE variable for industrial_ci. Usually path to local .repos file.'
         required: true
@@ -68,3 +71,15 @@ jobs:
           ROS_REPO: ${{ inputs.ros_repo }}
           CMAKE_ARGS: -DUR_ROBOT_DRIVER_BUILD_INTEGRATION_TESTS=ON
           ADDITIONAL_DEBS: docker.io netcat-openbsd  # Needed for integration tests
+      - uses: JasonEtco/create-an-issue@v2
+        if: ${{ always() && (steps.ici.outputs.build_target_workspace == '2' || steps.ici.outputs.target_test_results == '1') && github.event_name == 'schedule'}}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          UPSTREAM_TYPE: ${{ inputs.upstream_type }}
+          REF: ${{ inputs.ref_for_scheduled_build }}
+          DISTRO: ${{ inputs.ros_distro }}
+          REPO: ${{ inputs.ros_repo }}
+          URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+        with:
+          update_existing: true
+          filename: .github/issue_template_failed_ci.md
diff --git a/.github/workflows/rolling-binary-main.yml b/.github/workflows/rolling-binary-main.yml
@@ -17,5 +17,6 @@ jobs:
     with:
       ros_distro: rolling
       ros_repo: main
+      upstream_type: binary
       upstream_workspace: Universal_Robots_ROS2_Driver-not-released.rolling.repos
       ref_for_scheduled_build: main
diff --git a/.github/workflows/rolling-binary-testing.yml b/.github/workflows/rolling-binary-testing.yml
@@ -17,5 +17,6 @@ jobs:
     with:
       ros_distro: rolling
       ros_repo: testing
+      upstream_type: binary
       upstream_workspace: Universal_Robots_ROS2_Driver-not-released.rolling.repos
       ref_for_scheduled_build: main
diff --git a/.github/workflows/rolling-semi-binary-main.yml b/.github/workflows/rolling-semi-binary-main.yml
@@ -17,5 +17,6 @@ jobs:
     with:
       ros_distro: rolling
       ros_repo: main
+      upstream_type: semi-binary
       upstream_workspace: Universal_Robots_ROS2_Driver.rolling.repos
       ref_for_scheduled_build: main
diff --git a/.github/workflows/rolling-semi-binary-testing.yml b/.github/workflows/rolling-semi-binary-testing.yml
@@ -17,5 +17,6 @@ jobs:
     with:
       ros_distro: rolling
       ros_repo: testing
+      upstream_type: semi-binary
       upstream_workspace: Universal_Robots_ROS2_Driver.rolling.repos
       ref_for_scheduled_build: main
