From 91965f02a019245f345a5790b7adfbe1578db020 Mon Sep 17 00:00:00 2001
From: rpartzsch <rasmus.partzsch@hotmail.com>
Date: Wed, 29 Jan 2025 13:56:55 +0100
Subject: [PATCH] GIT: added badges for documentation, tests and pre-commit

---
 .github/workflows/pre_commit.yml               | 14 ++++++++++++++
 .github/workflows/{workflows.yml => tests.yml} | 11 ++---------
 README.md                                      |  4 +++-
 3 files changed, 19 insertions(+), 10 deletions(-)
 create mode 100644 .github/workflows/pre_commit.yml
 rename .github/workflows/{workflows.yml => tests.yml} (63%)

diff --git a/.github/workflows/pre_commit.yml b/.github/workflows/pre_commit.yml
new file mode 100644
index 0000000..cbb7a50
--- /dev/null
+++ b/.github/workflows/pre_commit.yml
@@ -0,0 +1,14 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main, development]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+    - uses: pre-commit/action@v3.0.1
diff --git a/.github/workflows/workflows.yml b/.github/workflows/tests.yml
similarity index 63%
rename from .github/workflows/workflows.yml
rename to .github/workflows/tests.yml
index 4934214..54940d9 100644
--- a/.github/workflows/workflows.yml
+++ b/.github/workflows/tests.yml
@@ -1,4 +1,4 @@
-name: standard tests
+name: tests
 
 on:
   pull_request:
@@ -6,13 +6,6 @@ on:
     branches: [main, development]
 
 jobs:
-  pre-commit:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-    - uses: pre-commit/action@v3.0.1
-
   tests:
     runs-on: ubuntu-latest
     steps:
@@ -25,4 +18,4 @@ jobs:
 
       - name: Test with pytest
         run: |
-          pytest
+          pytest -sv
diff --git a/README.md b/README.md
index 902946f..986e37e 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # AIDA-TLU
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![tests](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/tests.yml/badge.svg)](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/tests.yml)
+[![pre-commit](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/pre-commit.yml/badge.svg)](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/pre-commit.yml)
+[![documentation](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/documentation.yml/badge.svg)](https://github.com/SiLab-Bonn/aidatlu/actions/workflows/documentation.yml)
 
 Repository for controlling the AIDA-2020 Trigger Logic Unit (TLU) with Python using uHAL bindings from [IPbus](https://ipbus.web.cern.ch/).
 The Python control software is based on [EUDAQ2](https://github.com/eudaq/eudaq/tree/master/user/tlu).