open/jobbsok
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity Actions

docs(port): name the download sites without linking them

Browse source 
The public-surface gate refuses any tracked file carrying a URL with a
path outside .example, and 21d7f5a shipped two: the python.org Windows
downloads page and the Git for Windows download. Both are now named as
bare domains for the tester to search for, which the scanner allows and
which does not rot when a vendor moves a page.

The gate found this and I did not, for a reason worth recording: 21d7f5a
was verified while the file was still UNTRACKED, and that scan reads
`git ls-files`. The suite was genuinely green -- of a tree that did not
yet contain the file. Verify after `git add`, not before, whenever a gate
is scoped to tracked files.

Also states the rule in the operator section, so the links are not
restored as a courtesy later.

Verify: .venv/bin/python -m pytest tests/ -> 223 passed, exit 0, with the
file tracked. Scanner denominator 113 files / 609427 bytes, 0 findings;
the byte count moved with the edit, so the file is inside the scan.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Kjell Tore Guttormsen 2026-09-06 07:21:07 +02:00
commit 9fa826c5ff
1 changed files with 16 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/windows-smoke-test.md
View file

@ -71,6 +71,13 @@ Two more things to settle before sending:
* **What you send.** The `.plugin` file, its SHA-256, and the build stamp. The
tester compares all three; Steps 7 and 9 depend on you providing them.
**Why Steps 1 and 3 name download sites without linking them.**
`tests/test_public_surface.py` refuses any tracked file carrying a URL with a
path outside `.example`, and this remote is public. A bare domain in prose is
not a finding; `https://<site>/<path>` is. So the two sites are named for the
tester to search for. Do not "helpfully" restore the links — the gate will fail
the commit, and it is right to.
---
## What you need before you start
@ -134,10 +141,11 @@ Other outcomes, and what to do:
* **`Python was not found; run without arguments to install from the Microsoft
Store...`** or the Microsoft Store opens — Python is not installed; what
answered was Windows' built-in shortcut. Install Python from
<https://www.python.org/downloads/windows/>, and **tick "Add python.exe to
PATH"** in the installer. Then close PowerShell, open a **new** PowerShell
window, and run the command again.
answered was Windows' built-in shortcut. Install Python from the official
site — search for `python.org`, open its **Downloads** section and take the
Windows installer — and **tick "Add python.exe to PATH"** in the installer.
Then close PowerShell, open a **new** PowerShell window, and run the command
again.
* **`Python 3.9.x` or lower** — stop and report. The tool server refuses to run
below 3.10 on purpose, so this is a real answer, not a mistake you made.
* **`python : The term 'python' is not recognized...`** — stop and report,
@ -169,9 +177,10 @@ git --version
**Expected:** a line like `git version 2.51.0.windows.1`.
If you get `git : The term 'git' is not recognized...`, install Git for Windows
from <https://git-scm.com/download/win>. The default answers in the installer
are fine. Then open a **new** PowerShell window and run the command again.
If you get `git : The term 'git' is not recognized...`, install Git for
Windows from the official site — search for `git-scm.com` and take the Windows
download. The default answers in the installer are fine. Then open a **new**
PowerShell window and run the command again.
Git is needed for one thing only: the next step fetches a security component
from a code host.