Repository navigation
Conversation
jek
added this pull request to stack #8969
October 21, 2026 00:00
jek
changed the title
app security results as JSON
jek
force-pushed
the
app-security/support-json-schema-agent-review
branch
from
October 21, 2026 00:46
753568a to
1a0504c
Compare
The coding-agent instructions now run `check`, `record`, `review` and `clean` with `--json --no-input`, and name the result fields to read. `review`'s terminal boxes wrap long paths and commands, so agents had to rejoin them; its JSON result has every finding in full, with absolute paths and one-based lines and columns as recorded. A rejected `record` document is an error with the code `findings-document-rejected` and every error in `details.errors`. `--no-input` keeps an agent with a terminal from stopping at the instructions prompt after `check`. The flags are added where the instructions format the commands, so in every shell they're on the command line itself, ahead of `record`'s heredoc or redirection, and the next steps that the commands print don't change. The deterministic-only scan is still read from its terminal report, because `check --json` has no findings.
jek
force-pushed
the
app-security/support-json-schema-agent-review
branch
from
October 21, 2026 01:11
1a0504c to
3544095
Compare
Contributor
Author
|
/snapit |
Contributor
|
🫰✨ Thanks @jek! Your snapshot has been published to npm. Built from Test the snapshot by installing your package globally: pnpm i -g --@shopify:registry=https://registry.npmjs.org @shopify/cli@0.0.0-snapshot-20261021133901Caution After installing, validate the version by running |
jek
marked this pull request as ready for review
October 21, 2026 13:58
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
The coding-agent instructions have agents read
review's terminal boxes and rejoin wrapped lines, and readrecordrejections from a box. With typed JSON output available from every app security command (earlier in this stack), agents can read results directly.WHAT is this pull request doing?
Updates the agent workflow in
INSTRUCTIONS.mdand the commands it prints:check,record,reviewandcleancommands pass--json --no-input. Each prints one JSON object on stdout, and nothing waits for input. The flags are added only in the instructions, so the commands' own next steps don't change.findings-document-rejected, and thatdetails.errorslists every error.review --jsonfields to report from:checks[].findings,disposition,docsUrl,coverage,resultsFilesandscopeDiffers. Lines and columns are one-based, as recorded.checkcommand:check --jsonhas no findings.Patch changeset, since the agent-facing content changes.
How to manually test your changes?
Build once and run the local CLI directly, so nothing else reaches stdout:
The workflow's commands include
--json --no-input; the deterministic-only command doesn't. Follow the printed steps with a coding agent, or by hand, and check that each command runs as printed and thatreview --json --no-inputhas the fields that step 6 names.Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset withpnpm changeset add