PyTemplate/.github/workflows/python-app.yml at main · Spill-Tea/PyTemplate · 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
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: PyTemplate CI

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

jobs:
  style:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false

    steps:
      - name: Checkout PyTemplate Project
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version-file: .python-version-default

      - name: Install dependencies
        run: |
          python -m pip install -U pip
          pip install wheel setuptools
          pip install tox

      - name: Code Linting & Formatting
        if: always()
        run: tox -e lint

      - name: Static Type Safety Check
        if: always()
        run: tox -e type

      - name: Confirm Documentation Builds
        if: always()
        run: tox -e docs

  tests:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ ubuntu-latest ]
        python-version: [ "3.11", "3.12", "3.13" ]

    steps:
      - name: Checkout PyTemplate Project
        uses: actions/checkout@v4

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

      - name: Install dependencies
        run: |
          python -m pip install -U pip
          pip install wheel setuptools
          pip install tox
          echo "TOX_VERSION=py$(echo ${{ matrix.python-version }} | tr -d .)-tests" >> $GITHUB_ENV

      - name: Unit Testing
        run: |
          tox -e ${{ env.TOX_VERSION }}

      - name: Save Coverage Data Temporarily
        uses: actions/upload-artifact@v4
        with:
          name: coverage-data-${{ matrix.os }}-${{ matrix.python-version }}
          path: .coverage.*
          retention-days: 1
          if-no-files-found: ignore
          include-hidden-files: true

  coverage:
    runs-on: "ubuntu-latest"
    needs: [ tests ]
    strategy:
      fail-fast: false

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

      - name: Download coverage data
        uses: actions/download-artifact@v4
        with:
          pattern: coverage-data-*
          merge-multiple: true

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version-file: .python-version-default

      - name: Install Dependencies
        run: |
          pip install coverage

      - name: Report Testing Coverage
        run: |
          coverage combine
          coverage report --format markdown | tee $GITHUB_STEP_SUMMARY
          coverage report

  license:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Golang
        uses: actions/setup-go@v5
        with:
          go-version: '1.22.4'

      - name: Install addlicense
        run: |
          go install github.com/google/addlicense@v1.2.0

      - name: Check for License Headers
        run: |
          addlicense -check -f LICENSE src
          addlicense -check -f LICENSE tests