Skip to content

docs(site): add pool configuration section with demands and overrides reference#1532

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/pool-overrides-reference-4f8b2e-f75276b34090dfbf
Draft

docs(site): add pool configuration section with demands and overrides reference#1532
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/pool-overrides-reference-4f8b2e-f75276b34090dfbf

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

  • pool.overrides (added in v0.44.0) lets users assign a different pool to individual pipeline jobs, but had no human-facing documentation anywhere.
  • demands was mentioned in the README table but had no example or prose explaining usage.
  • Added a dedicated Pool Configuration (pool:) section to the front-matter reference covering all three pool forms, demands, and pool.overrides with a valid-keys table.

Changes

  • site/src/content/docs/reference/front-matter.mdx
    • Added 6 commented-out pool variants to the canonical front-matter example (demands + overrides).
    • Added a new ## Pool Configuration (\pool:`)section between Workspace Defaults and Repositories, covering: the three pool forms (vmImage / name / 1ES),demandswith an example, andpool.overrides` with a per-job table of valid keys and a concrete overrides example.
  • README.md — extended the pool table entry to mention pool.overrides and the jobs it supports.

Accuracy checks

  • Pool forms (vmImage, name, os) verified against PoolConfig struct in src/compile/types.rs.
  • demands field and vmImage incompatibility verified against PoolConfig doc comments and the test_pool_config_object_form_with_demands test in types.rs.
  • pool.overrides valid keys (setup, agent, detection, safe-outputs, safe-outputs-reviewed, teardown, conclusion; manual-review rejected) verified against doc comments on the overrides field in src/compile/types.rs.
  • target: 1es restriction verified against the same doc comment.

Validation

  • cd site && npm run build:astro — 38 pages built, all internal links valid.
  • README re-read — well-formed Markdown, no broken links.

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 · 97.3 AIC · ⌖ 12.4 AIC · ⊞ 7.7K ·

… reference

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