Connect GitHub
A workspace with no GitHub connection has no issues in it. Connecting is installing one GitHub App, called Pealboard, on your organization or on your personal account.
Install it
Section titled “Install it”- Go to Settings → GitHub.
- Select Install on GitHub. The same button starts GitHub’s own installation screen whether you install on an organization or on your personal account.
- GitHub shows its own screen. Choose the account, choose the repositories, and select Install.
- GitHub returns you to Pealboard.
If you are not an owner of the GitHub organization, GitHub sends an installation request to the owners instead of installing. Nothing happens in Pealboard until an owner approves it, and Settings → GitHub says so while you wait.
If GitHub already sees an installation your account can see, that list comes first, with its own Use this installation action, and the section below it is headed Install on a different organization — the button in it still reads Install on GitHub and starts the same screen.
What Pealboard asks GitHub for, and why
Section titled “What Pealboard asks GitHub for, and why”| Permission | Why |
|---|---|
| Issues, read and write | To show issues and comments, and to create and edit them from Pealboard and from portals. |
| Metadata, read | GitHub requires it for any repository access. |
| Pull requests, read | So an issue’s linked pull requests can be shown. Pealboard never writes to a pull request. |
| Projects, read and write | To read a project’s fields and items, and to set a field value when you move a card. |
| Members, read | To match a workspace member to a GitHub account. |
Pealboard never asks for code, contents, actions or secrets. It does not clone your repositories and it does not read your source.
Authoring: as you, or as the app
Section titled “Authoring: as you, or as the app”By default every issue or comment Pealboard writes is authored by
pealboard[bot], with a line naming who asked for it.
Account → Linked GitHub lets you link your own GitHub account, which is required before you can connect a GitHub organization to a workspace. Once it is linked, Writes as myself there switches your own writes to your own token, so GitHub shows you as the author and the body carries no attribution block. See Account.
Disconnecting
Section titled “Disconnecting”Settings → GitHub → Disconnect GitHub, admin or above. Syncing stops and nothing in the workspace can be written to GitHub until an installation is connected again.
It does not uninstall the app. The installation belongs to the GitHub account, not to Pealboard: disconnecting is Pealboard letting go of the connection, and GitHub still lists the app on the organization until you remove it in that account’s own settings.
What Pealboard has already read stays — the issues, comments, projects and portals — so reconnecting the same installation with Use this installation finds the workspace’s own history rather than an empty product.