diff --git a/CHANGELOG.md b/CHANGELOG.md index 89dd26c..8dd493e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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%. diff --git a/docs/adr/0015-measured-coverage-badge.md b/docs/adr/0015-measured-coverage-badge.md index 1a056c6..c483ebb 100644 --- a/docs/adr/0015-measured-coverage-badge.md +++ b/docs/adr/0015-measured-coverage-badge.md @@ -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. diff --git a/docs/index.md b/docs/index.md index 44cec79..8617680 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 797d042..7e44f9d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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/