Connect a GitHub repository to Shipstar

Shipstar reads commits from your GitHub repositories to generate content. Before any content can be generated, you need to install the Shipstar GitHub App on GitHub and then tell your project which repositories to track. This two-step process keeps permissions explicit and limited to read-only access.

Install the Shipstar GitHub App

1. In the dashboard sidebar, click Sources.
2. Click Install GitHub App. You will be taken to GitHub to complete the installation.
3. On GitHub, choose the organization or personal account where your repositories live.
4. Select which repositories Shipstar may access — you can grant access to all repositories or only specific ones. Shipstar's permissions are read-only: repository metadata and commit history.
5. Confirm the installation. GitHub returns you to the Shipstar dashboard.

Note for non-admins: If you do not have admin rights on the GitHub organization, you can still request the installation. An org admin will receive the request and can approve it from GitHub's organization settings.

Select repositories to track in your project

1. Back on the Sources page in Shipstar, you will see the repositories covered by the installation.
2. Toggle on the repositories you want this project to track. Shipstar aggregates commits across all active tracked repositories when generating content.
3. You can add or remove tracked repositories at any time by returning to Sources.

Link an existing installation

If you installed the Shipstar GitHub App directly from GitHub before signing up, your installation is not automatically attached to a project. To link it:

1. Go to Sources in the dashboard.
2. Click Link existing installation and follow the prompts to attach the installation to your project.

Alternatively, if you landed on a post-install page after installing from GitHub, that page will contain a direct link to complete the connection.

Tips

• You can track as many repositories as you like within a project. Content generation will draw from commits across all of them.
• Shipstar uses short-lived installation tokens to read commits — no personal access token is stored.
• If you need to grant access to additional repositories later, go to your GitHub organization's settings and update the Shipstar App installation to include the new repos, then return to Sources to track them.