GitHub Git Provider

The GitHub Git Provider handles saving and deleting content to a GitHub hosted Git repository. It is configured as a parameter to the createDatabase function.

Looking for the code? Check out the GitHub repository.

Adding the GitHub Git Provider

GitHub Git Provider Options

Required Parameters

REQUIRED
branch
string

The branch to save content to.


REQUIRED
owner
string

The owner of the repo.


REQUIRED
repo
string

The repo to save content to.


REQUIRED
token
string

All properties marked as REQUIRED must be specified for the field to work properly.

Optional Parameters

commit​Message
string

The commit message to use when saving content.

Default is Edited with TinaCMS.

root​Path
string

This path will be prefixed to all paths. Usually only used in monorepos.


octokit​Options
OctokitOptions

Options passed to the Octokit constructor