You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/template_usage.md
+6-37Lines changed: 6 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,52 +86,21 @@ line-length = 120
86
86
87
87
### Coverage tests with _Codecov_
88
88
89
-
Coverage tells what fraction of the code is "covered" by unit tests, thereby encouraging contributors to [write tests](contributing.md#writing-tests).
89
+
Coverage tells what fraction of the code is "covered" by unit tests,
90
+
thereby encouraging contributors to [write tests](contributing.md#writing-tests).
90
91
To enable coverage checks, head over to [codecov][] and sign in with your GitHub account.
91
-
You'll find more information in "getting started" section of the [codecov docs][].
92
+
You'll find more information in "quick start" section of the [codecov docs][].
92
93
93
-
In the `Actions` tab of your projects' GitHub repository, you can see that the workflows are failing due to the **Upload coverage** step.
94
-
The error message in the workflow should display something like:
95
-
96
-
```
97
-
...
98
-
Retrying 5/5 in 2s..
99
-
{'detail': ErrorDetail(string='Could not find a repository, try using repo upload token', code='not_found')}
100
-
Error: 404 Client Error: Not Found for url:
101
-
...
102
-
```
103
-
104
-
While [codecov docs][] has a very extensive documentation on how to get started,
105
-
_if_ you are using the default settings of this template we can assume that you are using [codecov][] in a GitHub action workflow and hence you can make use of the [codecov bot][].
94
+
Codecov uses [OpenID connect][] to authenticate, therefore, specifying a token should not be necessary.
106
95
96
+
If you want codecov to comment on pull requests, you can make use of the [codecov bot][].
107
97
To set it up, simply go to the [codecov app][] page and follow the instructions to activate it for your repository.
108
-
Once the activation is completed, go back to the `Actions` tab and re-run the failing workflows.
109
-
110
-
The workflows should now succeed, and you will be able to find the code coverage at this link:
0 commit comments