docs: add trigger-e2e directory and export-fact-catalog hidden command#1511
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs: add trigger-e2e directory and export-fact-catalog hidden command#1511github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
- Add trigger-e2e/ to AGENTS.md architecture tree (was missing alongside executor-e2e/) - Document export-fact-catalog hidden build-time command in docs/cli.md (parallel to export-gate-schema; generates fact-catalog.gen.json for the FACT_META drift guard in trigger-e2e) - Update docs/ado-script.md to document both export-gate-schema and export-fact-catalog alongside codegen explanation - Update AGENTS.md docs index to mention both hidden commands Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
Agent Documentation Update
Findings
trigger-e2e/directory present inscripts/ado-script/src/but absent from AGENTS.md architecture treeAGENTS.mdexport-fact-cataloghidden CLI command not documented anywhere (onlyexport-gate-schemawas listed)docs/cli.md,docs/ado-script.md,AGENTS.mdApplied Fixes
trigger-e2e/entry to the AGENTS.md architecture tree (afterexecutor-e2e/, where it belongs), with a description matching the file's JSDoc and theFACT_METAdrift-guard testexport-fact-catalogto the "Hidden Build-Time Tools" section indocs/cli.mdwith flag reference and usage exampledocs/ado-script.mdcodegen section to document bothexport-gate-schemaandexport-fact-catalog, linking back todocs/cli.mdfor the full option referencedocs/cli.mdto name both hidden commandsNotes
Verified against code:
trigger-e2e/exists atscripts/ado-script/src/trigger-e2e/withgate-spec.ts+__tests__/gate-spec.test.ts; the test file referencesfact-catalog.gen.jsonandFACT_METAdrift guard as describedExportFactCatalogvariant insrc/main.rs(line 581) is#[command(hide = true)]— same pattern asExportGateSchema— and callscompile::filter_ir::generate_fact_catalog()--output, -o <path>flag patternCreated by the agent-documentation maintainer workflow.