-
Notifications
You must be signed in to change notification settings - Fork 28
160 lines (156 loc) · 6.24 KB
/
python-package.yml
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
# -----------------------------------------------------------------------------
# BSD 3-Clause License
#
# Copyright (c) 2020-2023, Science and Technology Facilities Council.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# -----------------------------------------------------------------------------
# Author A. R. Porter, STFC Daresbury Lab
# Modified by R. W. Ford, STFC Daresbury Lab
# Modified by A. J. Voysey, Met Office
# Modified by J. Henrichs, Bureau of Meteorology
# Modified by N. M. Nobre, STFC Daresbury Lab
# This workflow will install Python dependencies, run tests and lint with a
# variety of Python versions.
# For more information see:
# https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
name: PSyclone tests and examples
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
workflow_dispatch:
jobs:
markdown-link-check:
if: ${{ github.repository != 'stfc/PSyclone-mirror' }}
# Check all markdown files for dead links. See the 'mlc_config.json'
# file in the project root directory for configuration.
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-verbose-mode: 'yes'
config-file: '.github/workflows/mlc_config.json'
sphinx-link-check:
if: ${{ github.repository != 'stfc/PSyclone-mirror' }}
# Check all Sphinx documentation for dead links.
runs-on: ubuntu-latest
env:
GITHUB_PR_NUMBER: ${{ github.event.number }}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- run: sudo apt-get install -y graphviz doxygen
- run: python -m pip install --upgrade pip
- run: pip install .[doc]
- run: cd doc/user_guide; make html
- run: cd doc/developer_guide; make html
- run: cd doc/reference_guide; make html
- run: cd doc/psyad/user_guide; make html
- run: cd doc; python -m http.server &
- run: cd doc/user_guide; make linkcheck
- run: cd doc/developer_guide; make linkcheck
- run: cd doc/reference_guide; make linkcheck
- run: cd doc/psyad/user_guide; make linkcheck
dev-doctest:
if: ${{ github.repository != 'stfc/PSyclone-mirror' }}
# Check doctests of developer's guide
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- run: python -m pip install --upgrade pip
- run: pip install .[doc]
- run: cd doc/developer_guide; make doctest
build:
if: ${{ github.repository != 'stfc/PSyclone-mirror' }}
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.7, 3.8, 3.11]
steps:
- uses: actions/checkout@v3
with:
submodules: recursive
# This is required to get the commit history for merge commits for
# the ci-skip check below.
fetch-depth: '0'
- name: Check for [skip ci] in commit message
uses: mstachniuk/ci-skip@v1
with:
# This setting causes the tests to 'fail' if [skip ci] is specified
fail-fast: true
commit-filter: '[skip ci]'
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
# Some of the examples use Jupyter. We need to keep IPython to
# below 8.0 as we still run the test suite with Python 3.7.
pip install "ipython>=7.0,<8.0" jupyter
# If you wish to install the version of fparser pointed to by the
# submodule instead of the released version (from PyPI) then
# uncomment the following line:
# pip install external/fparser
pip install .[test]
- name: Lint with flake8
run: |
# Stop the build if there are Python syntax errors or undefined names.
# See PSyclone/setup.cfg for configuration of this check.
flake8 --count --select=E9,F63,F7,F82 --show-source --statistics src examples tutorial
- name: Run examples
run: |
( make -j 2 -C examples transform > /dev/null )
( make -C examples notebook )
- name: Run tutorials
run: |
( make -C tutorial/practicals transform > /dev/null )
( make -C tutorial/notebooks notebook )
- name: Test with pytest
if: ${{ !(matrix.python-version == 3.8) }}
run: |
locale
pytest -n auto --cov=psyclone --cov-report=xml src/psyclone/tests
- name: Test with pytest and C Locale
if: ${{ matrix.python-version == 3.8 }}
run: |
locale
pytest -n auto --cov=psyclone --cov-report=xml src/psyclone/tests
env:
LC_ALL: C
LANG: C
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
verbose: true