Skip to content

Review follow-ups: scrub share snippets, sync guard, a11y polish - #3

Merged
iamitp merged 2 commits into
mainfrom
followup-review-fixes
Apr 17, 2026
Merged

iamitp merged 2 commits into
mainfrom
followup-review-fixes

Conversation

@iamitp

@iamitp iamitp commented Apr 17, 2026

Copy link
Copy Markdown
Owner

Summary

Retrospective fixes from the review of PR #1 + PR #2.

Code

  • build_share_snippet now scrubs /Users/... + /home/... paths and inline ISO timestamps from the audit body; docstring rewritten to match behaviour.
  • Share snippet renders through rich.Markdown in the CLI, matching the main audit output.
  • Three new tests: path scrubbing, timestamp scrubbing, and a CliRunner smoke test for vera audit --share. All 24 tests pass; wheel + sdist still pass twine check.

CI guard

  • New .github/scripts/check_prompt_sync.py diffs the fenced block of PROMPT.md against the const PROMPT = \…`literal indocs/index.htmland fails on drift. **Wiring intoci.ymlis a follow-up commit** — this token lacks theworkflow` scope, so the job add needs to be pushed manually (see below).

Landing page (docs/index.html)

  • rel="noopener" → rel="noopener noreferrer" on all external links.
  • Inline SVG favicon (data URI).
  • Visually hidden <span role="status" aria-live="polite"> wired to the copy flow so screen readers announce success/failure.

Shell (launch/ship.sh)

  • Drops pip install --user when running inside a venv (detects VIRTUAL_ENV or sys.prefix != sys.base_prefix).

Docs (examples/README.md)

  • Notes audit.share.md is a one-time snapshot.

Pending local commit

ci.yml additions (concurrency group + prompt-sync job wiring the script above) are stashed locally. To land them:

```
git checkout followup-review-fixes
gh auth refresh -s workflow
git stash pop
git add .github/workflows/ci.yml
git commit -m "CI: concurrency + prompt-sync job"
git push
```

Test plan

  • `pytest -q` — 24/24 pass
  • `python -m build && twine check dist/*` — PASSED on wheel + sdist
  • `python .github/scripts/check_prompt_sync.py` — in sync
  • Verify aria-live announcement in VoiceOver on the live Pages site after merge

🤖 Generated with Claude Code

iamitp added 2 commits April 17, 2026 16:48
Code
- build_share_snippet now scrubs /Users and /home paths and inline ISO
  timestamps from the audit body; docstring rewritten to match.
- Share snippet renders through rich.Markdown in the CLI, matching the
  main audit output.
- Three new tests: path scrubbing, timestamp scrubbing, and a CliRunner
  smoke test for `vera audit --share`.

CI
- New .github/scripts/check_prompt_sync.py: diffs PROMPT.md's fenced
  block against the const PROMPT literal in docs/index.html. Wire into
  CI in a follow-up commit.

Landing page
- rel="noopener" -> rel="noopener noreferrer" on all external links.
- Inline SVG favicon (data URI, no asset file).
- Visually hidden role="status" aria-live node wired to the copy flow
  so screen readers announce copy success/failure.

Shell
- launch/ship.sh now drops `pip install --user` when inside a venv.

Docs
- examples/README notes audit.share.md is a one-time snapshot.
- cancel-in-progress on same ref so successive pushes don't queue duplicate runs
- new prompt-sync job runs .github/scripts/check_prompt_sync.py, failing CI
  if PROMPT.md diverges from the embedded literal in docs/index.html
@iamitp
iamitp merged commit bd0038a into main Apr 17, 2026
5 checks passed
@iamitp
iamitp deleted the followup-review-fixes branch April 17, 2026 11:30
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.

1 participant