Merge pull request #207 from antoinejeannot/fix-badges

remove badges generation

.github/workflows/docs.yml

@@ -3,14 +3,14 @@ name: docs
 on:
   workflow_run:
     workflows: ["tests"]
-    types:
-      - completed
+    branches: [main]
+    types: [completed]
 
 jobs:
   docs:
     name: Deploy docs
     runs-on: ubuntu-latest
-    if: ${{github.ref == 'refs/heads/main'}}
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3

.github/workflows/tests.yml

@@ -35,15 +35,6 @@ jobs:
           OS_NAME: "${{ matrix.os }}"
           PYTHON_VERSION: "${{ matrix.python-version }}"
 
-      - name: Add & Commit Badges
-        if: ${{matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8' && github.ref == 'refs/heads/main'}}
-        run: |
-          git config user.name github-actions
-          git config user.email [email protected]
-          git add docs/badges
-          git diff-index --quiet HEAD || git commit -m "generate badges"
-          git push
-
       - name: 'Upload coverage report'
         if: ${{matrix.os == 'ubuntu-latest' && matrix.python-version == '3.8' && github.ref == 'refs/heads/main'}}
         uses: actions/upload-artifact@v3

README.md

@@ -11,14 +11,13 @@
 ---
 
 <p align="center">
-  <a href="https://github.com/cornerstone-ondemand/modelkit/actions?query=branch%3Amain+"><img src="https://img.shields.io/github/workflow/status/cornerstone-ondemand/modelkit/CI/main" /></a>
-  <a href="https://github.com/cornerstone-ondemand/modelkit/actions/workflows/main.yml?query=branch%3Amain+"><img src="docs/badges/tests.svg" /></a>
-  <a href="https://cornerstone-ondemand.github.io/modelkit/coverage/index.html"><img src="docs/badges/coverage.svg" /></a>
+  <a href="https://github.com/Cornerstone-OnDemand/modelkit/actions/workflows/tests.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/cornerstone-ondemand/modelkit/tests.yml?branch=main" /></a>
   <a href="https://pypi.org/project/modelkit/"><img src="https://img.shields.io/pypi/v/modelkit" /></a>
   <a href="https://pypi.org/project/modelkit/"><img src="https://img.shields.io/pypi/pyversions/modelkit" /></a>
   <a href="https://cornerstone-ondemand.github.io/modelkit/index.html"><img src="https://img.shields.io/badge/docs-latest-blue" /></a>
   <a href="https://github.com/cornerstone-ondemand/modelkit/blob/main/LICENSE"><img src="https://img.shields.io/github/license/cornerstone-ondemand/modelkit" /></a>
   <a href="https://pepy.tech/project/modelkit"><img src="https://pepy.tech/badge/modelkit" /></a>
+  <a href="https://github.com/Cornerstone-OnDemand/modelkit/graphs/contributors"><img src="https://img.shields.io/github/contributors/Cornerstone-OnDemand/modelkit" /></a>
 </p>
 
 `modelkit` is a minimalist yet powerful MLOps library for Python, built for people who want to deploy ML models to production.

docs/index.md

@@ -7,17 +7,17 @@
 <p align="center">
   <em>Python framework for production ML systems.</em>
 </p>
-    
+
 ---
 
 <p align="center">
-  <a href="https://github.com/Cornerstone-OnDemand/modelkit/actions?query=branch%3Amain+"><img src="https://img.shields.io/github/workflow/status/Cornerstone-OnDemand/modelkit/CI/main" /></a>
-  <a href="https://github.com/Cornerstone-OnDemand/modelkit/actions/workflows/main.yml?query=branch%3Amain+"><img src="badges/tests.svg" /></a>
-  <a href="https://Cornerstone-OnDemand.github.io/modelkit/coverage/index.html"><img src="badges/coverage.svg" /></a>
+  <a href="https://github.com/Cornerstone-OnDemand/modelkit/actions/workflows/tests.yml?query=branch%3Amain"><img src="https://img.shields.io/github/actions/workflow/status/cornerstone-ondemand/modelkit/tests.yml?branch=main" /></a>
   <a href="https://pypi.org/project/modelkit/"><img src="https://img.shields.io/pypi/v/modelkit" /></a>
   <a href="https://pypi.org/project/modelkit/"><img src="https://img.shields.io/pypi/pyversions/modelkit" /></a>
-  <a href="https://Cornerstone-OnDemand.github.io/modelkit/index.html"><img src="https://img.shields.io/badge/docs-latest-blue" /></a>
-  <a href="https://github.com/Cornerstone-OnDemand/modelkit/blob/main/LICENSE"><img src="https://img.shields.io/github/license/Cornerstone-OnDemand/modelkit" /></a>
+  <a href="https://cornerstone-ondemand.github.io/modelkit/index.html"><img src="https://img.shields.io/badge/docs-latest-blue" /></a>
+  <a href="https://github.com/cornerstone-ondemand/modelkit/blob/main/LICENSE"><img src="https://img.shields.io/github/license/cornerstone-ondemand/modelkit" /></a>
+  <a href="https://pepy.tech/project/modelkit"><img src="https://pepy.tech/badge/modelkit" /></a>
+  <a href="https://github.com/Cornerstone-OnDemand/modelkit/graphs/contributors"><img src="https://img.shields.io/github/contributors/Cornerstone-OnDemand/modelkit" /></a>
 </p>
 
 

noxfile.py

@@ -20,15 +20,3 @@ def coverage(session):
     session.run("coverage", "report", "-m")
     session.run("coverage", "xml")
     session.run("coverage", "html", "-d", "docs/coverage")
-
-    # Generate README badges using genbadge, junit.xml and coverage.xml
-    session.install("genbadge[coverage,tests]")
-    session.run(
-        "genbadge",
-        "coverage",
-        "-i",
-        "coverage.xml",
-        "-o",
-        "docs/badges/coverage.svg",
-    )
-    session.run("genbadge", "tests", "-i", "junit.xml", "-o", "docs/badges/tests.svg")