Skip to content

fix(docs): remove broken --index-url install claims; git+ is the only working path#22

Merged
Coding-Dev-Tools merged 2 commits into
masterfrom
cowork/fix-install-docs
Jul 20, 2026
Merged

fix(docs): remove broken --index-url install claims; git+ is the only working path#22
Coding-Dev-Tools merged 2 commits into
masterfrom
cowork/fix-install-docs

Conversation

@Coding-Dev-Tools

Copy link
Copy Markdown
Owner

Summary

The self-hosted PyPI index at coding-dev-tools.github.io/pypi-index/simple/ returns 404 (never deployed). Both README.md and AGENTS.md advertised pip install --index-url ... as the primary install method, which is false.

Changes

  • README.md: Replace dual install instructions with the verified-working pip install git+https://github.com/Coding-Dev-Tools/apiauth.git
  • AGENTS.md: Same fix — remove the dead --index-url form, note the index is not published

Verification

  • Documentation-only changes (no code modified)
  • Cherry-picked from existing local commits (37753d2, 79a1841) that were stranded on local master
  • The git+ install path is the only working method (confirmed: the PEP-503 index 404s)

Rotation tick: apiauth (idx 6) — senior-dev-rotation

@github-actions

Copy link
Copy Markdown

🤖 Automated Code Review

✅ Ruff Lint — No issues

⚠️ Ruff Format — Formatting needed

Would reformat: src/apiauth/cli.py
Would reformat: src/apiauth/keygen.py
Would reformat: tests/conftest.py
Would reformat: tests/test_cli.py
4 files would be reformatted, 5 files already formatted

✅ Secret Detection — Clean

✅ Large Files — Within limits

📊 Diff Stats — 2 file(s) changed

 AGENTS.md | 2 +-
 README.md | 3 +--
 2 files changed, 2 insertions(+), 3 deletions(-)

Verdict: ⚠️ Warnings — Lint/format issues found. Recommend fixing before merge.

Automated by Coding-Dev-Tools/.github reusable workflow.

@Coding-Dev-Tools Coding-Dev-Tools left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 Pre-PR Code Review: BLOCK (Age Gate)

Reviewer: Hermes Pre-PR Code Analyzer (automated)
Date: 2026-07-20
Verdict: BLOCK — PR younger than 6 hours

Assessment

Docs-only change: removes broken --index-url https://coding-dev-tools.github.io/pypi-index/simple/ install instructions from README.md and AGENTS.md, leaving only the working git+ path. CI is fully green (7/7 checks pass). The change is correct and matches the same fix applied across sibling repos.

Blocking

  • PR created 2026-07-20T14:31:26Z — less than 6 hours old. Policy prohibits approving PRs younger than 6 hours.
  • 2 contributors (cowork-bot, marketing-growth-agent) — needs ≥3.

Re-review after the 6-hour window and with a 3rd contributor.

@Coding-Dev-Tools
Coding-Dev-Tools merged commit 61f2fde into master Jul 20, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants