Skip to content

docs(site): expand execution-context section in front-matter reference#1645

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/expand-execution-context-front-matter-section-2374e6b6f5133a66
Draft

docs(site): expand execution-context section in front-matter reference#1645
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/expand-execution-context-front-matter-section-2374e6b6f5133a66

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

  • The execution-context: section in front-matter.mdx described the plugin as one that "stages PR diff context" — making it sound PR-only. In reality it covers eight contributors across all trigger types.

Changes

  • site/src/content/docs/reference/front-matter.mdx — rewrote the Execution Context section:
    • Fixed the description: "trigger-specific context files" instead of "PR diff context"
    • Added a contributor quick-reference table showing default/opt-in status and what each contributor stages
    • Replaced the minimal pr-only example with a full annotated YAML block covering all eight contributors (pr, workitem, pr.checks, manual, pipeline, ci-push, schedule, repo)
    • Clarified that auto-on contributors activate based on trigger config and opt-in contributors are off by default

Accuracy checks

  • All contributor defaults verified against src/compile/types.rs (ExecutionContextConfig) and src/compile/extensions/exec_context/ contributor files
  • Contributor table cross-checked against site/src/content/docs/reference/execution-context.mdx Fields section
  • workitem default ("on when pr contributor is active") verified in WorkitemContextConfig doc comment

Validation

  • cd site && npm run build:astro — 38 pages built, all internal links valid

Created by the docs-writer workflow.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • cdn.playwright.dev

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "cdn.playwright.dev"

See Network Configuration for more information.

Generated by Docs Writer · 201.4 AIC · ⌖ 12.2 AIC · ⊞ 7.7K ·

The previous description said the plugin stages 'PR diff context' which
makes it sound PR-only. In reality it covers eight contributors: pr,
workitem, pr.checks, manual, pipeline, ci-push, schedule, and repo.

- Add a contributor table with default/opt-in status and brief purpose
- Replace the minimal pr-only example with a full annotated example
  covering all eight contributors
- Fix the description to say 'trigger-specific context files' rather
  than 'PR diff context'
- Clarify that auto-on contributors activate based on trigger config,
  and opt-in contributors are off by default

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot mentioned this pull request Jul 23, 2026
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.

0 participants