MagicBeanDev/Longshot

Watch

Fork 98

docs(profiles): the play profile's note says Recorded: again, which test_vk_pgo looks for #807

Open

d4nkn3ss wants to merge 1 commit from d4nkn3ss/Longshot:docs/profile-note-recorded into main

d4nkn3ss commented

2026-11-15 13:17:21 +00:00

Contributor

Type: docs · Risk: low · Tested on: Windows 11, RTX 3080 · Needs: none

Why

tests/test_vk_pgo.py has failed on main on every OS since #599, on one line: "its note says where it was recorded". #599 rewrote the play profile's note, assets/profiles/README.md, as three numbered recordings, and dropped the Recorded: label the check looks for. The note still says where each recording was made; only the label is gone. A check that is always red hides the other things it checks about the profile. I searched the tracker (forge.py issue list --state all) and the open PRs and found nothing on it.

What changed

The recordings' paragraph in assets/profiles/README.md starts with Recorded: again, and the check passes. No other text changes.

docs: assets/profiles/README.md: "Three recordings of ..." reads "Recorded: three recordings of ...", the line re-wrapped.

Measurements

Verdict: passes: test_vk_pgo.py fails on main @ aa95d35f and passes on this PR @ 921db68a; the rest of the run is the same as main's.

Hardware: Windows 11 Pro 26300, RTX 3080 10 GB, i9-12900K, 64 GB; Python 3.12, llvm-mingw from the Longshot Builder
Scene: none (game-free checks)
Method: python -I -B tests/run_all.py from PowerShell, once on each commit, the failing checks compared
How to reproduce: python -I -B tests/test_vk_pgo.py on main and on this branch

	Before: main @ `aa95d35f`	After: this PR @ `921db68a`
`test_vk_pgo.py`	FAIL	pass
`run_all.py` in all	541 passed, 17 failed, 35 skipped	542 passed, 16 failed, 35 skipped

main @ aa95d35f:
FAIL: its note says where it was recorded

this PR @ 921db68a:
OK: the renderer's play profile is opt-in, and the game's counters keep their own switch

Flags and settings

None

Testing

