Chore: send coverage data to codacy and put badge on readme (#856)

* chore: send coverage to codacy service

Signed-off-by: Hiroshi Miura <[email protected]>

* docs: add codacy badge

Signed-off-by: Hiroshi Miura <[email protected]>

* chore: track jar file in LFS

Signed-off-by: Hiroshi Miura <[email protected]>

* chore: add codacy utility in ci/ folder

Signed-off-by: Hiroshi Miura <[email protected]>

* chore: use bundled ci/codacy-coverage-reporter-assembly.jar

Signed-off-by: Hiroshi Miura <[email protected]>

* chore: ci: checkout with lfs support

Signed-off-by: Hiroshi Miura <[email protected]>

---------

Signed-off-by: Hiroshi Miura <[email protected]>

Author: miurahr

.gitattributes

@@ -1 +1,26 @@
 .git_archival.txt  export-subst
+
+ # Archives
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.br filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+
+# Documents
+*.pdf filter=lfs diff=lfs merge=lfs -text
+
+# Images
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.ico filter=lfs diff=lfs merge=lfs -text
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.psd filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+
+# Fonts
+*.woff2 filter=lfs diff=lfs merge=lfs -text
+
+# Other
+*.exe filter=lfs diff=lfs merge=lfs -text
+*.jar filter=lfs diff=lfs merge=lfs -text

.github/workflows/check.yml

@@ -20,6 +20,7 @@ jobs:
       with:
         fetch-depth: 20
         fetch-tags: true
+        lfs: true
     - name: Set up Python 3.12
       uses: actions/setup-python@v5
       with:
@@ -29,10 +30,21 @@ jobs:
         pip install -U pip
         pip install tox tox-gh-actions coveralls coverage[toml]
     - name: Check
-      run: tox
+      run: |
+        tox
+        coverage xml -o cobertura.xml
       env:
         PYTEST_ADDOPTS: --cov-config=pyproject.toml --cov --cov-append --verbose
     - name: Upload Coverage
       run: coveralls --service=github
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - uses: actions/setup-java@v4
+      with:
+        distribution: 'temurin'
+        java-version: '21'
+    - name: Send coverage to codacy
+      run: |
+        java -jar ci/codacy-coverage-reporter-assembly.jar report -l Python -t ${PROJECT_TOKEN} -r cobertura.xml
+      env:
+        PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}

README.rst

@@ -4,6 +4,7 @@ Another Qt installer(aqt)
 - Release: |pypi|
 - Documentation: |docs|
 - Test status: |gha| and Coverage: |coveralls|
+- Code Quality: |codacy|
 - Project maturity |Package health|
 
 .. |pypi| image:: https://badge.fury.io/py/aqtinstall.svg
@@ -17,7 +18,8 @@ Another Qt installer(aqt)
 .. |Package health| image:: https://snyk.io/advisor/python/aqtinstall/badge.svg
   :target: https://snyk.io/advisor/python/aqtinstall
   :alt: aqtinstall
-
+.. |codacy| image:: https://app.codacy.com/project/badge/Grade/188accbe7f8f406abf61b888773bf5e3
+  :target: https://app.codacy.com/gh/miurahr/aqtinstall/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
 
 
 This is a utility alternative to the official graphical Qt installer, for using in CI environment

ci/codacy-coverage-reporter-assembly.jar

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4a9fdfe92f450cebf08d4309f0df9c89389041ff9cd6561a396dcd23787217f0
+size 18987294