Enhanced GitHub Actions Workflows and Metrics Integration

.github/CODEOWNERS

@@ -0,0 +1,16 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# they will be requested for review when someone opens a pull request.
+*       @thaddiusatme
+
+# Feed processor core
+/feed_processor/       @thaddiusatme
+
+# Tests
+/tests/               @thaddiusatme
+
+# CI/CD
+/.github/workflows/   @thaddiusatme
+
+# Documentation
+/docs/                @thaddiusatme

.github/workflows/ci.yml

@@ -0,0 +1,102 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  PYTHON_VERSION: "3.12"
+
+permissions:
+  contents: write
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        ref: ${{ github.head_ref }}
+        fetch-depth: 0
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Set up Python ${{ env.PYTHON_VERSION }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build wheel setuptools
+
+    - name: Install package and dev dependencies
+      run: |
+        pip install -e ".[dev]"
+        pip install black isort flake8 mypy
+
+    - name: Format with black
+      run: |
+        if ! black --check feed_processor tests; then
+          black feed_processor tests
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+          git add .
+          git commit -m "style: Format code with black"
+          git push origin HEAD:${{ github.head_ref }}
+        fi
+
+    - name: Sort imports with isort
+      run: |
+        if ! isort --check-only feed_processor tests; then
+          isort feed_processor tests
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git config --global user.name "github-actions[bot]"
+          git add .
+          git commit -m "style: Sort imports with isort"
+          git push origin HEAD:${{ github.head_ref }}
+        fi
+
+    - name: Lint with flake8
+      run: flake8 feed_processor tests
+
+    - name: Type check with mypy
+      run: mypy feed_processor
+
+  test:
+    runs-on: ubuntu-latest
+    needs: lint
+    services:
+      prometheus:
+        image: prom/prometheus:latest
+        ports:
+          - 9090:9090
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ env.PYTHON_VERSION }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build wheel setuptools
+
+    - name: Install package
+      run: |
+        pip install -e ".[test]"
+
+    - name: Run tests
+      run: |
+        pytest tests/ --cov=feed_processor --cov-report=xml
+
+    - name: Upload coverage
+      uses: codecov/codecov-action@v3
+      with:
+        file: ./coverage.xml
+        fail_ci_if_error: true

.github/workflows/release.yml

@@ -10,44 +10,46 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
 
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.8'
+        python-version: '3.12'
 
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install build twine
+        pip install build twine mkdocs mkdocs-material
+        pip install -r requirements.txt
 
     - name: Build package
       run: python -m build
 
+    - name: Build documentation
+      run: |
+        mkdocs build
+
     - name: Create Release
       id: create_release
-      uses: actions/create-release@v1
+      uses: softprops/action-gh-release@v1
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
-        tag_name: ${{ github.ref }}
-        release_name: Release ${{ github.ref }}
-        body_path: CHANGELOG.md
+        files: |
+          dist/*
+          site/*
+        body_path: changelog.md
         draft: false
         prerelease: false
 
-    - name: Upload Release Asset
-      uses: actions/upload-release-asset@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Deploy documentation
+      uses: peaceiris/actions-gh-pages@v3
       with:
-        upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: ./dist/*.whl
-        asset_name: feed_processor.whl
-        asset_content_type: application/x-wheel+zip
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./site
 
     - name: Publish to PyPI
       if: startsWith(github.ref, 'refs/tags/')

.github/workflows/test.yml

@@ -2,36 +2,42 @@ name: Test
 
 on:
   push:
-    branches: [ main ]
+    branches-ignore: [ main ]
   pull_request:
     branches: [ main ]
 
+env:
+  PYTHON_VERSION: "3.12"
+
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.12']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: Set up Python ${{ env.PYTHON_VERSION }}
       uses: actions/setup-python@v4
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: ${{ env.PYTHON_VERSION }}
 
-    - name: Install dependencies
+    - name: Install build dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -r requirements-dev.txt
+        pip install build wheel setuptools
+
+    - name: Install package
+      run: |
+        pip install -e ".[test]"
 
-    - name: Run tests with pytest
+    - name: Run tests
       run: |
         pytest tests/ --cov=feed_processor --cov-report=xml
 
-    - name: Upload coverage to Codecov
+    - name: Upload coverage
       uses: codecov/codecov-action@v3
       with:
         file: ./coverage.xml