Broken Netlify CMS due to Github master branch name change to "main"

[jsl15c]

When a branch is not specified in config.yml, Netlify defaults to using master branch of repo. Due to recent name change of master branch to main , this creates an API_ERROR: cannot find branch in CMS when publishing entries and 404 errors on initial CMS load.

To Reproduce

1. Create a new repo and project utilizing Netlify CMS, netlify-cms-app . I used gatsby.js for my project.
2. Setup config.yml in project without specifying branch name under:

backend:
  name: github
  repo: org/repo

3. Publish a new entry in Netlify CMS

Expected behavior
Initial load of localhost:8000/admin results in 404 (that are handled well). Main problem is introduced when publishing CMS entries. API_ERROR occurs.

Applicable Versions:

• Netlify CMS version: 2.12.25
• Git provider: Github
• Node.JS version: 13.13.0

CMS configuration

backend:
  name: github
  repo: jsl15c/repo
media_folder: static/assets
public_folder: /static
collections:
  - name: Product
    label: Product
    folder: product
    create: true
    fields:
      - { name: name, label: Name }
      - { label: Description, name: description, widget: text }
      - { label: Price, name: price, widget: number }

[tomrutgers]

You'll have to set a branch manually if you want to use something else than master:

backend:
  name: github
  repo: org/repo
  branch: main

[jsl15c]

@tomrutgers I realize that, but I figured it may be good to add logic to handle this change in Githubs default naming conventions

[tomrutgers]

I see, thanks for clarifying!

[stephlocke]

Could this be added to the default github config code block in the docs? 🙏 I appreciate the available options are outlined in the account settings overview but with main being the default branch name in github now, many people who go straight to the github How To will end up with errors.

[erezrokah]

Hi @stephlocke, would you mind submitting a PR for it? You can do it by clicking edit this page here https://www.netlifycms.org/docs/github-backend/

[stephlocke]

👍 #5264

[martinjagodic]

Closing as stale and/or outdated.