Skip to content

Commit d712992

Browse files
authored
Update 02_continuous_integration.md
1 parent 4e6bd57 commit d712992

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/contrib/02_continuous_integration.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Continuous Integration in pySDC
22

33
Any commit in `pySDC` are tested by GitHub continuous integration (CI). You can see in in the [action panel](https://github.com/Parallel-in-Time/pySDC/actions) the tests for each branches.
4-
Those tests can be divided in three main categories : [code linting](#code-linting), [code testing](#code-testing) and [code coverage](#code-coverage).
4+
Those tests are currently divided in three main categories : [code linting](#code-linting), [code testing](#code-testing) and [code coverage](#code-coverage).
55
Finally, the CI also build artifacts that are used to generate the documentation website (see http://parallel-in-time.org/pySDC/), more details given in the [documentation generation](#documentation-generation) section.
66

77
## Code linting
@@ -50,14 +50,14 @@ pytest -v pySDC/tests
5050
5151
## Code coverage
5252
53-
This stage allows to checks how much part of the `pySDC` code is tested by the previous stage. It is based on the [coverage](https://pypi.org/project/coverage/) library and currently applied to the following directories :
53+
This stage allows to checks how much of the `pySDC` code is tested by the previous stage. It is based on the [coverage](https://pypi.org/project/coverage/) library and currently applied to the following directories :
5454
5555
- `pySDC/core`
5656
- `pySDC/projects`
5757
- `pySDC/tutorial`
5858
5959
This analysis is done in parallel to the test each time a pull is done on any branch (main repository or fork).
60-
You can look at the current coverage report for the master branch [here](https://parallel-in-time.org/pySDC/coverage/index.html).
60+
You can look at the current coverage report for the master branch [here](https://parallel-in-time.org/pySDC/coverage/index.html) or compare the results with previous builds [here](https://app.codecov.io/gh/Parallel-in-Time/pySDC). Codecov will also comment on any pull request, indicating the change of coverage.
6161
6262
During developments, you can also run the coverage tests locally, using :
6363
@@ -104,6 +104,8 @@ Accepted use of the `# pragma: no cover` are:
104104
1. Functions and code used for plotting
105105
2. Lines in one conditional preceding any `raise` statement
106106

107+
If you think the pragma should be used in other parts of your pull request, please indicate (and justify) this in your description.
108+
107109
## Documentation generation
108110

109111
Documentation is built using [sphinx](https://www.sphinx-doc.org/en/master/).
@@ -123,9 +125,9 @@ sphinx-build -b html docs/source docs/build/html
123125
Then you can open `docs/build/html/index.html` using you favorite browser and check how your own documentation looks like on the website.
124126

125127
> :bell: **Important** : running all the tests is necessary to generate graphs and images used by the website.
126-
> But you can still generate the website without it : just all images for the tutorials, projects and playgrounds will be missing.
128+
> But you can still generate the website without it: just all images for the tutorials, projects and playgrounds will be missing.
127129
> This approach can be considered for local testing of your contribution when it does not concern parts containing images (_i.e_ project or code documentation).
128130
129131
:arrow_left: [Back to Pull Request Recommendation](./01_pull_requests.md) ---
130132
:arrow_up: [Contributing Summary](./../../CONTRIBUTING.md) ---
131-
:arrow_right: [Next to Naming Conventions](./03_naming_conventions.md)
133+
:arrow_right: [Next to Naming Conventions](./03_naming_conventions.md)

0 commit comments

Comments
 (0)