Skip to content

fix: verify the release README with portable repository paths #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
logohere merged 1 commit into from
Nov 1, 2026
Merged

fix: verify the release README with portable repository paths #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 7 additions & 14 deletions readme-map.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,13 @@
{
"files": [
{
"path": "/Users/dico/collar/README.md",
"mustContain": ["https://github.com/specdog/dotdog", "https://github.com/specdog/dogbench", "https://github.com/specdog"]
},
{
"path": "/Users/dico/dotdog/README.md",
"mustContain": ["https://github.com/specdog/collar", "https://github.com/specdog/dogbench", "https://github.com/specdog"]
},
{
"path": "/Users/dico/dogbench/README.md",
"mustContain": ["specdog.github.io/dogbench", "Collar", "dotdog"]
},
{
"path": "/Users/dico/projects/leash/README.md",
"mustContain": ["specdog", "Collar", "dogbench", "dotdog"]
"path": "README.md",
"mustContain": [
"https://github.com/specdog/dotdog/releases/tag/v1.0.0",
"https://specdog.github.io/dotdog/v1-migration",
"npx dotdog@1.0.0 refresh --json",
"bunx --bun dotdog@1.0.0 refresh --json"
]
}
]
}
4 changes: 2 additions & 2 deletions scripts/check-readmes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ def main() -> int:
data = json.loads(MANIFEST.read_text())
issues = []
for item in data["files"]:
p = Path(item["path"])
p = (ROOT / item["path"]).resolve()
try:
p.relative_to(ROOT)
except ValueError:
print(f"README CHECK SKIP external path: {p}")
issues.append("README path must stay within this repository")
continue
if not p.exists():
issues.append(f"missing file: {p}")
Expand Down
Loading