glpi_python_client/.github/workflows/ci.yml at main · baraline/glpi_python_client · 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
name: CI

on:
  pull_request:
  push:
    branches:
      - main
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ci-${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  tests:
    name: Tests (Python ${{ matrix.python-version }})
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.10", "3.11", "3.12", "3.13"]

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

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

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

      - name: Run tests
        run: python -m pytest -m "not integration"

  coverage:
    name: Code coverage
    runs-on: ubuntu-latest
    needs: tests

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: pip

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

      - name: Run tests with coverage
        run: >-
          python -m pytest
          -m "not integration"
          --cov=glpi_python_client
          --cov-report=term-missing
          --cov-report=xml
          --cov-fail-under=95

      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v4
        with:
          files: ./coverage.xml
          fail_ci_if_error: false
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

  quality:
    name: Lint, typing, and docs
    runs-on: ubuntu-latest

    steps:
      - name: Check out repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: pip

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

      - name: Run Ruff
        run: python -m ruff check .

      - name: Run mypy
        run: python -m mypy glpi_python_client

      - name: Build documentation
        run: python -m sphinx -W --keep-going -b html docs docs/_build/html

  publish-readthedocs:
    name: Publish latest docs
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    needs:
      - tests
      - coverage
      - quality
    runs-on: ubuntu-latest
    env:
      READTHEDOCS_BASE_URL: ${{ vars.READTHEDOCS_BASE_URL }}
      READTHEDOCS_PROJECT: ${{ secrets.READTHEDOCS_PROJECT }}
      READTHEDOCS_TOKEN: ${{ secrets.READTHEDOCS_TOKEN }}
      READTHEDOCS_VERSION: ${{ vars.READTHEDOCS_MAIN_VERSION }}

    steps:
      - name: Trigger Read the Docs latest build
        shell: bash
        run: |
          set -euo pipefail
          if [ -z "${READTHEDOCS_TOKEN:-}" ] || [ -z "${READTHEDOCS_PROJECT:-}" ]; then
            echo "Read the Docs secrets are not configured; skipping latest build."
            exit 0
          fi

          base_url="${READTHEDOCS_BASE_URL:-https://app.readthedocs.org}"
          version="${READTHEDOCS_VERSION:-latest}"

          curl --fail --silent --show-error --location \
            --request POST \
            --header "Authorization: Token ${READTHEDOCS_TOKEN}" \
            "${base_url}/api/v3/projects/${READTHEDOCS_PROJECT}/versions/${version}/builds/"