Skip to main content

Documentation Index

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

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

​
Overview

Git Sync connects a platform workspace to a GitHub workspace repository. The platform reads rollout code and configuration from that repository, discovers rollouts under rollouts/, and makes them available for training. Your local workspace directory is a clone of the same repository. Push to the default branch to sync changes.

​
Repository Setup

1

Create or connect a workspace repository

Workspace owners and admins connect GitHub in the platform, then create a private workspace repository from the Osmosis workspace template or connect an existing repository.New repositories created from the platform include the starter examples multiply-local-strands, multiply-local-openai, and multiply-harbor-strands. For the full first-time setup flow, start with Onboarding.
2

Work from the local workspace directory

Your local workspace directory should be a clone of the connected GitHub repository. Invited members use the existing workspace repository rather than creating a second one.
3

Verify local context

From your local workspace directory, confirm the origin remote points at the connected GitHub repository:
git remote get-url origin
osmosis doctor

​
How Sync Works

  • Pushing to the default branch triggers an automatic sync.
  • The platform discovers rollout definitions in the rollouts/ directory.
  • Each rollout subdirectory (e.g. rollouts/my-rollout/) becomes a rollout entity on the platform, available for training and evaluation.
  • Config files under configs/ are also synced so that osmosis train submit can reference them by path.
  • The platform records sync history with commit SHA, author, message, status, and number of rollouts discovered.
Git Sync is the source of truth for training code. osmosis train submit reads config values from the local TOML file you pass, but rollout code comes from the synced workspace repository. Commit, push, and wait for sync before submitting code changes; set commit_sha when you need a specific synced revision.

​
Sync Status

View sync history in the platform under Git Integration. Each sync event shows:
StateMeaning
PendingPush detected, sync queued
SyncingPlatform is processing the repository contents
SuccessAll rollouts synced successfully
FailedSync encountered an error (check logs for details)
A manual sync action is available in the platform to re-process the current default branch without pushing a new commit.

​
Blocking States

The platform shows a banner when GitHub setup blocks training workflows.
StateEffectFix
No GitHub installationRollout sync and training setup cannot proceed.Connect GitHub from Git Integration.
No repository connectedThe platform has no workspace repository to sync.Create or connect a workspace repository.
GitHub App disconnectedTraining runs are blocked until access is restored.Reconnect the GitHub App.
Repository needs setupThe repository record needs repair or replacement.Open Git Integration and follow the setup flow.

​
Important Notes

  • Only pushes to the default branch trigger automatic sync.
  • Pushes to feature branches are ignored until merged into the default branch.
  • If the repository is renamed on GitHub, update your local origin remote and check the platform connection.
Use commit_sha in your training config to pin a training run to a specific commit.

​
Next Steps

Workspace Repository

Learn how local CLI commands are scoped to a repository.

Training Runs

Submit training after Git Sync succeeds.