Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(README.md): remove obsolete square brackets #27

Merged
merged 1 commit into from
Aug 5, 2024
Merged

Conversation

JKRhb
Copy link
Member

@JKRhb JKRhb commented Aug 2, 2024

Looking at the README file, I noticed that there currently are obsolete square brackets around the code coverage badge. This PR removes them. However, it might make sense to also wrap the badge with a proper link (there is anything to link to here).

Copy link

github-actions bot commented Aug 2, 2024

Workflow Status Report

Generated for commit 00fe8aa on Fri Aug 2 14:20:19 UTC 2024.

CI Status

Linting Report

Clippy check result: success

Refer to the "Files Changed" tab for identified issues.

Code Coverage Report

Filename                                    Stmts    Miss  Cover    Missing
----------------------------------------  -------  ------  -------  -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
libcoap/src/message/mod.rs                    244     124  49.18%   106-109, 111-132, 140-146, 148-169, 173, 175, 209, 211, 214-223, 226-244, 246-250, 266-275, 296-302, 397, 440, 446, 477, 485, 487-489, 496-497, 505, 510-523, 528, 548-549, 560-561
libcoap/src/message/request.rs                220     150  31.82%   52, 69-202, 229-257, 265-375, 381, 384-386, 390, 397-401, 412, 416, 431-432, 437, 440-441, 445-446, 450, 453, 456, 459, 462, 473-477
libcoap/src/message/response.rs               143     111  22.38%   33-156, 162, 165, 168, 171, 174, 192-322, 326-330, 356-357
libcoap/tests/dtls_client_server_test.rs       10       0  100.00%
libcoap-sys/src/lib.rs                         61      18  70.49%   115-151, 180-197, 319-320
libcoap/src/session/client.rs                 126      53  57.94%   69, 71-73, 77-83, 85, 89, 100, 103, 108, 129, 135, 141-142, 144, 163, 169, 175-176, 178, 200, 202, 204, 206-212, 254-255, 261-271, 282-292, 303-313, 360-365
libcoap/src/session/mod.rs                    154      86  44.16%   61-67, 96-97, 111-225, 236-252, 268-270, 289-291, 301-311, 347, 362, 377-396, 419, 427, 451, 455, 476-480, 558, 564
libcoap/src/session/server.rs                  43      12  72.09%   70-72, 105-106, 116-117, 144-149
libcoap/src/context.rs                        216     112  48.15%   109-114, 120-121, 126, 131, 133, 135, 137, 139, 141-147, 183-226, 235-243, 260, 296, 373, 378, 394, 402-535, 560-567, 582-592, 605-612, 623-650
libcoap/src/crypto.rs                          31       2  93.55%   109, 177
libcoap/src/error.rs                            4       4  0.00%    87-166
libcoap/src/event.rs                            9       0  100.00%
libcoap/src/mem.rs                            118      48  59.32%   144-158, 192-193, 206-207, 267-293, 315-319, 349-350, 363-365, 377-388, 448-484, 503, 522-523, 526-527
libcoap/src/prng.rs                            16      12  25.00%   60-170
libcoap/src/protocol.rs                       150     110  26.67%   145-146, 152-157, 159-174, 176-177, 184-189, 191-206, 208-209, 266-267, 289, 303-304, 347-352, 361-380, 437-482, 515, 517
libcoap/src/resource.rs                       137      68  50.36%   95-97, 172-207, 215-220, 246, 249, 252, 255, 266-287, 300-302, 327-331, 338-339, 348-350, 356-358, 364-372, 495-506
libcoap/src/transport.rs                       10       3  70.00%   28-33, 54
libcoap/src/types.rs                          236     152  35.59%   76-121, 128-154, 194-269, 279, 343, 417-457, 510-559, 567, 584, 616, 642-692, 745, 760, 790-810, 832-833, 866-950
libcoap/tests/common/mod.rs                    43       5  88.37%   66, 91, 93-94, 97
TOTAL                                        1971    1070  45.71%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

badge

Results for commit: c29138b

Coverage target is 80%

@pulsastrix
Copy link
Member

Thanks for the fix 😄.

If we had some kind of page that shows the current coverage report of this CI run even outside of PRs, we could link there instead.
This would also have the advantage that we could see the current coverage state on the current state of main.

Maybe we could create a job summary for the coverage report (see https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries/)?

@JKRhb
Copy link
Member Author

JKRhb commented Aug 5, 2024

If we had some kind of page that shows the current coverage report of this CI run even outside of PRs, we could link there instead. This would also have the advantage that we could see the current coverage state on the current state of main.

Maybe we could create a job summary for the coverage report (see https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries/)?

That sounds good to me :) Should we open an issue for that and add that an a follow-up PR?

@pulsastrix
Copy link
Member

@JKRhb Done, see #28

@JKRhb JKRhb merged commit 463a2ac into main Aug 5, 2024
14 checks passed
@JKRhb JKRhb deleted the square-brackets branch August 5, 2024 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants