Documentation Index

Fetch the complete documentation index at: https://docs.aifabrix.ai/llms.txt

Use this file to discover all available pages before exploring further.

GitHub integration golden path

Prev Next

A reference adoption path for teams connecting GitHub as a Connected System — from scaffold through certification. Use this as a checklist; some Builder API automation steps remain partial until manifest-scoped patch orchestration (plan 154.1) closes.

Outcome

When complete, your tenant has a certified GitHub Connected System with Business Entities (for example repository issues), governed capabilities, and optional Role Assistant tasks — with evidence captured per resource type.

Prerequisites

  • AI Fabrix platform with dataplane and controller reachable
  • GitHub App or test organization with isolated repository for E2E
  • aifabrix login and permissions to validate, upload, and certify
  • Build AI-ready systems overview read

Golden path phases

Phase Goal Typical commands / surfaces
1. Scaffold Connected System + Business Entity JSON aifabrix create, wizard, or Builder API read/patch
2. Auth apiProvider or credential method configured Configure authentication; post-upload Authentication UI
3. Model Metadata, capabilities, CIP execution Business Entity guides; Builder help cipOverview
4. Validate Schema + integration tests green aifabrix validate, aifabrix test, aifabrix test-integration
5. Publish Online config matches workspace aifabrix upload --probe, aifabrix show --online
6. Certify Three pillars + lifecycle verify-operations, verify-trust, verify-governance, lifecycle
7. Adopt Role Assistant on certified scope From integrations to Role Assistant

Partial automation (154.1)

Until manifest-scoped patch orchestration ships fully, agents and CI should prefer the CLI ladder for repair hooks and upload, and use Builder API help topics for section reads:

Step Status Notes
Read manifest section Live Builder help section, sections
Patch with intent + repair hooks Partial Some flows still require explicit aifabrix repair
Golden example alignment Live Builder help goldenExample (e.g. repository/issue patterns)
Post-upload auth handoff Live Builder help connectedSystemUi

See Build with Builder MCP and Build reference — help topics.

Validate

aifabrix auth status
aifabrix validate github
aifabrix test-integration github
aifabrix upload github --probe
aifabrix verify-operations github
aifabrix verify-trust github
aifabrix verify-governance github --subject-email scoped-user@example.com

Replace github with your system key. Use test credentials and a non-production repository.

Common mistakes

Mistake Fix
Skipping post-upload Authentication UI Add GitHub App / token secrets after upload
Certifying before trust metadata complete Run verify-trust; fix capability descriptions
E2E against production repo Use isolated test org and --test-crud sandbox discipline
Assuming Builder API replaces repair Run named repair hooks after structural patches

Limits

This page is a golden path checklist, not a vendor OAuth tutorial. GitHub App registration, webhook URLs, and org policy remain your tenant's responsibility.

Builder API patch orchestration gaps are tracked in builder plan 154.1 — re-check this page after that plan archives.