Final review — docs consistency + npm run check/test green #121

New issue

Closed

opened 2026-08-29 03:29:32 +00:00 by david · 1 comment

david commented

2026-08-29 03:29:32 +00:00

Owner

Summary

Final consistency pass: verify README (#119), DESIGN (#120), and IMPLEMENTATION_PLAN describe the shipped behavior identically, and that npm run check + npm test are green. No docs changes before this point are permitted per the plan — this is the last verification step before the PR.

Background

Part of the Forgejo Actions tooling feature (tracking issue #111). Phase 8.3 of the plan: "README + DESIGN + IMPLEMENTATION_PLAN consistent with shipped behavior; npm run check + npm test green". Runs after both docs steps complete.

Implementation Details

Read extensions/forgejo/README.md, extensions/forgejo/docs/DESIGN.md, and extensions/forgejo/docs/IMPLEMENTATION_PLAN.md and diff their claims against the actual src/actions.ts, src/actionsCache.ts, src/index.ts registrations, and package.json.
Check: tool names/params, cache semantics, v16 baseline + v17 out-of-scope statements, token scope (read:repository), endpoint paths.
Run cd extensions/forgejo && npm run check && npm test.
Fix any doc drift found (small edits) so the three docs agree with the code.

Acceptance Criteria

No contradictions between README, DESIGN, IMPLEMENTATION_PLAN and the shipped code (tool list, params, cache behavior, version notes).
npm run check passes.
npm test passes (full suite green).

Test Plan

Run the two commands above and report output.
Manually eyeball the three docs against grep -n "forgejo_action" src/index.ts.

### Summary Final consistency pass: verify README (**#119**), DESIGN (**#120**), and IMPLEMENTATION_PLAN describe the shipped behavior identically, and that `npm run check` + `npm test` are green. No docs changes before this point are permitted per the plan — this is the last verification step before the PR. ### Background Part of the Forgejo Actions tooling feature (tracking issue **#111**). Phase 8.3 of the plan: "README + DESIGN + IMPLEMENTATION_PLAN consistent with shipped behavior; `npm run check` + `npm test` green". Runs after both docs steps complete. ### Implementation Details - Read `extensions/forgejo/README.md`, `extensions/forgejo/docs/DESIGN.md`, and `extensions/forgejo/docs/IMPLEMENTATION_PLAN.md` and diff their claims against the actual `src/actions.ts`, `src/actionsCache.ts`, `src/index.ts` registrations, and `package.json`. - Check: tool names/params, cache semantics, v16 baseline + v17 out-of-scope statements, token scope (`read:repository`), endpoint paths. - Run `cd extensions/forgejo && npm run check && npm test`. - Fix any doc drift found (small edits) so the three docs agree with the code. ### Acceptance Criteria - [ ] No contradictions between README, DESIGN, IMPLEMENTATION_PLAN and the shipped code (tool list, params, cache behavior, version notes). - [ ] `npm run check` passes. - [ ] `npm test` passes (full suite green). ### Test Plan - Run the two commands above and report output. - Manually eyeball the three docs against `grep -n "forgejo_action" src/index.ts`.

david added this to the M7 - Actions documentation (last step) milestone

2026-08-29 03:29:32 +00:00

david added the

chore

label

2026-08-29 03:29:32 +00:00

david referenced this issue

2026-08-29 03:29:42 +00:00

Open PR — issue-111: add forgejo actions tools #122

david referenced this issue

2026-09-18 06:31:54 +00:00

chore: fix forgejo docs drift against shipped tool schemas #279

david commented

2026-09-18 06:32:50 +00:00

Author

Owner

Final consistency pass complete — all acceptance criteria met:

Docs vs code: README, DESIGN, and IMPLEMENTATION_PLAN now agree with the shipped tool schemas in src/index.ts (37 tools: 20 issues + 11 PRs + 1 detect + 5 actions). Drift found and fixed in PR #279 (squash-merged): DESIGN.md phantom ref/draft?/q?/head? params removed, merge-method list completed to all 6 strategies, PR-search API filter corrected to base_branch; IMPLEMENTATION_PLAN.md Phases 3.1/3.8 aligned.
npm run check: pass (tsc --noEmit)
npm test: 259/259 pass (11 suites)

Closing — the Forgejo Actions tooling feature (#111) Phase 8.3 is done.

Final consistency pass complete — all acceptance criteria met: - **Docs vs code**: README, DESIGN, and IMPLEMENTATION_PLAN now agree with the shipped tool schemas in `src/index.ts` (37 tools: 20 issues + 11 PRs + 1 detect + 5 actions). Drift found and fixed in [PR #279](https://git.excelera.net/david/pi-extensions-and-skills/pulls/279) (squash-merged): DESIGN.md phantom `ref`/`draft?`/`q?`/`head?` params removed, merge-method list completed to all 6 strategies, PR-search API filter corrected to `base_branch`; IMPLEMENTATION_PLAN.md Phases 3.1/3.8 aligned. - **`npm run check`**: pass (tsc --noEmit) - **`npm test`**: 259/259 pass (11 suites) Closing — the Forgejo Actions tooling feature (#111) Phase 8.3 is done.

david closed this issue

2026-09-18 06:32:53 +00:00

david referenced this issue

2026-09-18 06:44:46 +00:00

Open PR — issue-111: add forgejo actions tools #122