Shipfox

GitHub integration

Connect GitHub repositories for project code, event triggers, and workflow tools.

Authentication

Shipfox connects through a GitHub App. Install the App on the target account or organization. Grant it access only to the repositories Shipfox needs.

Backend GitHub agent tools use the full access granted to the installation. Shipfox still authorizes the caller, selected tool and method, write access, inputs, and declared repository target. Runner checkout credentials remain scoped to the repository being checked out.

Repository access

GitHub controls which repositories an integration connection can access. Shipfox cannot access any repository outside that selection.

Shipfox uses one of two modes when a workflow names a repository:

ModeAllowed repositories
Only your projects' repositoriesRepositories used by Shipfox projects.
Every repository this integration can accessRepositories selected for the GitHub App installation.

By default, a job checks out its project's repository. These modes apply when a workflow explicitly checks out a repository or a tool names one.

Use Manage GitHub repository access to change these settings. See the GitHub tool catalog for tool-specific behavior.

Integration connection identity

The slug of a GitHub integration connection defaults to github_<account>, such as github_acme. Use the slug of the workspace integration connection as a workflow trigger source.

triggers:
  on_push:
    source: github_acme
    event: push

For trigger field rules, see the workflow schema reference.

Capabilities

CapabilityDetails
Source controlUse the integration connection when you create a project.
EventsView GitHub events.
ToolsView GitHub tools.

Connect GitHub to create an integration connection.

Was this page helpful?
Edit this page on GitHub

On this page