Skip to content

docs: Document released Factory schema fields - #755

Merged
hongyi-chen merged 6 commits into
mainfrom
factory/factory-schema-drift-coverage
Sep 18, 2026
Merged

hongyi-chen merged 6 commits into
mainfrom
factory/factory-schema-drift-coverage

Conversation

@warp-agent-staging

@warp-agent-staging warp-agent-staging Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

What this feature does

Factory-as-Code lets authors select GitHub or GitLab repositories, configure MCP transports and integration scopes, use current trigger filters and aliases, authenticate private runner images, and provide object-form benchmark refs. The reference excludes schema-published options that remain disabled in production. Shipped in v0.2026.09.09.08.26.stable_02 (2026-09-09).

Summary

Updates the exhaustive Factory definition reference with production-enabled fields and behavior only.

Companion tooling PR: https://github.com/warpdotdev/docs-factory-config/pull/10

Changes

  • Document GitHub and GitLab forge selection, MCP transports, Linear and Jira scopes, and the legacy cloud-provider alias.
  • Document exact provider-specific production trigger-filter unions and aliases, private runner image credentials, and object-form benchmark repository refs.
  • Exclude Azure DevOps and five published fields whose runtime gates are disabled or dogfood-only.

Content design plan

Audience and JTBD: Factory authors who need an exhaustive reference for configuration accepted and enabled in production.

Problem: The reference omitted released fields while schema presence alone could also expose unreleased fields.

Goals:

  • Authors can look up current public fields, accepted values, and constraints.
  • The reference does not advertise disabled or internal-only behavior.

Purpose and value: Authors can use the supported Factory definition without inferring behavior from schema JSON or implementation details.

Content type: Reference — readers need concise field and constraint lookup.

Skill and template: Existing Factory reference; no new page or template.

High-impact scenarios:

  • Covers: forge selection, MCP transports, integration scopes, trigger filters, private runner images, and benchmark refs.
  • Excludes: published fields that production configuration or runtime gates keep unavailable.

Unverified claims

None — each changed claim was verified against the production schema registry, production feature configuration, and the shipped parser or runtime path.

Documentation risk

Risk: engineering-review-required
Rationale: Updates public Factory configuration claims based on production rollout and runtime sources.
Source files consulted: config/prod.yaml, logic/factoryfile, and model/types/triggers at 032c64767451
Docs override: none

Verification

  • Live schema checker: coverage complete for v1alpha1 and all 9 published documents, including exact provider trigger-filter unions; two implementation-only keys reported as non-blocking skew.
  • Independent production-bundle comparison: all 8 provider unions matched the docs exactly; Azure DevOps was absent.
  • python3 .agents/skills/style_lint/style_lint.py --changed: 1 file scanned; 3 pre-existing warnings on unchanged lines.
  • python3 .agents/skills/check_for_broken_links/check_links.py --internal-only: 4,149 internal links checked; 0 broken.
  • python3 .agents/skills/doc_quality_policy/check_compression_contract.py --content-type reference src/content/docs/factories/factory-as-code.mdx: passed.
  • npm run build: passed; 386 Markdown docs and 388 HTML files generated.
  • git diff --check: passed.

Additional context

The companion tooling PR owns section mappings, rollout exceptions, fixtures, and tests; this PR changes only src/content/docs/factories/factory-as-code.mdx relative to main.

Co-Authored-By: Oz oz-agent@warp.dev

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Sep 16, 2026
@vercel

vercel Bot commented Sep 16, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 18, 2026 4:49am UTC

Request Review

@warp-agent-staging warp-agent-staging Bot added factory:docs-factory Label associated to the "docs-factory" factory warpy-factory Opened by the Warp factory agents labels Sep 16, 2026
@warp-agent-staging

Copy link
Copy Markdown
Contributor Author

This PR was generated with Warp.

Comment @warp-staging-factory on this PR to send it follow-up work.

View run View conversation View on Slack

@warp-agent-staging warp-agent-staging Bot changed the title docs: Cover published Factory schema fields docs: Document released Factory schema fields Sep 17, 2026
@warp-for-oss

warp-for-oss Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /warp-agent-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@warp-for-oss warp-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR updates the Factory definition reference with released schema fields for forges, MCP transports, integrations, trigger filters, private runner images, and benchmark repo refs. The additions are generally scoped to reference material, but two changed sections need clarification before merge.

Concerns

  • The new codeForges section says an empty list disables all forges, but it does not explain the required repositories shape for that case.
  • The new MCP transport bullets mention env and headers without warning readers away from committing credentials in source-controlled factory files.

Security

  • The MCP transport documentation should direct credential material toward managed secrets or Warp-managed MCP servers instead of literal env or headers values.

Verdict

Found: 0 critical, 2 important, 0 suggestions

Request changes

Comment /warp-agent-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Comment thread src/content/docs/factories/factory-as-code.mdx Outdated
Comment thread src/content/docs/factories/factory-as-code.mdx Outdated
Resolve the factory schema reference conflicts while preserving the published field coverage.

Co-Authored-By: Oz <oz-agent@warp.dev>
Document the released MCP field shapes and direct credentials to managed secrets or managed MCP installations.

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen
hongyi-chen merged commit a568497 into main Sep 18, 2026
11 of 12 checks passed
@hongyi-chen
hongyi-chen deleted the factory/factory-schema-drift-coverage branch September 18, 2026 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed factory:docs-factory Label associated to the "docs-factory" factory warpy-factory Opened by the Warp factory agents

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant