Skip to content

Commit c1236f7

Browse files
committed
📝 Add a change note for PR #1093
1 parent b498e1a commit c1236f7

2 files changed

Lines changed: 38 additions & 2 deletions

File tree

CHANGES.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,12 +133,14 @@ Contributor-facing changes
133133
- `codecov-action <https://github.com/codecov/codecov-action>`_
134134
has been temporarily downgraded to ``v3``
135135
in the GitHub Actions CI/CD workflow definitions
136-
in order to fix uploading coverage to
137-
`Codecov <https://app.codecov.io/gh/aio-libs/multidict>`_.
136+
in order to fix uploading coverage to Codecov_.
138137
See `this issue <https://github.com/codecov/codecov-action/issues/1252>`_
139138
for more details.
140139

141140

141+
.. _Codecov: https://codecov.io/gh/aio-libs/multidict?flags[]=pytest
142+
143+
142144
*Related issues and pull requests on GitHub:*
143145
:issue:`941`.
144146

CHANGES/1093.contrib.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
The the project-wide Codecov_ metric is no longer reported
2+
via GitHub Checks API. The combined value is not very useful
3+
because one of the sources (MyPy) cannot reach 100% with the
4+
current state of the ecosystem. We may want to reconsider in
5+
the future. Instead, we now have two separate
6+
“runtime coverage” metrics for library code and tests.
7+
They are to be kept at 100% at all times.
8+
And the “type coverage” metric will remain advisory, at a
9+
lower threshold.
10+
11+
The default patch metric check is renamed to “runtime”
12+
to better reflect its semantics. This one will also require
13+
100% coverage.
14+
Another “typing” patch coverage metric is now reported
15+
alongside it. It's considered advisory, just like its
16+
project counterpart.
17+
18+
When looking at Codecov_, one will likely want to look at
19+
MyPy and pytest flags separately. It is usually best to
20+
avoid looking at the PR pages that sometimes display
21+
combined coverage incorrectly.
22+
23+
The change additionally disables the deprecated GitHub
24+
Annotations integration in Codecov_.
25+
26+
Finally, the badge coloring range now starts at 100%.
27+
28+
29+
.. image:: https://codecov.io/gh/aio-libs/multidict/branch/master/graph/badge.svg?flag=pytest
30+
:target: https://codecov.io/gh/aio-libs/multidict?flags[]=pytest
31+
:alt: Coverage metrics
32+
33+
34+
-- by :user:`webknjaz`

0 commit comments

Comments
 (0)