feat: add flaky tests template (#314)

* feat: add flaky tests template

* 🎨 Cleanup reusable workflows

* 📝 Add workflow documentation

* 📝 Add better documentation

* 📝 Fix workflow name typo

* 🎨 Using explicit version

* 🎨 Add marvin to cla

---------

Co-authored-by: Falk Puschner <falk.puschner@staffbase.com>

Author: MarvinZeising

.github/workflows/cla.yml

@@ -20,4 +20,4 @@ jobs:
           path-to-signatures: 'signatures/version1/cla.json'
           path-to-document: 'https://github.com/Staffbase/gha-workflows/blob/main/CLA.md'
           branch: 'signatures'
-          allowlist: 0x46616c6b,axdotl,flaxel,kaitimmer,timdittler,*bot*
+          allowlist: 0x46616c6b,axdotl,flaxel,kaitimmer,timdittler,MarvinZeising,*bot*

.github/workflows/template_flaky_tests.yml

@@ -0,0 +1,43 @@
+name: Find flaky tests
+
+on:
+  workflow_call:
+    inputs:
+      slack-channel-id:
+        required: true
+        type: string
+      slack-channel-name:
+        required: true
+        type: string
+      repository:
+        required: false
+        type: string
+        default: ${{ github.event.repository.full_name }}
+      branch:
+        required: false
+        type: string
+        default: 'main'
+      prefix:
+        required: true
+        type: string
+    secrets:
+      slack-incoming-webhooks-url:
+        required: true
+      token:
+        required: true
+
+jobs:
+  flaky-tests:
+    name: Flaky-Tests
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Find flaky tests
+        uses: Staffbase/github-action-find-flaky-tests@v0.1.0
+        with:
+          slack-channel-id: ${{ inputs.slack-channel-id }}
+          slack-channel-name: ${{ inputs.slack-channel-name }}
+          repository: ${{ inputs.repository }}
+          branch: ${{ inputs.branch }}
+          prefix: ${{ inputs.prefix }}
+          slack-incoming-webhooks-url: ${{ secrets.slack-incoming-webhooks-url }}
+          token: ${{ secrets.token }}

README.md

@@ -167,6 +167,42 @@ jobs:
 
 </details>
 
+### Find Flaky Tests
+
+<details>
+<summary>The action can be used to find flaky tests.</summary>
+
+```yml
+name: Find flaky tests
+
+on:
+  # At 05:00 on Monday.
+  schedule:
+    - cron: '0 5 * * 1'
+
+jobs:
+  flaky-tests:
+    uses: Staffbase/gha-workflows/.github/workflows/template_flaky_tests.yml@v7.4.0
+    with:
+      # identifier for the slack channel
+      slack-channel-id: 45678787976
+      # name of the slack channel
+      slack-channel-name: '#flaky-tests'
+      # optional: name of the repository where it should check, default: current repository
+      repository: 'Staffbase/test-flaky'
+      # optional: name of the branch where it should check, default: main
+      branch: 'master'
+      # prefix of the test run which should be filtered out
+      prefix: 'test-'
+    secrets:
+      # URL of the Slack incoming webhooks
+      slack-incoming-webhooks-url: ${{ secrets.SLACK_INCOMING_WEBHOOKS_URL }}
+      # GitHub token
+      token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+</details>
+
 ### GitOps
 
 <details>