Test pr test config

.github/workflows/call_black.yml

@@ -0,0 +1,18 @@
+# For more information see: https://black.readthedocs.io/en/stable/integrations/github_actions.html
+name: Lint
+
+on: 
+  # Allows you to run this workflow from another workflow
+  workflow_call
+
+# disable all the permission for the workflow
+permissions: {}
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: psf/black@stable
+        with:
+          jupyter: true

.github/workflows/call_build_docs.yml

@@ -0,0 +1,38 @@
+name: Documentation
+
+on:
+  # Allows you to run this workflow from another workflow
+  workflow_call:
+
+env:
+    # Force to use color
+    FORCE_COLOR: true
+    BROWSER: /usr/bin/firefox
+    DISPLAY: :99.0
+
+# disable all the permission for the workflow
+permissions: {}
+
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+            python-version: '3.12'
+      - name: Install dependencies
+        run: |
+          python -m pip install -e .
+          python -m pip install .[doc,plotting]
+      - name: Sphinx build
+        id: build-docs
+        run: |
+          sphinx-build -b html doc_conf doc/_build/html
+      - name: Upload documentation
+        if: steps.build-docs.outcome == 'success'
+        uses: actions/upload-artifact@v4
+        with:
+          name: DocHTML
+          path: doc/_build/html
+

.github/workflows/build_docs.yml → .github/workflows/call_deploy_on_main.yml

@@ -1,47 +1,17 @@
 name: Documentation
 
 on:
-  pull_request:
-  push:
-    branches: main
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
+  # Allows you to run this workflow from another workflow
+  workflow_call:
 
-env:
-    # Force to use color
-    FORCE_COLOR: true
-    BROWSER: /usr/bin/firefox
-    DISPLAY: :99.0
-
+# disable all the permission for the workflow
 permissions:
-  contents: write
+    contents: write
 
 jobs:
-  build_docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-            python-version: '3.12'
-      - name: Install dependencies
-        run: |
-          python -m pip install -e .
-          python -m pip install .[doc,plotting]
-      - name: Sphinx build
-        id: build-docs
-        run: |
-          sphinx-build -b html doc_conf doc/_build/html
-      - name: Upload documentation
-        if: steps.build-docs.outcome == 'success'
-        uses: actions/upload-artifact@v4
-        with:
-          name: DocHTML
-          path: doc/_build/html
-
   deploy_on_main:
     runs-on: ubuntu-latest
-    needs: [build_docs]
+    # add permission to write for create a commit with the updated library
     if: ${{ contains(fromJSON('["push", "workflow_dispatch", "schedule"]'), github.event_name)}}
     steps:
       - name: Download artifacts
@@ -67,4 +37,4 @@ jobs:
           branch: main
           directory: hidimstat
           github_token: ${{ secrets.GITHUB_TOKEN }}
-
+

.github/workflows/call_publish_result.yml

