Connect and sync GitHub

1. Connect your GitHub token

Open Account settings and save a GitHub token with access to the target repositories. Fine-grained tokens need Contents read for import/pull, Contents write for push, and Actions write for build dispatch. Creating repositories may need additional account permissions.

Classic tokens for private repositories typically need repo access; editing workflow files can also require workflow scope. Organization approval or SSO authorization may be required.

2. Import or link a project

1. To start from GitHub, open Repositories → Import and enter the GitHub URL. Configure storage first.
2. For an existing OrbitGit project, use Connect existing in its header.
3. To create a GitHub counterpart, use Create on GitHub & push. Check the target name and visibility.

orbitgit github connect https://github.com/your-user/my-app
orbitgit github status

3. Pull and push

Pull brings GitHub changes into OrbitGit. Push sends hosted OrbitGit changes to the linked GitHub repository. Sync is explicit; an ordinary OrbitGit push does not automatically sync to GitHub.

orbitgit github pull
# Work on OrbitGit, then sync back:
orbitgit github push

orbitgit push sends local commits to OrbitGit. orbitgit github push sends hosted OrbitGit commits to the linked GitHub project.

Conflicts and separate metadata

If histories diverged, review sync status, resolve or merge changes in a working copy, and push the resulting commit before retrying. Avoid force-overwriting others’ changes.

GitHub sync transfers Git history. GitHub releases, issues, and Actions artifacts do not automatically become OrbitGit releases. The GitHub tab fetches commit and pull-request metadata separately.

GitHub builds

CI needs a GitHub repository holding the generated workflow. It can be the linked project or a separate private workflow repository. Linking GitHub alone does not enable builds.