How to connect GitHub

The setup guide, in full

Word for word what the connect form asks, in the order it asks. Nothing here wants your GitHub password — the credentials below are ones you create and can revoke.

1. 1

   Which repository?

   The repo your site builds from.

   1. 1Open the repository on GitHub ↗.
   2. 2Copy the owner/name part of the address, e.g. acme/marketing-site.
2. 2

   Where does that repo publish to?

   We check every published post is reachable there.

   1. 1Copy the address visitors use, e.g. https://www.acme.com.
   2. 2If the blog is under a path or a subdomain, enter that.
3. 3

   Create a GitHub token

   It can write to this one repo and nothing else.

   Open GitHub, filled in
   1. 1Open GitHub with the button. The name and permission are filled in.
   2. 2Under Repository access, choose Only select repositories and pick this repo.
   3. 3Click Generate token, copy it, and paste it below.
4. 4

   Optional settings

   Where files go and how branches are used. The defaults work for most setups.

If it doesn’t connect

The checklist the connect form shows when a test fails. Check each one in order.

• The repository is spelled exactly as owner/repo.
• The token is fine-grained, includes this repository, and has Contents: Read and write.
• The token has not expired.
• If an organization owns the repo, the organization is the token's resource owner and has approved the token.