doc: document race happening when showing summary in comment

jamacku · Sep 25, 2024 · a2342ae · a2342ae
1 parent e8ff7a6
commit a2342ae
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -175,3 +175,7 @@ Action uses the `pull_request_status_name` as the name of the test. Also it is u
 <p align="center">
  <img src="images/summary-comment.png" width="600" alt="Summary comment example" />
 </p>
+
+> [!WARNING]
+>
+> When running multiple tests in parallel, you can encounter race conditions when updating the summary comment. We have implemented a locking mechanism to prevent this issue, but currently there is no proper way how to synchronize independent workflow jobs. Statuses are updated independently so they don't have this issue and are always up to date.
diff --git a/images/summary-comment.png b/images/summary-comment.png