docs: expand trigger configuration in README with on.pr and on.pipeline examples#1506
Merged
jamesadevine merged 1 commit intoJul 15, 2026
Merged
Conversation
…ne examples The README's former 'Schedule Syntax' section only covered schedule expressions. Users building PR-reviewing agents had no README-level guidance for on.pr or on.pipeline triggers — they had to find the agent-facing front-matter.md instead. Changes: - Rename 'Schedule Syntax' to 'Trigger Configuration' and update the on: field table link (#trigger-configuration anchor) - Add on.schedule subheading (existing content unchanged) - Add on.pr section: two-layer filter table, three YAML examples (minimal, branch+changed-files, label gate), mode table, and a note on the synthetic vs policy strategies - Add on.pipeline section: basic example and a filters example with branch + time-window; note on trigger suppression All claims verified against PrTriggerConfig / PipelineTrigger / PipelineFilters structs in src/compile/types.rs and the PrMode enum docs in the same file. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Open
jamesadevine
deleted the
docs/trigger-configuration-readme-0e60737e773b1d07
branch
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.
Summary
on.proron.pipeline— they had to find agent-facing docs instead.Changes
README.md— renamed## Schedule Syntax→## Trigger Configuration; added### on.schedule — recurring schedule(existing content, just re-headlined); added### on.pr — pull request triggerwith two-layer filter table, three YAML examples (minimal, branch+changed-files, label gate),modetable, and an ADO Azure Repos note; added### on.pipeline — upstream pipeline completionwith a basic and a filtered example, plus a note on trigger suppression semantics. Updated theonfield table link to#trigger-configuration.Accuracy checks
on.prfilter fields verified againstPrTriggerConfig,PrFilters,BranchFilter,PathFilterstructs insrc/compile/types.rson.pr.mode(synthetic/policy) verified againstPrModeenum insrc/compile/types.rson.pipelinefields (name,project,branches,filters) verified againstPipelineTriggerandPipelineFiltersstructstrigger: none/pr: nonewhen schedule or pipeline is set) verified against the front-matter.mdx trigger suppression tableValidation
#trigger-configurationanchor matches the renamed heading;docs/front-matter.md#pr-triggering-in-azure-repostarget exists in the agent-facing docCreated by the docs-writer workflow.