py_plate/.github/workflows/ci.yml at 4576c04a0677f15a123085b25de134a7781357bc · GRodolphe/py_plate · 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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
name: CI

on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main, develop ]

permissions:
  contents: read
  security-events: write
  actions: read

jobs:
  test:
    name: Test Python ${{ matrix.python-version }}
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.9", "3.10", "3.11", "3.12"]

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v4
      with:
        python-version: ${{ matrix.python-version }}

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[dev]"

    - name: Run ruff linting
      run: |
        ruff check

    - name: Run ruff formatting check
      run: |
        ruff format --check

    - name: Run mypy type checking
      run: |
        mypy src/

    - name: Run tests with coverage
      run: |
        pytest --cov --cov-report=xml --cov-report=term-missing

    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v4
      with:
        file: ./coverage.xml
        flags: unittests
        name: codecov-umbrella
        fail_ci_if_error: false
        token: ${{ secrets.CODECOV_TOKEN }}

  security:
    name: Security Scan
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: "3.11"

    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[dev]"
        pip install safety detect-secrets bandit

    - name: Run Trivy filesystem scan
      uses: aquasecurity/trivy-action@master
      with:
        scan-type: 'fs'
        scan-ref: '.'
        format: 'table'

    - name: Run Trivy filesystem scan (JSON report)
      uses: aquasecurity/trivy-action@master
      with:
        scan-type: 'fs'
        scan-ref: '.'
        format: 'json'
        output: 'trivy-fs-results.json'

    - name: Upload Trivy filesystem results
      uses: actions/upload-artifact@v4
      if: always()
      with:
        name: trivy-fs-results
        path: trivy-fs-results.json

    - name: Run bandit security linter
      run: |
        bandit -r src/ -c pyproject.toml

    - name: Run safety check
      run: |
        safety check || true

    - name: Run secret detection
      run: |
        detect-secrets scan --baseline .secrets.baseline

  build:
    name: Build Package
    runs-on: ubuntu-latest
    needs: [test, security]

    steps:
    - uses: actions/checkout@v4

    - name: Set up Python
      uses: actions/setup-python@v4
      with:
        python-version: "3.11"

    - name: Install build dependencies
      run: |
        python -m pip install --upgrade pip
        pip install build

    - name: Build package
      run: |
        python -m build

    - name: Run Trivy scan on built package
      uses: aquasecurity/trivy-action@master
      with:
        scan-type: 'fs'
        scan-ref: 'dist/'
        format: 'table'

    - name: Run Trivy scan on built package (JSON report)
      uses: aquasecurity/trivy-action@master
      with:
        scan-type: 'fs'
        scan-ref: 'dist/'
        format: 'json'
        output: 'trivy-package-results.json'

    - name: Upload Trivy package results
      uses: actions/upload-artifact@v4
      if: always()
      with:
        name: trivy-package-results
        path: trivy-package-results.json

    - name: Upload artifacts
      uses: actions/upload-artifact@v4
      with:
        name: dist
        path: dist/

  # Container security scan job - uncomment when you add Docker support
  # container-security:
  #   name: Container Security Scan
  #   runs-on: ubuntu-latest
  #   needs: [build]
  #
  #   steps:
  #   - uses: actions/checkout@v4
  #
  #   - name: Build Docker image
  #     run: |
  #       docker build -t py_plate:latest .
  #
  #   - name: Run Trivy container scan
  #     uses: aquasecurity/trivy-action@master
  #     with:
  #       image-ref: 'py_plate:latest'
  #       format: 'sarif'
  #       output: 'trivy-container-results.sarif'
  #
  #   - name: Upload Trivy container scan results to GitHub Security tab
  #     uses: github/codeql-action/upload-sarif@v3
  #     if: always()
  #     with:
  #       sarif_file: 'trivy-container-results.sarif'
  #
  #   - name: Run Trivy container scan (JSON report)
  #     uses: aquasecurity/trivy-action@master
  #     with:
  #       image-ref: 'py_plate:latest'
  #       format: 'json'
  #       output: 'trivy-container-results.json'
  #
  #   - name: Upload Trivy container results
  #     uses: actions/upload-artifact@v4
  #     if: always()
  #     with:
  #       name: trivy-container-results
  #       path: trivy-container-results.json