docs(backend-github): add optional branch name configuration

This commit is contained in:
Steph Locke 2021-04-13 15:41:44 +01:00 committed by GitHub
parent 5909a7307d
commit 55d20c19c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,9 +1,8 @@
---
title: GitHub
group: Accounts
weight: 30
title: GitHub
---
For repositories stored on GitHub, the `github` backend allows CMS users to log in directly with their GitHub account. Note that all users must have push access to your content repository for this to work.
Because Github [requires a server](https://github.com/netlify/netlify-cms/issues/663#issuecomment-335023723) for authentication, Netlify facilitates basic GitHub authentication.
@ -17,6 +16,8 @@ To enable basic GitHub authentication:
backend:
name: github
repo: owner-name/repo-name # Path to your GitHub repository
# optional, defaults to master
# branch: main
```
## Specifying a status for deploy previews