GitHub sync

GitHub sync connects one RIB Creative project to one GitHub repository and keeps managed project source synchronized with the repository default branch.

It is intentionally conservative so source-control changes do not overwrite work unexpectedly.

How GitHub sync works

The current flow is:

1. Link your GitHub account.
2. Install the RIB GitHub App.
3. Create a new repository from the project settings page.
4. Let RIB Creative sync managed project source to the repository default branch.

GitHub account linking and GitHub App installation are separate steps. The linked account identifies you; the GitHub App grants repository access.

Current scope

GitHub sync currently supports:

• One project connected to one repository.
• New repository creation from RIB Creative.
• Default branch tracking.
• Outbound sync from RIB Creative to GitHub.
• Safe import when GitHub changed and RIB has no conflicting local managed changes.
• Manual import from GitHub.
• Manual push of the current RIB snapshot when you choose for RIB to win.
• Publish blocking when GitHub sync needs attention.

It does not currently support:

• Importing existing repositories as the primary setup flow.
• Branch switching or multi-branch workflows.
• Pull requests, merges, or in-app diff tooling.
• Multi-user repository collaboration inside the sync flow.

Source of truth

RIB Creative manages the generated project source.

When RIB Creative has local managed changes, it treats the RIB project as the source of truth. When GitHub changes independently, RIB Creative imports automatically only when that import is safe.

If both sides changed, the project enters an attention state instead of auto-merging.

Sync states

State	Meaning
Synced	RIB Creative and GitHub match.
Syncing	A sync, import, or repair job is running.
Not synced	RIB Creative has managed changes that are not in GitHub yet.
Remote ahead	GitHub changed outside RIB Creative.
Diverged	GitHub and RIB Creative both changed.
Failed	The last sync failed and needs review.

When a project is remote ahead or diverged, choose whether to import GitHub latest or push the current RIB snapshot.

Publishing with GitHub connected

Publishing checks GitHub sync first.

If the project has no GitHub repository, publishing can continue normally. If the project is connected to GitHub, RIB Creative must sync the current managed snapshot before the publish completes.

Publishing can be blocked when GitHub is ahead, diverged, broken, unavailable, failed, or already syncing.

What is not synced

GitHub sync is for managed source, not every temporary or secret artifact.

Do not expect it to sync:

• Secret .env values.
• Preview output.
• Build output.
• Platform-owned deployment artifacts.
• Temporary files outside the managed source set.

Copyable prompt

Check the GitHub sync state for this project before publishing.
If GitHub is ahead or diverged, explain the safest next action and do not overwrite remote work without confirmation.

Next steps

• Publish safely: Publish your project
• Understand project access: Project access
• Review workspace setup: Workspace integrations