saic-python-client-ng/.github/workflows/ci.yml at master · SAIC-iSmart-API/saic-python-client-ng · 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
name: CI
run-name: "${{ github.event_name == 'workflow_dispatch' && format('CI: {0}', github.ref_name) || '' }}"

on:
  push:
    branches:
      - '*'
  pull_request:
  release:
    types: [ published ]
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ (github.event_name == 'release' && github.run_id) || github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  build:

    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        python-version: [ "3.11", "3.12", "3.13" ]

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v5
        with:
          python-version: ${{ matrix.python-version }}
          cache: 'pip'

      - name: Install Poetry
        uses: snok/install-poetry@v1
        with:
          virtualenvs-in-project: true

      - name: Load cached venv
        id: cached-poetry-dependencies
        uses: actions/cache@v4
        with:
          path: .venv
          key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}

      - name: Install dependencies
        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
        run: |
          poetry install --no-interaction --no-root

      - name: Install as a library
        run: poetry install --no-interaction

      - name: Run mypy
        run: |
          poetry run mypy

      - name: Lint with Ruff
        run: |
          poetry run ruff check . --output-format=github
        if: success() || failure()

      - name: Lint with pylint
        run: |
          poetry run pylint src/**/*.py
        if: success() || failure()

      - name: Run tests with coverage
        run: |
          poetry run pytest tests --cov --junit-xml=junit/test-results-${{ matrix.python-version }}.xml
        if: success() || failure()

      - name: Surface failing tests
        uses: pmeier/pytest-results-action@main
        with:
          title: Test results (Python ${{ matrix.python-version }})
          path: junit/test-results-${{ matrix.python-version }}.xml

          # (Optional) Add a summary of the results at the top of the report
          summary: true
          # (Optional) Select which results should be included in the report.
          # Follows the same syntax as `pytest -r`
          display-options: fEX

          # (Optional) Fail the workflow if no JUnit XML was found.
          fail-on-empty: true
        if: success() || failure()

  release:
    name: Release to PyPi
    if: ${{ github.event_name == 'release' }}
    runs-on: ubuntu-latest
    needs:
      - build

    environment:
      name: release
      url: https://pypi.org/p/saic_ismart_client_ng

    permissions:
      contents: read

    steps:
      - name: Check out code from GitHub
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Build and publish to pypi
        uses: JRubics/poetry-publish@v2.0
        with:
          pypi_token: ${{ secrets.PYPI_API_TOKEN }}