summaryrefslogtreecommitdiff
path: root/.github/workflows/ci.yml
blob: 4507429ec473e3b932124668733423ec332b8e1c (plain)
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
name: CI

on: [push, pull_request]

jobs:
  ci:
    strategy:
      # Allows for matrix sub-jobs to fail without canceling the rest
      fail-fast: false

      # MATRIX:
      # =======
      # Required parameters:
      #  os                  the os to run on
      #  python-version      the python version to use
      #  backend             the backend to use
      #  env                 any additional env variables. Set to '{}' for none
      # Optional parameters:
      #  allowed_failure     whether the job is allowed to fail
      #  extra_hash          extra hash str to differentiate from other caches with similar name (must always start with '-')
      matrix:
        # Tests [amd64]
        #
        os: [ubuntu-18.04, macos-10.15]
        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9, "3.10"]  # quotes to avoid being interpreted as the number 3.1
        env: [{ STATIC_DEPS: true }, { STATIC_DEPS: false }]

        include:
          # Coverage setup
          - os: ubuntu-18.04
            python-version: 3.9
            env: { COVERAGE: true }
            extra_hash: "-coverage"
            allowed_failure: true   # shouldn't fail but currently does...
          - os: ubuntu-18.04
            python-version: 3.9
            env: { STATIC_DEPS: false, EXTRA_DEPS: "docutils pygments sphinx sphinx-rtd-theme" }
            extra_hash: "-docs"
            allowed_failure: true   # shouldn't fail but currently does...
          # Old library setup with minimum version requirements
          - os: ubuntu-18.04
            python-version: 3.9
            env: {
              STATIC_DEPS: true,
              LIBXML2_VERSION: 2.9.2,
              LIBXSLT_VERSION: 1.1.27,
            }
            extra_hash: "-oldlibs"
            allowed_failure: true   # shouldn't fail but currently does...
          # Ubuntu sub-jobs:
          # ================
          # Pypy
          - os: ubuntu-18.04
            python-version: pypy-2.7
            env: { STATIC_DEPS: false }
            allowed_failure: true
          - os: ubuntu-18.04
            python-version: pypy-3.7
            env: { STATIC_DEPS: false }
            allowed_failure: true

          # MacOS sub-jobs
          # ==============
          - os: macos-10.15
            allowed_failure: true   # Unicode parsing fails in Py3

    # This defaults to 360 minutes (6h) which is way too long and if a test gets stuck, it can block other pipelines.
    # From testing, the runs tend to take ~3 minutes, so a limit of 20 minutes should be enough. This can always be
    # changed in the future if needed.
    timeout-minutes: 20
    runs-on: ${{ matrix.os }}

    env:
      OS_NAME: ${{ matrix.os }}
      PYTHON_VERSION: ${{ matrix.python-version }}
      MACOSX_DEPLOYMENT_TARGET: 10.14
      LIBXML2_VERSION: 2.9.10
      LIBXSLT_VERSION: 1.1.34
      COVERAGE: false
      GCC_VERSION: 8
      USE_CCACHE: 1
      CCACHE_SLOPPINESS: "pch_defines,time_macros"
      CCACHE_COMPRESS: 1
      CCACHE_MAXSIZE: "100M"

    steps:
      - name: Checkout repo
        uses: actions/checkout@v2
        with:
          fetch-depth: 1

      - name: Setup python
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Cache [ccache]
        uses: pat-s/always-upload-cache@v2.1.3
        if: startsWith(runner.os, 'Linux')
        with:
          path: ~/.ccache
          key: ${{ runner.os }}-ccache${{ matrix.extra_hash }}-${{ matrix.python-version }}-${{ hashFiles('.github/workflows/ci.yml', 'tools/ci-run.sh') }}

      - name: Run CI
        continue-on-error: ${{ matrix.allowed_failure || false }}
        env: ${{ matrix.env }}
        run: bash ./tools/ci-run.sh

      - name: Build docs
        if: contains( env.EXTRA_DEPS, 'sphinx')
        run: make html

      - name: Upload docs
        uses: actions/upload-artifact@v2
        if: ${{ matrix.extra_hash == '-docs' }}
        with:
          name: website_html
          path: doc/html
          if-no-files-found: ignore

      - name: Upload Coverage Report
        uses: actions/upload-artifact@v2
        with:
          name: pycoverage_html
          path: coverage*
          if-no-files-found: ignore

      - name: Upload Wheel
        uses: actions/upload-artifact@v2
        if: ${{ matrix.env.STATIC_DEPS == 'true' && env.COVERAGE == 'false' }}
        with:
          name: wheels-${{ runner.os }}
          path: dist/*.whl
          if-no-files-found: ignore