docs: the workflow names the forge, CI and the Test Farm as they are after the move #1145

Open
TrashPanda wants to merge 2 commits from TrashPanda/Longshot:docs/workflow-current-forge into main
Contributor

Type: docs · Risk: low · Tested on: Linux, game-free checks only · Needs: none

Why

A newcomer reading the workflow is told things that stopped being true at the move: AGENTS.md says there is no CI
(there is, and fork PRs wait for a label), workflow.md calls GitHub issues the record and leaves out the Test Farm,
CONTRIBUTING.md names a skill that doesn't exist, and the worklist's bare #N numbers are Hookshot's but now link to
unrelated Longshot items, while Hookshot's GitHub repository no longer opens at all.

What changed

The four pages now describe the forge, CI and the Test Farm as they are, and say where Hookshot's old numbers live.

  • AGENTS.md: "No CI" becomes what actually runs. Forgejo's pull requests run the light checks (title, description,
    workflow lint, guide screenshots, third-party); the Python suite and SPIR-V fixtures are a manual run of the CI
    workflow. CircleCI runs the path-selected game-free checks, and a fork waits for a maintainer's ci: approved
    label. Running tests/run_all.py before opening stays.
  • docs/workflow.md, Where work comes from: Longshot's issues on the forge are the record; Hookshot's issues are on
    the archived mirror with the same numbers; the Test Farm's comment and checks are a source; the CI row names both
    systems.
  • docs/worklist.md: the rows' bare #N are Hookshot's; a row someone touches links them by full URL on
    MagicBeanDev/Hookshot. The rows themselves are not re-scored here.
  • CONTRIBUTING.md: /magicbean:batch-review is /magicbean:review (Tooling's skill).

Measurements

Verdict: docs only, nothing to measure: the doc checks pass on main and with this PR.

Hardware: Ubuntu 26.04, Ryzen 7 9800X3D, 30 GB RAM, RTX 4070 Ti (not used: game-free checks)
Scene: none, no game run; the doc checks
Method: run_all.py doc once on main and once on this branch (deterministic, so one run each)
How to reproduce: python3 -I -B tests/run_all.py doc

Before: main @ 71b1edd8 After: this PR @ f9001d46
run_all.py doc (test_doc_anchors, test_linux_docker_packages) 2 passed 2 passed
2 passed, 0 failed, 0 skipped in 0 s (linux, 16 at once)

Flags and settings

None.

Testing

Tested: on Linux (Ubuntu 26.04): the doc checks above; every new link opens (the forge's issues, the Hookshot
mirror's issue 993 and PR 2843, beanstalk.magicbean.dev). The whole python -I -B tests/run_all.py has the same
result as on main on this PC: 16 checks fail on a clean main too (test_walk_key, test_lift_lookups,
test_make_game_cache and others; GCC 15 and Python 3.14 here, newer than CI's), none of them reads these pages.

Not tested: nothing the game runs changed.

Must be tested: None.

Risks

What could break: nothing the game runs.

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.
**Type:** docs · **Risk:** low · **Tested on:** Linux, game-free checks only · **Needs:** none ## Why A newcomer reading the workflow is told things that stopped being true at the move: AGENTS.md says there is no CI (there is, and fork PRs wait for a label), workflow.md calls GitHub issues the record and leaves out the Test Farm, CONTRIBUTING.md names a skill that doesn't exist, and the worklist's bare `#N` numbers are Hookshot's but now link to unrelated Longshot items, while Hookshot's GitHub repository no longer opens at all. ## What changed The four pages now describe the forge, CI and the Test Farm as they are, and say where Hookshot's old numbers live. - AGENTS.md: "No CI" becomes what actually runs. Forgejo's pull requests run the light checks (title, description, workflow lint, guide screenshots, third-party); the Python suite and SPIR-V fixtures are a manual run of the `CI` workflow. CircleCI runs the path-selected game-free checks, and a fork waits for a maintainer's `ci: approved` label. Running `tests/run_all.py` before opening stays. - docs/workflow.md, *Where work comes from*: Longshot's issues on the forge are the record; Hookshot's issues are on the archived mirror with the same numbers; the Test Farm's comment and checks are a source; the CI row names both systems. - docs/worklist.md: the rows' bare `#N` are Hookshot's; a row someone touches links them by full URL on `MagicBeanDev/Hookshot`. The rows themselves are not re-scored here. - CONTRIBUTING.md: `/magicbean:batch-review` is `/magicbean:review` (Tooling's skill). ## Measurements **Verdict:** docs only, nothing to measure: the doc checks pass on main and with this PR. Hardware: Ubuntu 26.04, Ryzen 7 9800X3D, 30 GB RAM, RTX 4070 Ti (not used: game-free checks) Scene: none, no game run; the doc checks Method: `run_all.py doc` once on main and once on this branch (deterministic, so one run each) How to reproduce: `python3 -I -B tests/run_all.py doc` | | Before: main @ 71b1edd8 | After: this PR @ f9001d46 | |---|---|---| | `run_all.py doc` (`test_doc_anchors`, `test_linux_docker_packages`) | 2 passed | 2 passed | ``` 2 passed, 0 failed, 0 skipped in 0 s (linux, 16 at once) ``` ### Flags and settings None. ## Testing **Tested:** on Linux (Ubuntu 26.04): the doc checks above; every new link opens (the forge's issues, the Hookshot mirror's issue 993 and PR 2843, beanstalk.magicbean.dev). The whole `python -I -B tests/run_all.py` has the same result as on main on this PC: 16 checks fail on a clean main too (`test_walk_key`, `test_lift_lookups`, `test_make_game_cache` and others; GCC 15 and Python 3.14 here, newer than CI's), none of them reads these pages. **Not tested:** nothing the game runs changed. **Must be tested:** None. ## Risks **What could break:** nothing the game runs. **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.
docs: the workflow names the forge, CI and the Test Farm as they are after the move
Some checks failed
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 8s
CI / Conventional Commit title (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been cancelled
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been cancelled
CI / Workflow lint (actionlint) (pull_request) Has been cancelled
Guide screenshots / Guide images and local UI source review (pull_request) Has been cancelled
Third-party parts / As their notes say (pull_request) Has been cancelled
Third-party parts / The same as upstream (pull_request) Has been cancelled
Website / Website on Cloudflare (pull_request) Has been cancelled
5c1e0a710c
Assisted-by: Claude
TrashPanda changed title from WIP: docs: the workflow names the forge, CI and the Test Farm as they are after the move to docs: the workflow names the forge, CI and the Test Farm as they are after the move 2026-11-16 15:12:01 +00:00
Member

Basic code-only review of 5c1e0a710c; informational feedback, with final approval left to another reviewer.

One small documentation correction: AGENTS.md:81–83 says Forgejo's CI and CircleCI run the game-free checks on every PR. In .forgejo/workflows/ci.yml:65,179, the Python suite and SPIR-V fixtures are restricted to workflow_dispatch; automatic Forgejo CI runs the light checks. CircleCI's same-repository PR workflow also selects suites by changed paths. The ci: approved label described in docs/ci.md authorizes CircleCI's fork pipeline, rather than all Forgejo checks.

Please distinguish those paths so a contributor does not interpret a green light-check result as evidence that the full suite ran. Suggested wording: “Forgejo runs light PR checks; CircleCI runs the applicable game-free checks. Forks need a maintainer's ci: approved label for CircleCI. Forgejo's full suites remain manually dispatched.” Keep the local run_all.py requirement as written.

The remaining changes consistently point newcomers to the current issue tracker, Test Farm and review skill. The author reports both documentation checks passing before and after, with pre-existing full-suite failures disclosed. This is documentation only; no game validation is needed for these edits.

No tests or builds run.

Basic code-only review of 5c1e0a710c0f90b9e17a77269cf8d5c4fbb94f04; informational feedback, with final approval left to another reviewer. One small documentation correction: `AGENTS.md:81–83` says Forgejo's `CI` and CircleCI run the game-free checks on every PR. In `.forgejo/workflows/ci.yml:65,179`, the Python suite and SPIR-V fixtures are restricted to `workflow_dispatch`; automatic Forgejo CI runs the light checks. CircleCI's same-repository PR workflow also selects suites by changed paths. The `ci: approved` label described in `docs/ci.md` authorizes CircleCI's fork pipeline, rather than all Forgejo checks. Please distinguish those paths so a contributor does not interpret a green light-check result as evidence that the full suite ran. Suggested wording: “Forgejo runs light PR checks; CircleCI runs the applicable game-free checks. Forks need a maintainer's `ci: approved` label for CircleCI. Forgejo's full suites remain manually dispatched.” Keep the local `run_all.py` requirement as written. The remaining changes consistently point newcomers to the current issue tracker, Test Farm and review skill. The author reports both documentation checks passing before and after, with pre-existing full-suite failures disclosed. This is documentation only; no game validation is needed for these edits. No tests or builds run.
docs: say which checks Forgejo and CircleCI actually run
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request) Blocked by required conditions
PR description / Description follows the template (pull_request_target) Successful in 11s
f9001d464d
Contributors were told both systems run the game-free suite on every pull request. Forgejo's Python suite and SPIR-V fixtures are manual; CircleCI selects suites by path, and a fork waits for ci: approved.

Assisted-by: Grok 4.7
Author
Contributor

The CI sentence in AGENTS.md was wrong, as the review said. On current main, Forgejo's automatic pull-request jobs are the light ones: the title, the description, workflow lint, guide screenshots and third-party. In .forgejo/workflows/ci.yml the Python suite and the SPIR-V fixtures run only on workflow_dispatch. CircleCI's gate runs the game-free checks the changed paths select (docs/ci.md); a fork waits for ci: approved before that runs.

AGENTS.md now says that, in f9001d46. python -I -B tests/run_all.py doc on that commit: 2 passed. The description's After column names f9001d46.

The branch is still based on main 71b1edd8, 19 commits behind current main df6180c3. This commit sits on the existing one; the history was not rewritten. Approval still needs another reviewer.

The CI sentence in AGENTS.md was wrong, as the review said. On current main, Forgejo's automatic pull-request jobs are the light ones: the title, the description, workflow lint, guide screenshots and third-party. In `.forgejo/workflows/ci.yml` the Python suite and the SPIR-V fixtures run only on `workflow_dispatch`. CircleCI's gate runs the game-free checks the changed paths select (docs/ci.md); a fork waits for `ci: approved` before that runs. AGENTS.md now says that, in f9001d46. `python -I -B tests/run_all.py doc` on that commit: 2 passed. The description's After column names f9001d46. The branch is still based on main 71b1edd8, 19 commits behind current main df6180c3. This commit sits on the existing one; the history was not rewritten. Approval still needs another reviewer.
Member

Follow-up on f9001d464d568f25d06e4250c41d2482f6a82322: the CI wording issue in my earlier note is resolved.

The change since that note is confined to the AGENTS.md paragraph. It now distinguishes Forgejo's light PR checks, CircleCI's applicable checks and fork label, and the manually dispatched Python/SPIR-V suites. I checked it against the workflow conditions and CircleCI routing at this head; the local run_all.py requirement remains intact. No further actionable finding in this documentation follow-up.

Read-only check; no tests or builds run. The author reports the two documentation checks passing at this head; I have not independently reproduced them.

This is an ordinary follow-up note, not an approval; final review remains with another reviewer.

Follow-up on `f9001d464d568f25d06e4250c41d2482f6a82322`: the CI wording issue in [my earlier note](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1145#issuecomment-38128) is resolved. The change since that note is confined to the `AGENTS.md` paragraph. It now distinguishes Forgejo's light PR checks, CircleCI's applicable checks and fork label, and the manually dispatched Python/SPIR-V suites. I checked it against the workflow conditions and CircleCI routing at this head; the local `run_all.py` requirement remains intact. No further actionable finding in this documentation follow-up. Read-only check; no tests or builds run. The author reports the two documentation checks passing at this head; I have not independently reproduced them. This is an ordinary follow-up note, not an approval; final review remains with another reviewer.
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request) Blocked by required conditions
PR description / Description follows the template (pull_request_target) Successful in 11s
This pull request doesn't have enough approvals yet. 0 of 1 approvals granted.
Some workflows are waiting to be reviewed.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'docs/workflow-current-forge:TrashPanda-docs/workflow-current-forge'
git switch 'TrashPanda-docs/workflow-current-forge'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/Longshot!1145
No description provided.