Merge pull request #732 from OpenVoiceOS/release-2.1.0a1

Release 2.1.0a1

Author: JarbasAl

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+relative_files = true

.github/dependabot.yml

@@ -8,4 +8,4 @@ updates:
   - package-ecosystem: "pip" # See documentation for possible values
     directory: "/requirements" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "daily"

.github/workflows/coverage.yml

@@ -1,59 +1,36 @@
-name: Run CodeCov
+# .github/workflows/coverage.yml
+name: Post coverage comment
+
 on:
-  push:
-    branches:
-      - dev
-  workflow_dispatch:
+  workflow_run:
+    workflows: ["Run Tests"]
+    types:
+      - completed
 
 jobs:
-  run:
+  test:
+    name: Run tests & display coverage
     runs-on: ubuntu-latest
-    env:
-      PYTHON: "3.11"
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
+      # Gives the action the necessary permissions for looking up the
+      # workflow that launched this workflow, and download the related
+      # artifact that contains the comment to be published
+      actions: read
     steps:
-    - uses: actions/checkout@master
-    - name: Setup Python
-      uses: actions/setup-python@master
-      with:
-        python-version: "3.11"
-    - name: Install System Dependencies
-      run: |
-        sudo apt-get update
-        sudo apt install python3-dev libssl-dev libfann-dev portaudio19-dev libpulse-dev
-        python -m pip install build wheel
-    - name: Install test dependencies
-      run: |
-          pip install -r requirements/tests.txt
-          pip install ./test/integrationtests/common_query/ovos_tskill_fakewiki
-          pip install ./test/end2end/skill-ovos-hello-world
-          pip install ./test/end2end/skill-ovos-fallback-unknown
-          pip install ./test/end2end/skill-ovos-slow-fallback
-          pip install ./test/end2end/skill-converse_test
-          pip install ./test/end2end/skill-ovos-schedule
-          pip install ./test/end2end/skill-new-stop
-          pip install ./test/end2end/skill-old-stop
-          pip install ./test/end2end/skill-fake-fm
-          pip install ./test/end2end/skill-ovos-fakewiki
-          pip install ./test/end2end/metadata-test-plugin
-    - name: Install core repo
-      run: |
-        pip install -e .[mycroft,deprecated,plugins]
-    - name: Generate coverage report
-      run: |
-        pytest --cov=ovos_core --cov-report xml test/unittests
-        pytest --cov-append --cov=ovos_core --cov-report xml test/end2end
-    - name: Generate coverage report with padatious
-      run: |
-        sudo apt install libfann-dev
-        pip install .[lgpl]
-        pytest --cov-append --cov=ovos_core --cov-report xml test/unittests/skills
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
-        directory: ./coverage/reports/
-        fail_ci_if_error: true
-        files: ./coverage.xml,!./cache
-        flags: unittests
-        name: codecov-umbrella
-        verbose: true
+      # DO NOT run actions/checkout here, for security reasons
+      # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+      - name: Post comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}
+          # Update those if you changed the default values:
+          # COMMENT_ARTIFACT_NAME: python-coverage-comment-action
+          # COMMENT_FILENAME: python-coverage-comment-action.txt

.github/workflows/end2end_tests.yml

@@ -0,0 +1,46 @@
+name: Publish Coverage to gh-pages
+
+on:
+  push:
+    branches:
+      - dev
+  workflow_dispatch:
+
+permissions:
+  contents: write  # Required to push to gh-pages
+
+jobs:
+  test-and-publish-coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt install python3-dev swig libssl-dev portaudio19-dev libpulse-dev libfann-dev
+          python -m pip install build wheel uv
+
+      - name: Install core repo
+        run: |
+          uv pip install --system -e .[mycroft,plugins,skills-essential,lgpl,test]
+
+      - name: Run tests and collect coverage
+        run: |
+          coverage run -m pytest test/
+          coverage html
+          rm ./htmlcov/.gitignore
+
+      - name: Deploy coverage report to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./htmlcov
+          publish_branch: gh-pages

.github/workflows/gh_pages_coverage.yml

@@ -1,78 +1,73 @@
-name: Run UnitTests
+name: Run Tests
 on:
   pull_request:
     branches:
       - dev
     paths-ignore:
       - 'ovos_core/version.py'
-      - 'examples/**'
       - '.github/**'
       - '.gitignore'
       - 'LICENSE'
       - 'CHANGELOG.md'
       - 'MANIFEST.in'
-      - 'readme.md'
+      - 'README.md'
       - 'scripts/**'
   push:
     branches:
-      - master
+      - dev
     paths-ignore:
       - 'ovos_core/version.py'
       - 'requirements/**'
-      - 'examples/**'
       - '.github/**'
       - '.gitignore'
       - 'LICENSE'
       - 'CHANGELOG.md'
       - 'MANIFEST.in'
-      - 'readme.md'
+      - 'README.md'
       - 'scripts/**'
   workflow_dispatch:
 
 jobs:
   unit_tests:
-    strategy:
-      max-parallel: 3
-      matrix:
-        python-version: ["3.11"]
     runs-on: ubuntu-latest
+    permissions:
+      # Gives the action the necessary permissions for publishing new
+      # comments in pull requests.
+      pull-requests: write
+      # Gives the action the necessary permissions for pushing data to the
+      # python-coverage-comment-action branch, and for editing existing
+      # comments (to avoid publishing multiple comments in the same PR)
+      contents: write
     timeout-minutes: 35
     steps:
       - uses: actions/checkout@v4
-      - name: Set up python ${{ matrix.python-version }}
+      - name: Set up python
         uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: "3.11"
       - name: Install System Dependencies
         run: |
           sudo apt-get update
-          sudo apt install python3-dev swig libssl-dev portaudio19-dev libpulse-dev
+          sudo apt install python3-dev swig libssl-dev portaudio19-dev libpulse-dev libfann-dev
           python -m pip install build wheel uv
-      - name: Install test dependencies
-        run: |
-          uv pip install --system -r requirements/tests.txt
       - name: Install core repo
         run: |
-          uv pip install --system -e .[mycroft,plugins]
-      - name: Run unittests
-        run: |
-          pytest --cov=ovos_core --cov-report xml test/unittests
-      - name: Install padatious
-        run: |
-          sudo apt install libfann-dev
-          uv pip install --system .[lgpl]
-      - name: Run unittests with padatious
+          uv pip install --system -e .[mycroft,plugins,skills-essential,lgpl,test]
+      - name: Run tests
         run: |
-          pytest --cov-append --cov=ovos_core --cov-report xml test/unittests
-      - name: Upload coverage
-        env:
-          CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
-        uses: codecov/codecov-action@v3
+          pytest --cov=ovos_core --cov-report xml test/
+
+      - name: Coverage comment
+        id: coverage_comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Store Pull Request comment to be posted
+        uses: actions/upload-artifact@v4
+        if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          directory: ./coverage/reports/
-          fail_ci_if_error: true
-          files: ./coverage.xml,!./cache
-          flags: unittests
-          name: codecov-unittests
-          verbose: true
+          # If you use a different name, update COMMENT_ARTIFACT_NAME accordingly
+          name: python-coverage-comment-action
+          # If you use a different name, update COMMENT_FILENAME accordingly
+          path: python-coverage-comment-action.txt