@@ -0,0 +1,75 @@
+name: Publish Tests
+
+on:
+  # Allows you to run this workflow from another workflow
+  workflow_call:
+
+# disable all the permission for the workflow
+permissions: {}
+
+jobs:
+
+  merge_md_test_data:
+    # for more details
+    # https://github.com/thombashi/pytest-md-report
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+    # get report from previous job 
+    - name: Get data
+      uses: actions/download-artifact@v4
+      with:
+        pattern: pytest-results-md-*-os-*
+    # add manual link to render the HTML commit on the reporter_test branch
+    # the rendering is based on the trick propose here: 
+    # https://github.com/htmlpreview/htmlpreview.github.com
+    # TODO Determine the link to the circleci  
+    - name: Update mardown
+      shell: bash
+      run: |
+        for FOLDER in *;
+        do 
+        SUFFIX=$(echo $FOLDER | sed 's/pytest-results-md-//g');
+        #LINK=""
+        #echo -e "\n [HTML tests summary]($LINK)" >> ${FOLDER}/test-results-${SUFFIX}.md
+        done
+    - name: ls
+      shell: bash
+      run: ls -Rl
+    # create a comment in the PR with the failling tests
+    # for more details: https://github.com/marocchino/sticky-pull-request-comment
+    - name: Render the report to the PR
+      uses: marocchino/sticky-pull-request-comment@v2
+      with:
+        header: test-report
+        recreate: true
+        path: ./pytest-results-md-3.13-os-macos-latest/test-results-3.13-os-macos-latest.md     #CHECK: need to be updated when new version are available
+    # create a comment in the summary with the failling tests
+    - name: Output reports to the job summary when tests fail
+      shell: bash
+      run: |
+        for folder in *;
+        do 
+          echo "<details><summary>Failed Test Report: $folder</summary>" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          cat $folder/*.md >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "</details>" >> $GITHUB_STEP_SUMMARY
+        done
+
+  merge_upload_coverage_data:
+    runs-on: ubuntu-latest
+    steps:
+    # get coverage only for 1 job 
+    - name: Get data
+      uses: actions/download-artifact@v4
+      with:
+        pattern: cov-results-3.13-os-macos-latest  #CHECK: need to be updated when new version are available
+    # Upload coverage report for Codecov
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        verbose: true
+        files: cov-results-3.13-os-macos-latest/cov-3.13-os-macos-latest.xml    #CHECK: need to be updated when new version are available

.github/workflows/call_test_package.yml

@@ -0,0 +1,84 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Tests
+
+on:
+  # Allows you to run this workflow from another workflow
+  workflow_call:
+
+# disable all the permission for the workflow
+permissions: {}
+
+jobs:
+  build-test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true  # if on job fail all the other jobs are cancelled
+      matrix:
+        python-version: ["3.13", "3.12"] #CHECK: not forget to add new version of python
+        os: [macos-latest, ubuntu-latest, windows-latest]
+
+    # name for files
+    env:
+      REPORT_NAME: ${{ matrix.python-version }}-os-${{ matrix.os }}
+
+    steps:
+    # Checkout to the branch for getting the right code
+    - uses: actions/checkout@v4
+    # Install python
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    # Install dependency for running the tests
+    - name: Install the dependance
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .[test]
+    # Run the tests with coverage and report add this end
+    # option for the coverage: --cov=. --cov-report=xml:... 
+    # option for mardown report: --md-report --md-report-output= ...
+    # option for html report: --self-contained-html --html=report-...
+    # option for duration report: --pytest-durations= number of second --pytest-resultlog=log-...
+    # inline command for being compatible on linux and windows
+    - name: Generate coverage report
+      run: |
+        python -m pytest --cov=. --cov-report=xml:cov/cov-${{env.REPORT_NAME}}.xml --md-report --md-report-output=test-results-${{env.REPORT_NAME}}.md --self-contained-html --html=report-${{env.REPORT_NAME}}.html --pytest-durations=10 --pytest-resultlog=log-${{env.REPORT_NAME}}.txt
+
+    - name: generate an empty mardown report if succeed
+      if: ${{ success()}}
+      shell: bash
+      run: |
+        echo "SUCCESS" >> test-results-${{env.REPORT_NAME}}.md 
+
+    # publish different reports (HTML, Mardown, Coverage)
+    - name: Upload HTML test result
+      if: ${{ always() && !cancelled()}}
+      id: html_report
+      uses: actions/upload-artifact@v4
+      with:
+        name: pytest-results-html-${{env.REPORT_NAME}}
+        path: report-${{env.REPORT_NAME}}.html
+        if-no-files-found: error
+    - name: Upload md test result 
+      if: ${{ always() && !cancelled()}}
+      uses: actions/upload-artifact@v4
+      with:
+        name: pytest-results-md-${{env.REPORT_NAME}}
+        path: test-results-${{env.REPORT_NAME}}.md 
+        if-no-files-found: error
+    - name: Upload duration test result
+      if: ${{ always() && !cancelled()}}
+      uses: actions/upload-artifact@v4
+      with:
+        name: pytest-results-log-${{env.REPORT_NAME}}
+        path: log-${{env.REPORT_NAME}}.txt
+        if-no-files-found: error
+    - name: Upload coverage data
+      if: ${{ always() && !cancelled()}}
+      uses: actions/upload-artifact@v4
+      with:
+        name: cov-results-${{env.REPORT_NAME}}
+        path: cov/cov-${{env.REPORT_NAME}}.xml
+        if-no-files-found: error

.github/workflows/main_workflow.yml

@@ -0,0 +1,59 @@
+# Management of the action do made during a pull request
+
+name: 'Main_workflow'
+on:
+  pull_request:
+    branches: main
+  # allows to push on branches
+  push:
+    branches: main
+
+# disable all the permission for the workflow
+permissions: {}
+
+# Cancel existing runs 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  linter:
+    name: Linter
+    uses: ./.github/workflows/call_black.yml
+
+  tests:
+    name: tests
+    needs: [linter]
+    uses: ./.github/workflows/call_test_package.yml
+
+  tests_publish:
+    name: tests_publish
+    needs: [tests]
+    if: ${{ needs.tests.result != 'cancelled' }}
+    permissions:
+      pull-requests: write
+    uses: ./.github/workflows/call_publish_result.yml
+
+  make_documentation:
+    name: Make_documentation
+    needs: [linter, tests]
+    uses: ./.github/workflows/call_build_docs.yml
+
+  deploy_documentation:
+    name: 
+    needs: [make_documentation]
+    permissions:
+      contents: write
+    uses: ./.github/workflows/call_deploy_on_main.yml
+
+  # debugger:
+  #   needs: linter 
+  #   env: 
+  #     STATE_LINTER: ${{ needs.linter.result }}
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: print output
+  #       run: 
+  #         echo "Linter "$STATE_LINTER
+  #   if: ${{ always() }} 
+