tldr-python-client/.github/workflows/test.yml at 86797942f77ebf4ef31b725e1c367cd3b7139006 · tldr-pages/tldr-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
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
201
202
203
204
205
206
207
208
209
210
name: Test

on: ['push', 'pull_request']

jobs:
  build-linux:
    runs-on: ${{ matrix.os }}

    permissions:
      contents: read

    strategy:
      matrix:
        os: ['ubuntu-latest', 'ubuntu-24.04-arm']
        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', 'pypy3.10', 'pypy3.11']

    steps:
    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

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

    - name: Install developer dependencies
      run: |
        python3 -m pip install -U pip
        python3 -m pip install -U pytest pytest-runner flake8

    - name: Install sphinx dependencies
      run:
        python3 -m pip install sphinx sphinx-argparse --user

    - name: Install tldr dependencies
      run:
        python3 -m pip install -r requirements.txt --user

    - name: Generate the manpage
      working-directory: docs
      run: make man

    - name: Lint codebase
      run: python3 -m flake8

    - name: Run test suite
      run: python3 -m pytest tests/

    - name: Test tldr cli
      run: |
        python3 -m pip install .
        tldr --version

  build-macos:
    runs-on: macos-latest
    needs: ['build-linux']

    permissions:
      contents: read

    strategy:
      matrix:
        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', 'pypy3.10', 'pypy3.11']

    steps:
    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

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

    - name: Install developer dependencies
      run: |
        python3 -m pip install -U pip
        python3 -m pip install -U pytest pytest-runner flake8

    - name: Install sphinx dependencies
      run: |
        python3 -m pip install sphinx sphinx-argparse
        echo "$HOME/.local/bin" >> $GITHUB_PATH

    - name: Install tldr dependencies
      run:
        python3 -m pip install -r requirements.txt --user

    - name: Generate the manpage
      working-directory: docs
      run: make man

    - name: Lint codebase
      run: python3 -m flake8

    - name: Run test suite
      run: python3 -m pytest tests/

    - name: Test tldr cli
      run: |
        python3 -m pip install .
        tldr --version

  build-windows:
    runs-on: windows-latest
    needs: ['build-macos']

    permissions:
      contents: read

    strategy:
      matrix:
        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']

    steps:
    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

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

    - name: Install developer dependencies
      run: |
        python3 -m pip install -U pip
        python3 -m pip install -U pytest pytest-runner flake8

    - name: Install sphinx dependencies
      run: |
         python -m pip install sphinx sphinx-argparse --user

    - name: Install tldr dependencies
      run:
        python3 -m pip install -r requirements.txt --user

    - name: Generate the manpage
      working-directory: docs
      run: make man

    - name: Lint codebase
      run: python3 -m flake8

    - name: Run test suite
      run: python3 -m pytest tests/

    - name: Test tldr cli
      run: |
        python3 -m pip install .
        tldr --version

  build-windows-arm:
      runs-on: windows-11-arm
      needs: ['build-windows']

      permissions:
        contents: read

      strategy:
        matrix:
          python-version: ['3.11', '3.12', '3.13']

      steps:
      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

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

      - name: Install developer dependencies
        run: |
          python3 -m pip install -U pip
          python3 -m pip install -U pytest pytest-runner flake8

      - name: Install tldr dependencies
        run:
          python3 -m pip install -r requirements.txt --user

      - name: Lint codebase
        run: python3 -m flake8

      - name: Run test suite
        run: python3 -m pytest tests/

      - name: Test tldr cli
        run: |
          python3 -m pip install .
          tldr --version

  build-snap:
    runs-on: ${{ matrix.os }}
    if: github.repository == 'tldr-pages/tldr-python-client' && (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/'))
    needs: ['build-linux']

    permissions:
      contents: read

    strategy:
      matrix:
        os: ['ubuntu-latest', 'ubuntu-24.04-arm']

    steps:
     - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

     - uses: canonical/action-build@3bdaa03e1ba6bf59a65f84a751d943d549a54e79 # v1.3.0
       id: snapcraft-build
       with:
         snapcraft-args: "-v"

     - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
       with:
         name: ${{ steps.snapcraft-build.outputs.snap }}
         path: ${{ steps.snapcraft-build.outputs.snap }}