Skip to content

chore: AGENTS.md pipeline contract and npm run verify - #95

Merged
Birfy merged 1 commit into
mainfrom
chore/agents-md-verify
Oct 15, 2026
Merged

Birfy merged 1 commit into
mainfrom
chore/agents-md-verify

Conversation

@Birfy

@Birfy Birfy commented Oct 15, 2026

Copy link
Copy Markdown
Collaborator

What

  • AGENTS.md rewritten toward a short pointer style:
    • Pipeline contract: issue -> branch -> PR (Fixes #N) -> CI tests-ok -> auto-merge (squash only), with the existing rules kept (review PASS on the tip; maintainer delegates the merge; stop conditions).
    • Conflict recipe for generated files: take main's patches/ds-bot, rebuild client.js, node scripts/ds-bot-patches.mjs generate + check.
    • Node 22+ requirement stated up front (Node 20 fails with "Could not find test/*.test.js").
    • Removed the nonexistent app/ references (two places).
  • npm run verify (new repo-root package.json, private, no dependencies, engines.node >=22): core lint (oxlint + arch-docs), plugin lint, build-client.mjs --check, ds-bot-patches.mjs check, core suite, plugins/social and plugins/tree suites. Same order as CI's flybot-tests action plus the patches check from the package job. It does not run pack check, typecheck, actionlint or smoke tests.

Why a root package.json instead of core/package.json: core/ is generated from ds-bot/ + patches, so editing core/package.json means regenerating patch 0007 (a conflict hotspot). The root file touches no shipped package, no lockfile, and dependabot only watches /core.

Verified

Node 24.21: npm run verify exits 0 (core 674/674, social 68/68, tree 54/54, 0 skipped; lint, --check, patches check, arch-docs OK).

Docs-only change plus one helper file; no core/ or patches/ change, so no patch regeneration and no subsystem doc needed (arch-docs OK).

AGENTS.md becomes a short pipeline contract (issue -> branch -> PR -> CI
tests-ok -> squash auto-merge), a conflict recipe for generated patches,
and the Node 22+ requirement. The nonexistent app/ directory is removed.
A repo-root package.json adds npm run verify, which runs what CI runs.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-15T14:28:27.909168Z f6262d1 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@Birfy
Birfy merged commit 755a6c5 into main Oct 15, 2026
5 checks passed
@Birfy
Birfy deleted the chore/agents-md-verify branch October 15, 2026 14:28

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f6262d18ec

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread AGENTS.md
git fetch origin && git merge origin/main # or rebase
# 1. Resolve conflicts in real sources by hand (core/src/**, core/index.js, tests, docs).
# 2. Take main's version of the generated patch files:
git checkout origin/main -- patches/ds-bot

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep hand-authored topic mappings during conflict resolution

When a branch adds or changes a topic mapping, this command replaces the entire patches/ds-bot directory with origin/main, including the hand-authored topics.json and README.md, thereby silently discarding the branch side before regeneration. A newly mapped file then makes generate fail as unmapped, while a moved mapping can regenerate into the wrong patch; restrict the checkout to generated *.patch files and merge topics.json as instructed below.

AGENTS.md reference: AGENTS.md:L27-L29

Useful? React with 👍 / 👎.

Comment thread package.json
"node": ">=22"
},
"scripts": {
"verify": "npm --prefix core run lint && node scripts/lint-plugins.mjs && node core/scripts/build-client.mjs --check && node scripts/ds-bot-patches.mjs check && npm --prefix core test && npm --prefix plugins/social test && npm --prefix plugins/tree test"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Fail verification when plugin tests are skipped

When either plugin suite skips a test, Node's test runner still exits successfully, so these plain npm test invocations let local npm run verify pass. The PR workflow explicitly parses each plugin's summary and fails unless the skipped count is zero (.github/workflows/test.yml:72-81), meaning this advertised local gate can report completion while required tests-ok later fails; preserve that no-skips check in the helper.

AGENTS.md reference: AGENTS.md:L74-L76

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant