refactor(dev): docs, tools and process revamp: one dev.py, dev.py ab, one dev folder, a short PR template, faster dev builds #1802
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1802
Loading…
Reference in a new issue
No description provided.
Delete branch "HumanBean/Longshot:refactor/dev-revamp"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
A revamp of the developer docs, tools and process, so development is simpler and faster. Nothing a player sees changes,
apart from the run name now also showing on the start-up screen of a development run.
docs/dev/(setup, developing, standards, per-area reference pages, CI). README is a landing page withfeatures and current goals; the player guide in
docs/user/takes its content (one requirements page, an advancedsetup page, the settings table the website builds from).
docs/old/, the tested-configurations catalogue and thein-repo worklist are gone (work is picked from the open issues by the triage bot's labels). AGENTS.md, CONTRIBUTING.md
and RELEASING.md are short.
review and Ready to merge) and a checker for the rules that matter (807 → ~480 lines); the three skills follow it.
nx2/tools,shadertool,VULKAN.md, committed MSBuildoutput.
scripts/dev.py: one flat command set (base,pack,rt,game,vk,env,bases,queue,paths,migrate,ab);dev.py packsstays the Test Farm's folder-level layer with the same command lines.~/.local/share/longshot-dev,%LOCALAPPDATA%\longshot-dev) apart from theplayer's;
dev.py migratemoves an existing setup.dev.py ab: one command for a correct A/B (skips the title, loads the scene, warms up, interleaves the runs in thequeue in timing mode, refuses when the sides differ, writes the Measurements section).
dev.py queue run --desc "<what it tests>": the run's name shows under the version in the menu and on the start-upscreen.
scripts/longshot_bridge.py); the tour is split (scripts/tours/);profiling has one data flow; one
scripts/helpers.pyfor downloads, hashes, archives;release.pycomes fromTooling at the commit in
.tooling-rev.mise run setupdoes the whole setup (Tooling, hooks, deps, plugin check, toolchain check);mise run ciruns whatCI runs;
mise run test-changed; ruff in lint.dev.pyworks in jj workspaces.nothing; the version lives in two tiny files so a version change doesn't recompile the menu; game-only packs skip the
renderer; packs keep unchanged outputs; runtimes are cloned and
rtrefreshes in place; the Windows header stamp is bycontent. #1792's romfs-in-place is ported onto the new devtools.
mechanically).
Testing
Tested: not run in the game, and no tests run on this PC (the maintainer asked to open it without a game run).
Static checks only: every changed Python file compiles,
--helpof every changed tool,bash -n,actionlint, a linkand anchor check over all docs (none broken; every
// doc:anchor resolves), and two cold reviews by agents that didnot write the code, whose findings are fixed. The first real check is CI.
Still to test:
run_all, the website build), by CI.host/version.candgpu/vk/vk_version.cpp, the start-up screen's run name, the comments-only sweep compiles), by hand.dev.py ab --env HOS_COLLECT_WIDE=0 --runs 1 --seconds 20 --scene kokiri-houseon a runtime, expecting a write-up, byhand.
dev.py migrate --dry-run, thendev.py migrateon a PC with the old layout, expecting everything moved and linksleft, by hand.
dev.py packs(@Beanstalk, after Beanstalk'schange below is deployed).
Measurements
Nothing to measure: docs, dev tools and comments; the game's code is unchanged apart from the version's file and the
start-up screen's name line.
Risks
dev.py packsin place ofscripts/dev_packs.py;scripts/dev.py,scripts/devtools/,scripts/helpers.pyneed two approvers) must be deployed first, or the Test Farm breaks.Tooling's change (forge.py for the new template, the shared
release.py) lands together with this one, and.tooling-revgets its commit (a placeholder now: release jobs fail at checkout until it is set).job_queue.py,dev_build.py,dev_packs.py,dev.py build ...) are gone; existing dev PCs runpython -I scripts/dev.py migrateonce while the queue is empty.Checklist
Ready for review
main, or one line saying why there is nothing to measure.main.When it applies
Co-Authored-By:trailers.tests/that reads changed source updated in this PR, not weakened.Ready to merge
mainwith no conflicts.🤖 Generated with Claude Code
d7cc51f4d775fbfb8e00WIP: refactor(dev): docs, tools and process revamp: one dev.py, dev.py ab, one dev folder, a short PR template, faster dev buildsto refactor(dev): docs, tools and process revamp: one dev.py, dev.py ab, one dev folder, a short PR template, faster dev buildsmooki referenced this pull request2026-11-20 01:45:34 +00:00
omgitsgela referenced this pull request2026-11-20 08:59:32 +00:00
omgitsgela referenced this pull request2026-11-20 09:05:49 +00:00