🚀 Simplify environments in actions and doc building (unique dev env reference) (#73)

Co-authored-by: Fabien Casenave <fabien.casenave@safrangroup.com>

Author: casenave

.github/workflows/conda_envs/python3.11.yml

@@ -26,7 +26,7 @@ jobs:
 
       - name: Create environment
         run: |
-          mamba env create -f docs/requirements.yml
+          mamba env create -f environment.yml
           mamba run -n plaid pip install -e .
 
       - name: Compile documentation

.github/workflows/conda_envs/python3.12.yml

@@ -5,59 +5,8 @@ on:
     types: [created]
 
 jobs:
-  test:
-    name: test
-    permissions:
-      contents: read
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.11, 3.12]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-
-      - name: Set up Conda with Mamba
-        uses: conda-incubator/setup-miniconda@v2
-        with:
-          use-mamba: true
-          auto-activate-base: false
-          miniforge-variant: Miniforge3
-
-      - name: Create environment
-        run: |
-          mamba env create -f .github/workflows/conda_envs/python${{ matrix.python-version }}.yml
-          mamba run -n plaid_python${{ matrix.python-version }} pip install -e .
-
-      - name: Run tests on Unix
-        if: runner.os != 'Windows'
-        run: |
-          mamba run -n plaid_python${{ matrix.python-version }} pytest tests
-
-      - name: Run tests on Windows
-        if: runner.os == 'Windows'
-        shell: powershell
-        run: |
-          mamba run -n plaid_python${{ matrix.python-version }} pytest tests
-
-      - name: Run examples on Unix
-        if: runner.os != 'Windows'
-        run: |
-          cd examples
-          mamba run -n plaid_python${{ matrix.python-version }} bash run_examples.sh
-
-      - name: Run examples on Windows
-        if: runner.os == 'Windows'
-        shell: powershell
-        run: |
-          cd examples
-          mamba run -n plaid_python${{ matrix.python-version }} run_examples.bat
-
   build:
-    name: Build wheels for multiple Python versions
-    needs: test
+    name: Build wheels
     permissions:
       contents: read
     runs-on: ubuntu-latest
@@ -73,7 +22,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.12"
+          python-version: "3.11"
 
       - name: Install build tools
         run: |
@@ -96,7 +45,7 @@ jobs:
 
       - uses: actions/upload-artifact@v4
         with:
-          name: wheels-3.12
+          name: wheels-3.11
           path: dist/*.whl
 
   publish:

.github/workflows/doc.yml

@@ -22,41 +22,61 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Set up Conda with Mamba
+      - name: Set up Conda
         uses: conda-incubator/setup-miniconda@v2
         with:
-          use-mamba: true
+          use-mamba: false
+          python-version: 3.11
           auto-activate-base: false
           miniforge-variant: Miniforge3
 
+      - name: Modify environment.yml with matrix Python version (Linux/macOS)
+        if: runner.os != 'Windows'
+        run: |
+          python_version=${{ matrix.python-version }}
+          sed -i.bak "s/^  - python=.*/  - python=${python_version}/" environment.yml
+
+      - name: Modify environment.yml with matrix Python version (Windows)
+        if: runner.os == 'Windows'
+        shell: powershell
+        run: |
+          $python_version = '${{ matrix.python-version }}'
+          $file = 'environment.yml'
+          (Get-Content $file) -replace '^\s+- python=.*', "  - python=$python_version" | Set-Content $file
+
       - name: Create environment
         run: |
-          mamba env create -f .github/workflows/conda_envs/python${{ matrix.python-version }}.yml
-          mamba run -n plaid_python${{ matrix.python-version }} pip install -e .
+          conda env create -n plaid-dev -f environment.yml
+          conda run -n plaid-dev pip install -e .
 
-      - name: Run tests on Unix
-        if: runner.os != 'Windows'
+      - name: Run tests on Linux
+        if: runner.os == 'Linux'
         run: |
-          mamba run -n plaid_python${{ matrix.python-version }} pytest tests --cov=src --cov-report=xml --cov-report=term
+          conda run -n plaid-dev pytest tests --cov=src --cov-report=xml --cov-report=term
+
+      - name: Run tests on macOS
+        if: runner.os == 'macOS'
+        run: |
+          conda run -n plaid-dev pytest tests
 
       - name: Run tests on Windows
         if: runner.os == 'Windows'
         shell: powershell
         run: |
-          mamba run -n plaid_python${{ matrix.python-version }} pytest tests
+          conda run -n plaid-dev pytest tests
 
       - name: Run examples on Unix
         if: runner.os != 'Windows'
         run: |
           cd examples
-          mamba run -n plaid_python${{ matrix.python-version }} bash run_examples.sh
+          conda run -n plaid-dev bash run_examples.sh
 
       - name: Run examples on Windows
         if: runner.os == 'Windows'
         shell: powershell
         run: |
           cd examples
-          mamba run -n plaid_python${{ matrix.python-version }} run_examples.bat
+          conda run -n plaid-dev run_examples.bat
 
       - name: Upload coverage to Codecov (Linux only)
         if: runner.os == 'Linux'
@@ -65,15 +85,4 @@ jobs:
           files: coverage.xml
           token: ${{ secrets.CODECOV_TOKEN }}
           name: python-${{ matrix.python-version }}
-          verbose: true
-
-    #   - name: Set up Miniconda
-    #     uses: conda-incubator/setup-miniconda@v2
-    #     with:
-    #       miniforge-variant: Miniforge3
-    #       miniforge-version: latest
-    #       use-mamba: true
-    #       auto-activate-base: false
-    #       auto-update-conda: true
-    #       activate-environment: plaid_python${{ matrix.python-version }}
-    #       environment-file: .github/workflows/conda_envs/python${{ matrix.python-version }}.yml
+          verbose: true

.github/workflows/publish-pypi.yml

@@ -8,10 +8,10 @@ sphinx:
   configuration: docs/conf.py
 
 conda:
-  environment: docs/requirements.yml
+  environment: environment.yml
 
 build:
-  os: "ubuntu-20.04"
+  os: "ubuntu-22.04"
   tools:
     python: "mambaforge-4.10"
 

.github/workflows/testing.yml

@@ -73,7 +73,7 @@ conda env create -f environment.yml
 Then, to install the library:
 
 ```bash
-pip install -e .[dev]
+pip install -e .
 ```
 
 **Note**

.readthedocs.yml

@@ -44,7 +44,7 @@ conda env create -f environment.yml
 Then, to install the library:
 
 ```bash
-pip install -e .[dev]
+pip install -e .
 ```
 
 **Note**

README.md

@@ -3,7 +3,7 @@ channels:
   - conda-forge
   - nodefaults
 dependencies:
-  - python=3.11
+  - python=3.12
 ##### RUN #####
 #---# base
   - tqdm