Skip to content

Connect GitHub

Install the Plavn GitHub App, choose repositories, link them to projects, work with organizations, refresh and disconnect.

Connecting takes two steps: let the Plavn GitHub App see some repositories, then link each of them to a project. For what you get from it, see GitHub.

You can connect in two places:

  • In the welcome steps, under Do you work with code?, choose Yes, connect GitHub. Choose No, skip this if you do not work with code; you can Change answer later.
  • Any time in Settings → GitHub, choose Connect GitHub.

Plavn sends you to GitHub. There you sign in, pick the account or organization, and choose which repositories the App may read: all of them, or only some. Then GitHub brings you back and Plavn says GitHub connected.

If Plavn says The GitHub integration is not configured on this server yet, the GitHub App is not set up where you are using Plavn, and there is nothing to connect yet.

You can connect your own account and any organization you belong to. Choose Add account or organization to add another; each shows as its own card with a Personal or Organization label.

If you are not an owner of the organization, GitHub only sends an install request to its owners, and Plavn says Install request sent to your organization owners. Nothing is connected until an owner approves it on GitHub. After that, come back and choose Connect GitHub again.

Each connected account lists its repositories, with a lock on private ones, the default branch, and either Last push with the time or No pushes received yet.

  • To change which repositories Plavn can see, choose Choose repositories on GitHub. Changes you make there show up in Plavn on their own. If they do not, choose the Refresh button on the card (Repositories refreshed).
  • Use Search repositories and the All, Linked and Not linked buttons to find one. Ten show at first; Show all shows the rest.
  • Collapse a card with its arrow.

If an account has none, you see No repositories are shared with Plavn yet. Choose some on GitHub.

Next to each repository is a menu with your projects. Choose one to link it (Repository linked), or Not linked to remove the link (Repository unlinked). Linked repositories are grouped under their project.

  • A repository links to one project. Linking it somewhere else moves the link.
  • You need to be an owner or admin of the project to link a repository to it.
  • Archived projects are not offered.
  • Plavn records commits only for linked repositories. An unlinked repository still shows its last push, but its commits are not kept and are not used for bug reports. See Commits and suspects.
  • To create an issue in a repository, it has to be linked too. See GitHub issues.

The links sync across your devices like the rest of your projects.

If GitHub suspends the App for an account, its card shows Suspended. Plavn cannot read from it until GitHub lifts the suspension.

Choose the bin icon on an account’s card and confirm Disconnect. Plavn stops using that account’s repositories and removes your project links to them. If nobody else uses that installation through Plavn, the stored repositories and their commits are removed too.

The App stays installed on GitHub. To remove its access completely, uninstall it in your GitHub settings (use Choose repositories on GitHub to get there). Uninstalling it on GitHub has the same effect in Plavn.

Commits and suspects: what Plavn does once a repository is linked.