PYSCAN-32 Setup basic CI (run black, tests and generate coverage) for PRs

Author: guillaume-dequenne

.github/workflows/build-pr.yml

@@ -0,0 +1,40 @@
+name: build-pr
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: |
+          3.8
+          3.9
+          3.10
+          3.11
+          3.12
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install hatch
+    - name: Check tests and generate coverage
+      run: |
+        hatch run test:cov_xml
+    - name: Check formatting
+      run: |
+        hatch run tool:format
+#    - name: SonarCloud Scan
+#      uses: SonarSource/sonarcloud-github-action@master
+#      env:
+#        SONAR_TOKEN: FIXME PYSCAN-33: Enable SonarCloud analysis

pyproject.toml

@@ -13,7 +13,7 @@ authors = [
 description = "Sonar Scanner for the Python Ecosystem"
 readme = "README.md"
 license = {file = "LICENSE"}
-requires-python = ">=3.12"
+requires-python = ">=3.8"
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",
@@ -66,6 +66,7 @@ dependencies = [
 [tool.hatch.envs.tool.scripts]
 license = 'python -m licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2023 -n "Sonar Scanner Python" -E .py' 
 format = 'python -m black src/ tests/ --check'
+apply_format = 'python -m black src/ tests/'
 type_check = "python -m mypy src/ tests/ --ignore-missing-imports"
 
 [tool.pytest.ini_options]

sonar-project.properties

@@ -0,0 +1,7 @@
+sonar.projectKey=SonarSource_sonar-scanner-python
+sonar.projectName=sonar-scanner-python
+sonar.organization=sonarsource
+sonar.python.version=3.8,3.9,3.10,3.11,3.12
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.sources=src
+sonar.tests=tests