Refactor GitHub Actions workflow to streamline setup and improve Python environment configuration

Author: coolbeevip

.github/actions/setup/action.yml

@@ -0,0 +1,36 @@
+name: 'setup'
+description: 'Setup python environment and install dependencies'
+inputs:
+  python-version:
+    description: 'Python version.'
+    required: true
+    default: '3.9'
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '${{ inputs.python-version }}'
+    - name: Install poetry
+      uses: abatilo/actions-poetry@v2
+    - name: Setup poetry virtual environment
+      run: |
+        poetry config virtualenvs.create true --local
+        poetry config virtualenvs.in-project true --local
+      shell: bash
+    - uses: actions/cache/restore@v3
+      id: cache-restore
+      name: Restore caches for the virtual environment based on poetry.lock
+      with:
+        path: ./.venv
+        key: venv-${{ hashFiles('poetry.lock') }}
+    - name: Install the project dependencies
+      run: poetry install --with dev,docs -E all
+      shell: bash
+    - uses: actions/cache/save@v3
+      name: Save caches based on poetry.lock 
+      if: ${{ !steps.cache-restore.outputs.cache-hit }}
+      with:
+        path: ./.venv
+        key: venv-${{ hashFiles('poetry.lock') }}

.github/workflows/pr.yml

@@ -17,56 +17,24 @@ on:
       - ".github/workflows/**"
 
 jobs:
-  setup:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check Out Repo
-        uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.9'
-          cache: 'pip'
-      - name: Install Poetry
-        run: pip install poetry ruff
-      - name: Install Dependencies
-        run: poetry install --with dev
-      - name: Cache Poetry dependencies
-        uses: actions/cache@v3
-        with:
-          path: .venv
-          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
-
   ruff:
-    needs: setup
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.9'
-      - name: Install Poetry
-        run: pip install poetry
-      - uses: actions/cache@v3
-        with:
-          path: .venv
-          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
-      - name: Run ruff
-        run: poetry run ruff check
+    - uses: actions/checkout@v4
+    - name: Set up Python environment and install dependencies
+      uses: ./.github/actions/setup
+      with:
+        python-version: "3.10"
+    - name: Ruff Check
+      run: poetry run ruff check
 
   test:
-    needs: ruff
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.9'
-      - name: Install Poetry
-        run: pip install poetry
-      - uses: actions/cache@v3
-        with:
-          path: .venv
-          key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
-      - name: Run Tests
-        run: poetry run pytest tests
+    - uses: actions/checkout@v4
+    - name: Set up Python environment and install dependencies
+      uses: ./.github/actions/setup
+      with:
+        python-version: "3.9"
+    - name: Ruff Check
+      run: poetry run pytest tests