GIT Integration

If you are using git to manage your content, Front Matter CMS can be used to sync your changes from and to your git repository.

Sync your changes with GIT

Enable GIT integration

To enable this feature, you will need to set the frontMatter.git.enabled setting to true.

Commit message

The commit message can be customized via the frontMatter.git.commitMessage setting (default is Synced by Front Matter).

Info: You can make use of the placeholders available in Front Matter for your commit messages. For example: Synced by Front Matter {{hour24}}:{{minute}}.

Require commit message

If you want to require a commit message, you can set the frontMatter.git.requiresCommitMessage setting with the branches on which you want to require a commit message.

Example to require a commit message on the main branch
{
  "frontMatter.git.requiresCommitMessage": ["main"]
}

When you open the Front Matter CMS panel, you will now be prompted to enter a commit message.

Enter a commit message before syncing

Disable syncing on certain branches

If you want to disable syncing on certain branches, you can set the frontMatter.git.disabledBranches setting with the branches on which you want to disable syncing.

Example to disable syncing on the main branch
{
  "frontMatter.git.disabledBranches": ["main"]
}

Disable the git sync action

Git submodules

If you are using git submodules for managing your content, you have more control over them via the following settings:

SettingDescriptionDefault
frontMatter.git.submodule.pushWhether to push the submodule changes to the remote repository.false
frontMatter.git.submodule.pullWhether to pull the submodule changes from the remote repository.false
frontMatter.git.submodule.branchThe branch to use for the submodule.``
frontMatter.git.submodule.folderThe folder where the submodule is located.``

Feedback/comments

Last updated on

Did you spot an issue in our documentation, or want to contribute? Edit this page on Github!

Ready to get started?

Special thanks to our backers & sponsors

VercelBEJS Community