Kyb/DocsBeta

GitHub Codebase Sync

Architecture does not exist in isolation from source code. Kyb connects directly to your GitHub organization to discover code repositories, engineering teams, member ownerships, and CI/CD workflows, linking real repositories to architectural Application Components and Services.

Prerequisites

To sync code assets, you need administrative access to install the Kyb GitHub App on your target organization or personal account. The App requests minimal read-only permissions:

  • • Metadata (read-only)
  • • Repository contents (read-only)
  • • Organization members and teams (read-only)
  • • Actions / Workflows (read-only)

Multi-Step Discovery Wizard

Navigate to /import/github or click GitHub Sync in the Explorer toolbar to open the wizard:

  1. 1. Connect:Click “Install GitHub App” to complete the OAuth redirect flow with GitHub. Once connected, your account or organization slug will be confirmed.
  2. 2. Configure: Toggle what you wish to synchronize:
    • • Repositories: Scan all repos or apply a regex filter (e.g. ^service-.*). Option to exclude archived or forked repositories.
    • • Teams & Members: Ingest GitHub Teams as ArchiMate Business Actors or Roles, establishing ownership links.
    • • CI/CD Workflows: Ingest GitHub Actions configuration as automated build processes.
  3. 3. Discover: Kyb launches an ingestion job with live polling. Repositories and workflows are analysed and mapped to candidate architecture elements.
  4. 4. Review: Discovered elements are staged in the Review Panel before writing anything to your graph.

Reviewing Discovered Code Assets

Just like Cloud Discovery, GitHub assets are never written directly into your canonical model without human verification. In the Review step, you can:

  • Accept: Approve proposed components, services, and team ownership links.
  • Reclassify: Change the proposed ArchiMate type (e.g., converting a general repository to an Application Interface or Technology Service).
  • Reject: Skip non-architectural utility scripts or experimental repositories.

Change Detection & Resync

When your engineering organization creates new repositories, adds teams, or renames services, simply run GitHub Sync again. The Sync Diff Panel will calculate added, modified, and retired repositories, allowing you to selectively merge updates into your architecture.

Next: Import & Export

Learn how to import Archi models and native .kyb.zip bundles in Import & Export.