Configure Git plugin


The Git plugin provides some options that can be adjusted.

Example

gatsby-config.js

const path = require('path')
const REPO_ABSOLUTE_PATH = path.join(process.cwd(), '../..')

module.exports = {
  // ...
  plugins: [
    {
      resolve: 'gatsby-plugin-tinacms',
      options: {
        plugins: [
          'gatsby-tinacms-json',
          'gatsby-tinacms-remark',
          {
            resolve: 'gatsby-tinacms-git',
            options: {
              pathToRepo: REPO_ABSOLUTE_PATH,
              pathToContent: 'packages/demo-gatsby',
              defaultCommitMessage: 'Edited with TinaCMS',
              defaultCommitName: 'TinaCMS',
              defaultCommitEmail: '[email protected]',
              pushOnCommit: false,
            },
          },
        ],
      },
    },
    // ...
  ],
}

Options

  • pathToRepo: The base-path to the repository where the content is stored in. Default: The repository root.
  • pathToContent: The directory to the root of your app within the repository. Default: The repository root. This can be useful for monorepos, when you have multiple sites within one repository.
  • defaultCommitMessage: The default commit message. Default: 'Edited with TinaCMS'
  • defaultCommitName: The default Git user name.
  • defaultCommitEmail: The default Git user email.
  • pushOnCommit: Indicates if every commit should also be pushed automatically. Default: true.
  • gitRemote: Git SSH remote url for the repository. Default: undefined.
  • sshKey: Base64 encoded SSH private key that has access to the repository. This should not be committed to your repository. This value should be undefined or load the key from an environment variable (ie. process.env.SSH_KEY) Default: undefined.

Configuring the File Writing Debounce

The TINA_GIT_DEBOUNCE_MS environment variable can be used to change the debounce rate for file writing. This value defaults to 1000 milliseconds.

TINA_GIT_DEBOUNCE_MS=3000 gatsby develop

This is useful when running in your site in cloud editing environment i.e. Gatsby Cloud or Heroku.