Replace hardcoded version examples in release docs #27

2026-07-06T21:27:16+02:00

brian commented

2026-07-06 21:27:16 +02:00

Summary

Replace stale 0.3.1 semver examples in the README and PR template with stable 1.2.3 placeholders
Point readers to pyproject.toml on main for the current released version instead of hardcoding it in docs

Why

Release automation updates pyproject.toml, but the README and PR template were still showing 0.3.1 (actual version is 0.5.0). Using version-agnostic examples avoids this drift after every release.

Test plan

Docs-only change; no code or CI changes
Verified README prefix table and manual release section
Verified PR template bump guidance and pyproject.toml link

## Summary - Replace stale `0.3.1` semver examples in the README and PR template with stable `1.2.3` placeholders - Point readers to `pyproject.toml` on `main` for the current released version instead of hardcoding it in docs ## Why Release automation updates `pyproject.toml`, but the README and PR template were still showing `0.3.1` (actual version is `0.5.0`). Using version-agnostic examples avoids this drift after every release. ## Test plan - [x] Docs-only change; no code or CI changes - [x] Verified README prefix table and manual release section - [x] Verified PR template bump guidance and `pyproject.toml` link

brian added 1 commit 2026-07-06 21:27:17 +02:00

Use version-agnostic examples in release docs.

Code Quality Pipeline / code-quality (pull_request) Successful in 46s

Details

PR Title Check / check-title (pull_request) Successful in 6s

Details

Test Python Package / test (pull_request) Successful in 1m21s

Details

d3cbb65bbc

Replace hardcoded semver examples with stable placeholders and point readers to pyproject.toml for the current version.

Co-authored-by: Cursor <[email protected]>

ci-bot commented

2026-07-06 21:29:33 +02:00

Test Coverage Report:

============================= test session starts ==============================
platform linux -- Python 3.12.3, pytest-9.1.1, pluggy-1.6.0
rootdir: /workspace/brian/python-repositories
configfile: pyproject.toml
testpaths: tests
plugins: cov-7.1.0, anyio-4.14.1
collected 109 items

tests/integration/examples_test.py ...                                   [  2%]
tests/integration/minio_adapter_test.py .........................        [ 25%]
tests/integration/redis_adapter_test.py ...................              [ 43%]
tests/unit/adapters_test.py .......                                      [ 49%]
tests/unit/connection_aware_adapter_test.py .............                [ 61%]
tests/unit/connection_aware_interface_test.py ...                        [ 64%]
tests/unit/context_aware_interface_test.py ..                            [ 66%]
tests/unit/dotenv_loader_test.py ..                                      [ 67%]
tests/unit/json_repository_interface_test.py ....                        [ 71%]
tests/unit/minio_adapter_test.py ......                                  [ 77%]
tests/unit/minio_config_test.py ..........                               [ 86%]
tests/unit/object_repository_interface_test.py ....                      [ 89%]
tests/unit/redis_adapter_test.py ........                                [ 97%]
tests/unit/redis_config_test.py ...                                      [100%]

================================ tests coverage ================================
_______________ coverage: platform linux, python 3.12.3-final-0 ________________

Name                                                            Stmts   Miss  Cover   Missing
---------------------------------------------------------------------------------------------
python_repositories/__init__.py                                    12      1    92%   43
python_repositories/adapters/__init__.py                           13      2    85%   37, 42
python_repositories/adapters/connection_aware_adapter.py           45      0   100%
python_repositories/adapters/minio_adapter.py                     119      8    93%   62-70, 75
python_repositories/adapters/redis_adapter.py                      96     11    89%   54-65, 67-69
python_repositories/config/__init__.py                              4      0   100%
python_repositories/config/dotenv_loader.py                         7      0   100%
python_repositories/config/minio_config.py                         31      0   100%
python_repositories/config/redis_config.py                         14      0   100%
python_repositories/examples/__init__.py                            0      0   100%
python_repositories/examples/artifact_object_repository.py          9      0   100%
python_repositories/examples/user_json_repository.py               10      0   100%
python_repositories/interfaces/__init__.py                          5      0   100%
python_repositories/interfaces/connection_aware_interface.py        8      0   100%
python_repositories/interfaces/context_aware_interface.py           8      0   100%
python_repositories/interfaces/json_repository_interface.py        10      0   100%
python_repositories/interfaces/object_repository_interface.py      11      0   100%
---------------------------------------------------------------------------------------------
TOTAL                                                             402     22    95%
============================= 109 passed in 49.38s =============================

**Test Coverage Report:** ``` ============================= test session starts ============================== platform linux -- Python 3.12.3, pytest-9.1.1, pluggy-1.6.0 rootdir: /workspace/brian/python-repositories configfile: pyproject.toml testpaths: tests plugins: cov-7.1.0, anyio-4.14.1 collected 109 items tests/integration/examples_test.py ... [ 2%] tests/integration/minio_adapter_test.py ......................... [ 25%] tests/integration/redis_adapter_test.py ................... [ 43%] tests/unit/adapters_test.py ....... [ 49%] tests/unit/connection_aware_adapter_test.py ............. [ 61%] tests/unit/connection_aware_interface_test.py ... [ 64%] tests/unit/context_aware_interface_test.py .. [ 66%] tests/unit/dotenv_loader_test.py .. [ 67%] tests/unit/json_repository_interface_test.py .... [ 71%] tests/unit/minio_adapter_test.py ...... [ 77%] tests/unit/minio_config_test.py .......... [ 86%] tests/unit/object_repository_interface_test.py .... [ 89%] tests/unit/redis_adapter_test.py ........ [ 97%] tests/unit/redis_config_test.py ... [100%] ================================ tests coverage ================================ _______________ coverage: platform linux, python 3.12.3-final-0 ________________ Name Stmts Miss Cover Missing --------------------------------------------------------------------------------------------- python_repositories/__init__.py 12 1 92% 43 python_repositories/adapters/__init__.py 13 2 85% 37, 42 python_repositories/adapters/connection_aware_adapter.py 45 0 100% python_repositories/adapters/minio_adapter.py 119 8 93% 62-70, 75 python_repositories/adapters/redis_adapter.py 96 11 89% 54-65, 67-69 python_repositories/config/__init__.py 4 0 100% python_repositories/config/dotenv_loader.py 7 0 100% python_repositories/config/minio_config.py 31 0 100% python_repositories/config/redis_config.py 14 0 100% python_repositories/examples/__init__.py 0 0 100% python_repositories/examples/artifact_object_repository.py 9 0 100% python_repositories/examples/user_json_repository.py 10 0 100% python_repositories/interfaces/__init__.py 5 0 100% python_repositories/interfaces/connection_aware_interface.py 8 0 100% python_repositories/interfaces/context_aware_interface.py 8 0 100% python_repositories/interfaces/json_repository_interface.py 10 0 100% python_repositories/interfaces/object_repository_interface.py 11 0 100% --------------------------------------------------------------------------------------------- TOTAL 402 22 95% ============================= 109 passed in 49.38s ============================= ```

brian merged commit 14b8d2798c into main

2026-07-06 21:37:35 +02:00

brian deleted branch cursor/fix-version-doc-drift

2026-07-06 21:37:36 +02:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: lille-vemmelund/python-repositories#27