GitHub
The ALIGN GitHub App verifies your repositories, keeps access in step with GitHub, and runs the PR check.
Connect
Owners and admins open Sources in the console and choose Connect GitHub (or Connect another GitHub account). You need to have signed in to ALIGN with GitHub, and to be the GitHub account itself or an admin of the GitHub organisation you install on. An installation belongs to one ALIGN organisation. The install link from the console is valid for 30 minutes; an install started on github.com connects only if you own or administer exactly one ALIGN organisation.
After installing, Sources shows the connection (Installed on <account> · active, with the last sync) and the
repositories as GitHub reports them.
For an organisation in the beta, an owner first accepts the pilot data terms in Settings; until then nobody gets the install link.
What the App may do
| Permission | Access |
|---|---|
| Contents | read |
| Pull requests | write |
| Issues | write (comments) |
| Checks | write |
| Metadata | read |
| Organisation members | read |
It never pushes code. From collaborators it stores only GitHub numeric ids and permissions, never names or emails. The comment on a pull request never carries quotes, transcript lines or Slack and Linear text.
Verified repositories
A repository the installation covers is verified. Without the App, align init connects a repository by proving
a clone (its root commit): such a repository is unverified in Sources, and each member proves their own clone.
If another organisation installs the App on a repository you had only claimed by clone, your copy of it is archived
(its entries stay with you, read-only and exportable) and your owners get an email.
Collaborators and access
Once a day, after membership changes on GitHub and after every sync, ALIGN reads each verified repository's collaborators. Members of your organisation who collaborate on a repository get access to it; access that came from GitHub or from a clone is removed when it no longer holds. Access an admin revoked stays revoked.
Auto-join
With Auto-join on, a person who signs in to ALIGN and collaborates on one of your verified repositories is
offered Join on /app (and when signing in a device). Accepting makes them a member with access to those
repositories only. Owners and admins get an email listing who joined, at most once a day.
Auto-join is on for new organisations; an owner turns it off in Settings → Auto-join. It counts only repositories on an active installation whose collaborators were read in the last two days.
Uninstalling
If the App is uninstalled on GitHub, its repositories stop receiving checks; if it is suspended, Sources shows "suspended on GitHub". Either way, auto-join stops offering those repositories.