sonar-scanner-python/.github/workflows/build.yml at 50b03e0963e6629566617570572cd0f6de9f2782 · SonarSource/sonar-scanner-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
name: Build
on:
  push:
    branches: [master, branch-*, dogfood-*]
  pull_request:
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: "Build"
    runs-on: sonar-s-public
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - uses: jdx/mise-action@c5c33d5a70c9cc62e906bc25c5eb6080e40c3eba # v3.2.0
      - uses: SonarSource/ci-github-actions/build-poetry@v1
        with:
          sonar-platform: none

  formatting:
    name: "Formatting"
    runs-on: sonar-s-public
    needs: [build]
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - uses: jdx/mise-action@c5c33d5a70c9cc62e906bc25c5eb6080e40c3eba # v3.2.0
      - uses: SonarSource/ci-github-actions/build-poetry@v1
        with:
          script: |
            poetry run black src/ tests/ --check
            poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d src/
            poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d tests/
            git diff --name-only --exit-code ./src ./tests
          sonar-platform: none

  documentation:
    name: "CLI Documentation"
    runs-on: sonar-s-public
    needs: [build]
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - uses: jdx/mise-action@c5c33d5a70c9cc62e906bc25c5eb6080e40c3eba # v3.2.0
      - uses: SonarSource/ci-github-actions/build-poetry@v1
        with:
          script: |
            poetry run python tools/generate_cli_documentation.py
            git diff --exit-code CLI_ARGS.md
          sonar-platform: none

  analysis:
    name: "NEXT Analysis"
    runs-on: sonar-s-public
    needs: [build]
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - uses: jdx/mise-action@c5c33d5a70c9cc62e906bc25c5eb6080e40c3eba # v3.2.0
      - uses: SonarSource/ci-github-actions/build-poetry@v1
        with:
          script: |
            poetry run pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=src --cov-branch tests
            poetry run mypy src/ > mypy-report.txt || true
          artifactory-reader-role: public-reader
          artifactory-deployer-role: public-deployer
          sonar-platform: next

  qa:
    name: "Test Python ${{ matrix.python-version }}"
    runs-on: sonar-s-public
    needs: [build]
    permissions:
      id-token: write
      contents: read
    strategy:
      matrix:
        python-version: ["3.9.18", "3.9.6", "3.10.13", "3.11.7", "3.12.1", "3.13.2"]
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - uses: jdx/mise-action@c5c33d5a70c9cc62e906bc25c5eb6080e40c3eba # v3.2.0
      - uses: SonarSource/ci-github-actions/build-poetry@v1
        with:
          python-version: ${{ matrix.python-version }}
          script: |
            poetry run pytest tests/
          sonar-platform: none

  qa-windows:
    name: "Test Windows"
    runs-on: github-windows-latest-s
    needs: [build]
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - uses: SonarSource/ci-github-actions/build-poetry@v1
        with:
          script: |
            poetry run pytest tests/
            if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
          sonar-platform: none

  its:
    name: "Integration Tests"
    runs-on: sonar-s-public
    needs: [build]
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - uses: jdx/mise-action@c5c33d5a70c9cc62e906bc25c5eb6080e40c3eba # v3.2.0
      - name: Cache SonarQube
        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
        with:
          path: sonarqube_cache/
          key: sonarqube-25.3.0.104237
      - name: Download SonarQube
        run: |
          mkdir -p sonarqube_cache
          if [ ! -f sonarqube_cache/sonarqube.zip ]; then
            wget -q https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-25.3.0.104237.zip -O sonarqube_cache/sonarqube.zip
          fi
        env:
          SONARQUBE_VERSION: 25.3.0.104237
      - uses: SonarSource/ci-github-actions/build-poetry@v1
        with:
          sonar-platform: none
          script: .github/scripts/run_its.sh

  promote:
    name: "Promote"
    needs: [formatting, documentation, analysis, qa, qa-windows, its]
    runs-on: sonar-s-public
    permissions:
      id-token: write
      contents: write
    steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
      - uses: jdx/mise-action@c5c33d5a70c9cc62e906bc25c5eb6080e40c3eba # v3.2.0
      - uses: SonarSource/ci-github-actions/build-poetry@v1
        with:
          sonar-platform: none
          artifactory-reader-role: public-reader
          artifactory-deployer-role: public-deployer
          deploy-pull-request: true