From a5942eaab14cf3a12e1ee49c94488733f6858333 Mon Sep 17 00:00:00 2001
From: Thomas Frank <thomas.frank@esrlabs.com>
Date: Thu, 21 Nov 2024 15:54:27 +0100
Subject: [PATCH] Add PR verification documentation

Signed-off-by: Thomas Frank <thomas.frank@esrlabs.com>
---
 .github/workflows/README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/.github/workflows/README.md b/.github/workflows/README.md
index a58d1d4eaa..02553361d6 100644
--- a/.github/workflows/README.md
+++ b/.github/workflows/README.md
@@ -4,6 +4,11 @@
 
 ![gh_actions.drawio.png](gh_actions.drawio.png)
 
+## PR verification
+
+To ensure a stable main branch we verify PRs once they are created/updated and again when they are accepted and enter the merge queue. Therefore each verification workflow needs to have both ``pull_request`` and ``merge_group`` set in the trigger conditions.
+Additionally all jobs for the merge queue have to be explicitly added in the [otterdog configuration](https://github.com/eclipse-openbsw/.eclipsefdn/blob/main/otterdog/eclipse-openbsw.jsonnet).
+
 ## General guidelines
 
 1. Don't waste compute time.