From a4bcd0e2d07663bdb0c6ebdaf88de771777eab5e Mon Sep 17 00:00:00 2001 From: aditeyabaral Date: Mon, 14 Sep 2026 20:19:06 -0500 Subject: [PATCH 1/3] docs: show each environment's live API version MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Nothing in the README said which version was deployed anywhere, and there was no way to tell production and staging apart. Two shields.io badges now read `info.version` straight from each environment's `/openapi.json`, which is public and needs no credential. They update themselves, so no release step has to remember to edit the README — and the two disagreeing is the signal that production is behind, which happened twice this week and both times had to be found by hand. A GitHub release badge was the alternative and would have been wrong: the newest release is `v2.1` from July 2025, two majors behind the 4.5.0 the API actually serves. `cacheSeconds=600` keeps shields from re-fetching on every view while staying fresh enough to be useful after a deploy. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01VU7YUhP71KSsotWQ1H7CRH --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 437e4db..6043589 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,13 @@ returns the user's profile information. No personal data is stored. ## PESUAuth LIVE Deployment +[![Production API version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fpesu-auth.onrender.com%2Fopenapi.json&query=%24.info.version&label=production&color=blue&prefix=v&cacheSeconds=600)](https://pesu-auth.onrender.com/) +[![Staging API version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fpesu-auth-dev.onrender.com%2Fopenapi.json&query=%24.info.version&label=staging&color=orange&prefix=v&cacheSeconds=600)](https://pesu-auth-dev.onrender.com/) + +Both versions are read live from each environment's `/openapi.json`, so they show what is actually +deployed rather than what was last released — and the two differing is how you notice production +is behind. + - You can access the PESUAuth API endpoints [here](https://pesu-auth.onrender.com/). - You can view the health status of the API on the health check pages for [production](https://xzlk85cp.status.cron-job.org) and [staging](https://6ns95sgb.status.cron-job.org). From cc4349e2386704b91424e2caf5e92a14c38e69c8 Mon Sep 17 00:00:00 2001 From: aditeyabaral Date: Mon, 14 Sep 2026 20:19:06 -0500 Subject: [PATCH 2/3] chore: bump version to 4.6.0 Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01VU7YUhP71KSsotWQ1H7CRH --- pyproject.toml | 2 +- uv.lock | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index ff63373..0296f02 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "pesu-auth" -version = "4.5.0" +version = "4.6.0" description = "A simple API to authenticate PESU credentials using PESU Academy." readme = "README.md" requires-python = ">=3.14" diff --git a/uv.lock b/uv.lock index e33e842..00403ab 100644 --- a/uv.lock +++ b/uv.lock @@ -630,7 +630,7 @@ wheels = [ [[package]] name = "pesu-auth" -version = "4.5.0" +version = "4.6.0" source = { editable = "." } dependencies = [ { name = "fastapi" }, From 8474234a603d326a429a50d05d3fa546f5671366 Mon Sep 17 00:00:00 2001 From: aditeyabaral Date: Mon, 14 Sep 2026 20:22:13 -0500 Subject: [PATCH 3/3] docs: drop the explanation under the version badges A badge reading "production v4.4.0" beside one reading "staging v4.5.0" needs no paragraph saying that the versions are live and that a difference means production is behind. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01VU7YUhP71KSsotWQ1H7CRH --- README.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/README.md b/README.md index 6043589..1add79a 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,6 @@ returns the user's profile information. No personal data is stored. [![Production API version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fpesu-auth.onrender.com%2Fopenapi.json&query=%24.info.version&label=production&color=blue&prefix=v&cacheSeconds=600)](https://pesu-auth.onrender.com/) [![Staging API version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fpesu-auth-dev.onrender.com%2Fopenapi.json&query=%24.info.version&label=staging&color=orange&prefix=v&cacheSeconds=600)](https://pesu-auth-dev.onrender.com/) -Both versions are read live from each environment's `/openapi.json`, so they show what is actually -deployed rather than what was last released — and the two differing is how you notice production -is behind. - - You can access the PESUAuth API endpoints [here](https://pesu-auth.onrender.com/). - You can view the health status of the API on the health check pages for [production](https://xzlk85cp.status.cron-job.org) and [staging](https://6ns95sgb.status.cron-job.org).