Skip to content

Commit 59a9557

Browse files
mikejhillCopilot
andcommitted
fix: replace docs/samples with git-ignored private-samples directory
Move sample API responses to docs/private-samples/ (git-ignored) to prevent PII exposure when the repository is made public. Update all references in tests, documentation, and linting configuration. Replace shields.io dynamic license badge with a static badge that works regardless of repository visibility. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 966c726 commit 59a9557

5 files changed

Lines changed: 8 additions & 5 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,3 +219,6 @@ __marimo__/
219219

220220
# HTTP Archive files (may contain credentials)
221221
*.har
222+
223+
# Private sample data (contains real API responses)
224+
docs/private-samples/

.markdownlint-cli2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ config:
1717

1818
ignores:
1919
- "CHANGELOG.md"
20-
- "docs/samples/**"
20+
- "docs/private-samples/**"
2121
- ".venv/**"
2222
- "node_modules/**"

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![CI](https://github.com/mikejhill/rouvy-api/actions/workflows/ci.yml/badge.svg)](https://github.com/mikejhill/rouvy-api/actions/workflows/ci.yml)
44
[![Release](https://github.com/mikejhill/rouvy-api/actions/workflows/release.yml/badge.svg)](https://github.com/mikejhill/rouvy-api/actions/workflows/release.yml)
5-
[![License](https://img.shields.io/github/license/mikejhill/rouvy-api)](LICENSE)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
66

77
A pure Python client library for the Rouvy indoor cycling platform with a CLI tool and a native Home Assistant integration (HACS-compatible).
88

@@ -218,7 +218,7 @@ See `scripts/demo_parser.py` for comprehensive examples of parsing different end
218218
Comprehensive documentation and reference materials are in the `docs/` directory:
219219

220220
- [**docs/architecture/turbo-stream.md**](docs/architecture/turbo-stream.md) - Detailed explanation of the turbo-stream format discovery and implementation
221-
- [**docs/samples/**](docs/samples/) - Sample API responses for reference
221+
- [**docs/private-samples/**](docs/private-samples/) - Sample API responses for reference (git-ignored, local only)
222222

223223
## Logging
224224

docs/architecture/project-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ rouvy-api/
4242
│ │ ├── project-structure.md # This file
4343
│ │ └── turbo-stream.md # Turbo-stream format analysis
4444
│ ├── examples/ # Usage examples
45-
│ └── samples/ # Sample API responses for reference
45+
│ └── private-samples/ # Sample API responses (git-ignored, local only)
4646
4747
├── tests/ # Unit and integration tests
4848

tests/test_models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
extract_user_profile_model,
2020
)
2121

22-
SAMPLES_DIR = Path(__file__).resolve().parent.parent / "docs" / "samples"
22+
SAMPLES_DIR = Path(__file__).resolve().parent.parent / "docs" / "private-samples"
2323

2424

2525
def _has_samples() -> bool:

0 commit comments

Comments
 (0)