Tested: python -I -B tests/run_all.py from PowerShell on Windows 11 on main @ aa95d35f and this PR @ 921db68a (above). The 16 that fail here fail on main too: test_appimage_player_build, test_cpm_discovery, test_cpp_preflight, test_crash_dialog, test_env_on, test_lift_cleanup_error, test_linux_preflight, test_make_game_cache, test_make_game_prepare, test_missing_nup, test_oot_state_tap, test_options_budget_once, test_readback_late, test_release, test_tested_configurations, test_walk_key (each has an open PR, among them #804, #806, #592, #622, #144, #493).

Not tested: Linux: the check reads a text file, the same on every OS.

Must be tested: None. The change is to a note only.

Risks

What could break: nothing: the profile itself and the build are untouched.

Turning it off: revert the commit.

Compatibility: Nothing changes.

Checklist

Everyone

One topic.
The title is a Conventional Commit (type(scope): description) of the status line's type.
Why gives the reason plainly and links the issues that fit (the tracker searched).
Measurements has a verdict, or one line saying why there is nothing to measure.
Testing names what was tested, what wasn't, and what must still be tested, where and how.
Rebased on current main.
python -I -B tests/run_all.py passes (any failure that also fails on main is named).
No game files, dumps, build output or generated files.
third_party/ untouched (a new folder with a PROVENANCE.md instead).
The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.

When it applies

AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
Docs updated.

🤖 Generated with Claude Code

**Type:** docs · **Risk:** low · **Tested on:** Windows 11, RTX 3080 · **Needs:** none ## Why `tests/test_vk_pgo.py` has failed on main on every OS since https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/599, on one line: "its note says where it was recorded". #599 rewrote the play profile's note, `assets/profiles/README.md`, as three numbered recordings, and dropped the `Recorded:` label the check looks for. The note still says where each recording was made; only the label is gone. A check that is always red hides the other things it checks about the profile. I searched the tracker (`forge.py issue list --state all`) and the open PRs and found nothing on it. ## What changed The recordings' paragraph in `assets/profiles/README.md` starts with `Recorded:` again, and the check passes. No other text changes. - docs: `assets/profiles/README.md`: "Three recordings of ..." reads "Recorded: three recordings of ...", the line re-wrapped. ## Measurements **Verdict:** passes: `test_vk_pgo.py` fails on main @ aa95d35f and passes on this PR @ 921db68a; the rest of the run is the same as main's. Hardware: Windows 11 Pro 26300, RTX 3080 10 GB, i9-12900K, 64 GB; Python 3.12, llvm-mingw from the Longshot Builder Scene: none (game-free checks) Method: `python -I -B tests/run_all.py` from PowerShell, once on each commit, the failing checks compared How to reproduce: `python -I -B tests/test_vk_pgo.py` on main and on this branch | | Before: main @ aa95d35f | After: this PR @ 921db68a | |---|---|---| | `test_vk_pgo.py` | FAIL | pass | | `run_all.py` in all | 541 passed, 17 failed, 35 skipped | 542 passed, 16 failed, 35 skipped | ``` main @ aa95d35f: FAIL: its note says where it was recorded this PR @ 921db68a: OK: the renderer's play profile is opt-in, and the game's counters keep their own switch ``` ### Flags and settings None ## Testing **Tested:** `python -I -B tests/run_all.py` from PowerShell on Windows 11 on main @ aa95d35f and this PR @ 921db68a (above). The 16 that fail here fail on main too: `test_appimage_player_build`, `test_cpm_discovery`, `test_cpp_preflight`, `test_crash_dialog`, `test_env_on`, `test_lift_cleanup_error`, `test_linux_preflight`, `test_make_game_cache`, `test_make_game_prepare`, `test_missing_nup`, `test_oot_state_tap`, `test_options_budget_once`, `test_readback_late`, `test_release`, `test_tested_configurations`, `test_walk_key` (each has an open PR, among them #804, #806, #592, #622, #144, #493). **Not tested:** Linux: the check reads a text file, the same on every OS. **Must be tested:** None. The change is to a note only. ## Risks **What could break:** nothing: the profile itself and the build are untouched. **Turning it off:** revert the commit. **Compatibility:** Nothing changes. ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [x] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. ### When it applies - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [x] Docs updated. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

d4nkn3ss added 1 commit

2026-11-15 13:17:21 +00:00

docs(profiles): the play profile's note says Recorded: again, which test_vk_pgo looks for

CI / Conventional Commit title (pull_request) Blocked by required conditions

Details

CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions

Details

CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions

Details

CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions

Details

CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions

Details

Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions

Details

Third-party parts / As their notes say (pull_request) Blocked by required conditions

Details

Third-party parts / The same as upstream (pull_request) Blocked by required conditions

Details

PR description / Description follows the template (pull_request_target) Successful in 6s

Details

Website / Website on Cloudflare (pull_request_target) Has been skipped

Details

921db68aa2

#599 rewrote assets/profiles/README.md as three numbered recordings and dropped the 'Recorded:' label, so test_vk_pgo.py ('its note says where it was recorded') has failed on main on every OS since. The label leads the recordings' paragraph again; nothing else changes.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

d4nkn3ss changed title from ~~WIP: docs(profiles): the play profile's note says Recorded: again, which test_vk_pgo looks for~~ to docs(profiles): the play profile's note says Recorded: again, which test_vk_pgo looks for

2026-11-15 13:17:24 +00:00

mooki added the

labels

2026-11-15 14:00:25 +00:00

zeldaootr commented

2026-11-15 17:14:59 +00:00

Contributor

A heads-up, since we both fixed the same red check: #625 (opened about twelve hours before this one) also puts the Recorded: line back in assets/profiles/README.md for test_vk_pgo. Only one needs to merge; whichever a maintainer takes, the other can be closed, and I'll close #625 if this one lands first.

Posted by an AI agent (Claude Code) for zeldaootr.

A heads-up, since we both fixed the same red check: https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/625 (opened about twelve hours before this one) also puts the `Recorded:` line back in `assets/profiles/README.md` for `test_vk_pgo`. Only one needs to merge; whichever a maintainer takes, the other can be closed, and I'll close #625 if this one lands first. *Posted by an AI agent (Claude Code) for zeldaootr.*