Git Setup

Note

If you are working on a previously cloned, older repository, you can skip this page but may need to make the following changes to your Git setup:

These steps will walk you through your basic Git setup when working with TYPO3.

git clone

Create a directory for your TYPO3 core installation and change into it, e.g.:

shell command
mkdir /var/www/t3coredev
cd /var/www/t3coredev

Clone the TYPO3 CMS core repository:

shell command
git clone git@github.com:typo3/typo3 .

Set Username and Email

-- required (unless this is already setup globally, see git config --global -l)

You need to instruct git to work with your name and email address. Make sure the email address and user name are the same as those you used when setting up your TYPO3 account:

shell command
git config user.name "Your Name"
git config user.email "your-email@example.org"

Set autosetuprebase

-- required

In order to avoid weird merges in your local repository when pulling in new commits from typo3.org, we encourage everybody to set the autosetuprebase option, such that your local commits are always rebased on top of the official code:

shell command
git config branch.autosetuprebase remote

Install Your Commit Hooks

There are two git hooks available for TYPO3 development:

To set them up, do the following:

commit-msg Hook

-- required

Activate the hook by copying the sample file to .git/hooks/commit-msg:

shell command
# ensure folder exists
mkdir -p .git/hooks

# copy
cp Build/git-hooks/commit-msg .git/hooks/commit-msg

# make executable
chmod +x .git/hooks/commit-msg

Note

You usually do not need the mkdir or the chmod. It does not do any harm to execute it in any case though.

More information: commit-msg Hook

pre-commit Hook

-- optional

The pre-commit hook runs on Linux and MacOS. To use the pre-commit hook on Windows you can use a tool like the Git BASH.

Activate the hook by copying the sample file to .git/hooks/pre-commit:

shell command
# ensure folder exists
mkdir -p .git/hooks

# copy
cp Build/git-hooks/unix+mac/pre-commit .git/hooks/

# make executable
chmod +x .git/hooks/pre-commit

More information: pre-commit Hook

Alternative: Setup With Composer

As an alternative for copying the hook scripts manually, you can use the following composer command:

For Linux / MacOS:

shell command
composer gerrit:setup

This will "install" the commit-msg hook and pre-commit hook.

More information: Custom TYPO3 Composer Commands.

Setting up Your Remote

-- required

You must instruct Git to push to Gerrit instead of the original repository. It acts as a kind of facade in front of Git:

shell command
git config remote.origin.pushurl ssh://<YOUR_TYPO3_USERNAME>@review.typo3.org:29418/Packages/TYPO3.CMS.git

This will instruct Git to push using the refs/for namespace when you do git push:

shell command
git config remote.origin.push +refs/heads/main:refs/for/main

Setting up a Commit Message Template

-- optional

If you follow these instructions, whenever you create a new commit, Git will use the template to create the commit message, which you can then modify in your editor. So use this, to make it easier for you to fill out the required information.

First, create a file, for example ~/.gitmessage.txt.

~/.gitmessage.txt
[BUGFIX|TASK|FEATURE]

Resolves: #
Releases: main, 11.5

Make Git use this file as a template for the commit message:

shell command
git config commit.template ~/.gitmessage.txt

For additional information about how to write a proper commit message see Commit Message rules for TYPO3 CMS.

Show Configuration

-- optional

Show current configuration:

shell command
git config -l

The result should look like this:

result
...
remote.origin.url=git@github.com:typo3/typo3
remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
branch.main.remote=origin
branch.main.merge=refs/heads/main
branch.autosetuprebase=remote
remote.origin.pushurl=ssh://<YOUR_TYPO3_USERNAME>@review.typo3.org:29418/Packages/TYPO3.CMS.git
commit.template=/path/to/.gitmessage.txt
...

Or, compare the .git/config file inside the repository:

.git/config
 [core]
    repositoryformatversion = 0
    filemode = true
    bare = false
    logallrefupdates = true
 [remote "origin"]
     url = git@github.com:typo3/typo3
     fetch = +refs/heads/*:refs/remotes/origin/*
     pushurl = ssh://<TYPO3_USER_NAME>@review.typo3.org:29418/Packages/TYPO3.CMS.git
 [branch "main"]
    remote = origin
    merge = refs/heads/main
 [branch]
    autosetuprebase = remote
 [commit]
    template = /path/to/.gitmessage.txt

Other resources