Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ All notable changes to this project are documented here. The format follows
## [Unreleased]

### Added
- A "Code Coverage" badge next to the README title, measured by the tests on
master and linked to the full line-by-line report on the documentation site
- A "Code Coverage" badge next to the title of the README and of the docs
site's home page, measured by the tests on master and linked to the full
line-by-line report, which also has a "Coverage report" tab on the site
(ADR 0015).
Coverage is 100% of lines and branches, release scripts included, and CI
now requires 100%.
Expand Down
4 changes: 3 additions & 1 deletion docs/adr/0015-measured-coverage-badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ check it.
- `coverage.json`, written by `scripts/coverage_badge.py` in the shields.io
endpoint format.

The README badge reads that file and links to the report.
The badge next to the title of the README and of the site's home page
reads that file and links to the report, which also has a tab in the site's
navigation.
- **The number is coverage.py's own.** The badge shows coverage.py's display
value, which never rounds 99.9 up to 100. A report without totals fails the
step rather than publish a badge.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ hide:
- toc
---

# PythonMetaTrader5
# PythonMetaTrader5 [![Code Coverage](https://img.shields.io/endpoint?url=https://akinzou.github.io/MetaTrader5-Python/coverage.json)](https://akinzou.github.io/MetaTrader5-Python/coverage/)

A safe, typed trading layer over the official
[`MetaTrader5`](https://pypi.org/project/MetaTrader5/) Python package, built
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,6 @@ nav:
- adr/0015-measured-coverage-badge.md
- Migrating from 2.x: MIGRATION.md
- Changelog: CHANGELOG.md
# Absolute, not `coverage/`: the report is built next to the site by the
# coverage job, not from docs/, so a relative target fails --strict (ADR 0015).
- Coverage report: https://akinzou.github.io/MetaTrader5-Python/coverage/
Loading