A reference adoption path for teams connecting GitHub as a Connected System — from scaffold through certification and Role Assistant handoff. Use this as a checklist alongside the Builder API edit loop and Builder CLI certification ladder.
Outcome
When complete, your tenant has a certified GitHub Connected System with Business Entities (for example repository issues), governed capabilities, and Role Assistant scope ready for external AI consumption — 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 loginand permissions to validate, upload, and certify- Developer journey and Edit Connected Systems with Builder API 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 | Credential method configured | Configure authentication; post-upload Authentication UI |
| 3. Model | Metadata, capabilities, CIP execution | Entity type 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 |
Builder API and CLI
Agents and CI use the same governed loop as human integrators. Prefer Builder API for section reads and intent-scoped patches; use CLI for repair, upload, and certification when scripting locally:
| Step | Status | Notes |
|---|---|---|
| Read manifest section | Live | Builder help section, sections |
| Patch with intent + repair hooks | Live | Named repair hooks after structural patches; CLI aifabrix repair remains valid |
| Golden example alignment | Live | Builder help goldenExample (repository / issue patterns) |
| Post-upload auth handoff | Live | Builder help connectedSystemUi |
| Validate / upload / certify | Live | Builder CLI ladder below |
Safe edit loop: Edit Connected Systems with Builder API. Section key map: UI terminology map.
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 |
| Patching without repair | Run named repair hooks (or aifabrix repair) after structural patches |
| Enabling Role Assistants before certify | Finish operations, trust, and governance pillars first |
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.