Follow the plugin template: acceptance checks, shared workflows, AGENTS.md

.github/workflows/compatibility.yml

@@ -1,78 +1,15 @@
+# Everything is defined once in PyMoDAQ/pymodaq_plugins_template (reusable-*.yml). The template is never released, so the ref after @ is its 5.3.x branch.
 name: Compatibility with pymodaq (latest release)
 
 on:
-  workflow_call:
-
   pull_request:
-
   push:
-    branches:
-    - '*'
+    branches: [main, master, '[0-9]*.x']
 
 concurrency:
-  # github.workflow: name of the workflow
-  # github.event.pull_request.number || github.ref: pull request number or branch name if not a pull request
   group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-  # Cancel in-progress runs when a new workflow with the same group name is triggered
   cancel-in-progress: true
-
-jobs:
-  tests:
-    continue-on-error: true
-    strategy:
-      fail-fast: false
-      matrix:
-        os: ["ubuntu-latest", "windows-latest"]
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-        qt-backend: ["pyqt5", "pyqt6", "pyside6"]
-    runs-on: ${{ matrix.os }}
-    env:
-      DISPLAY: ':99'
-      QT_DEBUG_PLUGINS: 1
-
-    steps:
-      - name: Set project name environment variable
-        run: |
-          echo "plugin_name=$(echo '${{ github.repository }}' | cut -d'/' -f2)" >> $GITHUB_ENV
 
-      - name: Checkout the repo
-        uses: actions/[email protected]
-
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/[email protected]
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install flake8 pytest pytest-cov pytest-qt pytest-xvfb pytest-xdist setuptools wheel numpy h5py pymodaq ${{ matrix.qt-backend }}
-          pip install -e .    
-
-      # Create folder and set permissions on Ubuntu
-      - name: Create local pymodaq folder setup env (Linux)
-        if: runner.os == 'Linux'
-        run: |
-          sudo apt update
-          sudo apt install -y libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-cursor0 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xfixes0 x11-utils libgl1 libegl1
-          export QT_DEBUG_PLUGINS=1
-          sudo mkdir -p /etc/.pymodaq
-          sudo chmod uo+rw /etc/.pymodaq
-      - name: Exporting debug variables (Windows)
-        if: runner.os == 'Windows'
-        run: |
-          set QT_DEBUG_PLUGINS=1
-
-      - name: Compatibility tests with ${{ matrix.os }} ${{ matrix.python-version }} ${{ matrix.qt-backend}}
-        run: |
-          pytest -vv -n 1 -k "test_compatibility"          
-
-      - name: Upload compatibility report
-        if: failure()
-        uses: actions/[email protected]
-        with:
-          name:  
-          path: 'import_report_tests_${{ env.plugin_name }}_None.txt'
-          if-no-files-found: error 
-
-
+jobs:
+  compatibility:
+    uses: PyMoDAQ/pymodaq_plugins_template/.github/workflows/[email protected]

.github/workflows/python-publish.yml

@@ -1,40 +1,11 @@
-# This workflow will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
+# Everything is defined once in PyMoDAQ/pymodaq_plugins_template (reusable-*.yml). The template is never released, so the ref after @ is its 5.3.x branch.
 name: Upload Python Package
 
 on:
   release:
     types: [created]
 
 jobs:
-  deploy:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/[email protected]
-    - name: Set up Python
-      uses: actions/[email protected]
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install hatch hatchling toml twine
-    - name: Get history and tags for SCM versioning to work
-      run: |
-        git branch
-        git fetch --prune --unshallow
-        git fetch --depth=1 origin +refs/tags/*:refs/tags/*
-        hatch version
-    - name: Build
-      run: hatch build
-    - name: Check the build
-      run: twine check dist/*
-    - name: publish
-      env:
-        HATCH_INDEX_USER: ${{ secrets.PYPI_USERNAME }}
-        HATCH_INDEX_AUTH: ${{ secrets.PYPI_PASSWORD }}
-      run: |
-        hatch publish
+  publish:
+    uses: PyMoDAQ/pymodaq_plugins_template/.github/workflows/[email protected]
+    secrets: inherit

.github/workflows/tests.yml

@@ -0,0 +1,8 @@
+# Everything is defined once in PyMoDAQ/pymodaq_plugins_template (reusable-*.yml). The template is never released, so the ref after @ is its 5.3.x branch.
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    uses: PyMoDAQ/pymodaq_plugins_template/.github/workflows/[email protected]