Skip to content

Commit c30f9b4

Browse files
committed
docs: update coverage badge references in README.md and CONTRIBUTING.md
- Changed the coverage badge URL in `README.md` to reflect the new filename `yt-framework-coverage.json`. - Updated step 8 in `CONTRIBUTING.md` to reference the correct coverage file name, ensuring clarity for contributors.
1 parent 39a8931 commit c30f9b4

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
"color": color,
6565
}
6666
body = json.dumps(
67-
{"files": {"coverage-shields.json": {"content": json.dumps(payload)}}}
67+
{"files": {"yt-framework-coverage.json": {"content": json.dumps(payload)}}}
6868
)
6969
req = urllib.request.Request(
7070
f"https://api.github.com/gists/{os.environ['COVERAGE_GIST_ID']}",

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ Complete these steps **in order** (each step is one action):
282282

283283
7. Edit [README.md](README.md): in the coverage badge URL, replace **`YOUR_GIST_ID`** with the gist ID from step 3 (leave the rest of the shields.io URL unchanged).
284284

285-
8. Push or merge to **`main`** and confirm in **Actions** that CI succeeded; open the gist and check that **`coverage-shields.json`** shows the real percentage.
285+
8. Push or merge to **`main`** and confirm in **Actions** that CI succeeded; open the gist and check that **`yt-framework-coverage.json`** shows the real percentage.
286286

287287
9. If the README badge looks stale, hard-refresh the page or wait briefly; shields.io and proxies may cache images. The badge URL includes `cacheSeconds=60` to limit caching.
288288

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![CI](https://github.com/GregoryKogan/yt-framework/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/GregoryKogan/yt-framework/actions/workflows/ci.yml)
66
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/GregoryKogan/yt-framework)
77
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/yt_framework)
8-
[![coverage](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FGregoryKogan%2F293242803e295690b612e93aff8c151e%2Fraw%2Fcoverage-shields.json&cacheSeconds=60)](https://github.com/GregoryKogan/yt-framework/actions/workflows/ci.yml)
8+
[![coverage](https://img.shields.io/endpoint?url=https%3A%2F%2Fgist.githubusercontent.com%2FGregoryKogan%2F293242803e295690b612e93aff8c151e%2Fraw%2Fyt-framework-coverage.json&cacheSeconds=60)](https://github.com/GregoryKogan/yt-framework/actions/workflows/ci.yml)
99
![GitHub License](https://img.shields.io/github/license/GregoryKogan/yt-framework)
1010

1111
**[PyPI](https://pypi.org/project/yt-framework/) | [Docs](https://yt-framework.readthedocs.io/en/latest/) | [DeepWiki](https://deepwiki.com/GregoryKogan/yt-framework) | [Examples](https://github.com/GregoryKogan/yt-framework/tree/main/examples)**

0 commit comments

Comments
 (0)