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 Connect a GitHub organization. The same button starts GitHub’s own installation screen whether you install on an organization or on your personal account.
- GitHub shows its own installation screen. Choose the account, choose the repositories, and select Install.
- GitHub returns you to Pealboard. If GitHub already sees an installation you have not connected to this workspace, it is listed above the button instead, with its own Use this installation action.
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.
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”Today, every issue or comment Pealboard writes is authored by
pealboard[bot] with a line naming who asked for it, whether or not you have
linked your own GitHub account.
Account → Linked GitHub lets you link your GitHub account, which is required before you can connect a GitHub organization to a workspace. Switching authorship itself to write as you, rather than as the app, is not available yet.