Install and Configure Git
Use Git version control to deploy code to your Drupal or WordPress site's development environment.Discuss in our Forum Discuss in Slack
This section provides steps for installing and configuring Git to work with your Pantheon account.
Before You Begin
Confirm that you have:
- Created a site on Pantheon
- Set up SSH Keys on your local computer and Pantheon account
Download and install Git for your operating system:
Provide a name and email with which your commits will be associated before you can commit your code in Git.
Run the following command to enter your own name and email.
git config --global user.name "Anita Pantheon" git config --global user.email email@example.com
--globaloption sets these values for all projects you manage with Git.
Run the command below to set a default editor for commit messages. Replace
nanowith your preferred text editor or IDE. For example,
code(for Visual Studio Code).
git config --global core.editor nano
Clone Your Site Codebase
You must create a local copy of your codebase using the
git clone command. Follow the steps below to ensure that you create the clone correctly.
Navigate to the Terminal directory where you keep your projects.
Log in to Pantheon and load the Site Dashboard for the site you want to work on.
Click the Dev tab > set the Development Mode to Git > click Clone with Git.
git clonecommand and paste it into Terminal. Git will create a directory as part of the clone, so you don't need to create one:
git clone ssh://firstname.lastname@example.org:2222/~/repository.git my-site
You should see Git fetching the data:
Cloning into 'anita-wordpress'... The authenticity of host '[codeserver.dev.....drush.in]:2222 ([18.104.22.168]:2222)' can't be established. RSA key fingerprint is SHA256:yPEkh1Amd9WFBSP5syXD5rhUByTjaKBxQnlb5CahZZE. Are you sure you want to continue connecting (yes/no/[fingerprint])? yes Warning: Permanently added '[codeserver.dev.....drush.in]:2222,[22.214.171.124]:2222' (RSA) to the list of known hosts. remote: Counting objects: 20503, done. remote: Compressing objects: 100% (8184/8184), done. remote: Total 20503 (delta 12802), reused 19671 (delta 11982) Receiving objects: 100% (20503/20503), 46.65 MiB | 15.16 MiB/s, done. Resolving deltas: 100% (12802/12802), done.
- Check your SSH key setup if you run into permission problems.
- Confirm that you have a current version of Git if the clone starts but can't complete.
You can now edit your site code using your preferred text editor or IDE.
Run the command below to add a new file to your codebase and have Git track the file.
git add path/to/file.txt
Run the command below to find files in your local clone that Git is not tracking.
- Pending changes and files to be added will be listed like this:
On branch master Your branch is up to date with 'origin/master'. Changes not staged for commit: (use "git add <file>..." to update what will be committed) (use "git checkout -- <file>..." to discard changes in working directory) modified: index.php modified: wp-admin/admin-ajax.php Untracked files: (use "git add <file>..." to include in what will be committed) superdev.php no changes added to commit (use "git add" and/or "git commit -a")
Cut and paste the paths to these files when using
git add. This stages the files for the next commit.
Push Changes to Pantheon
Sending code to Pantheon is a two-step process with Git. First, you need to commit the files locally. Then you need to "push" them to the Pantheon cloud.
Commit changed files to let Git know that they are ready to be pushed to the remote.
- Every commit includes a brief message so you can later remember why the change was made. It is worthwhile to take a moment and create an accurate commit message to help others understand your changes:
git commit -am "Add a great new plugin to increase awesomesauce level of my WordPress site."
This command uses a combination of options
-ato include all files changed, and
-mto include a commit message:
Any new (untracked) files not staged with
git addwill not be included by the
-aflag. Be sure to review what is and isn't staged with
git statusbefore you commit your work.
If you don't specify a message through the command line, Git will open your default text editor and prompt you to create one. If you exit without providing a commit message, Git will abort the commit. You will see something similar to the example below if the commit worked:
[master d2fce4ea] Add a great new plugin to increase awesomesauce level of my WordPress site. 2 files changed, 3 insertions(+)
pushcommand to send the changes of the committed files from the local to Pantheon.
git push origin master
This executes a push to the origin location, (which is Pantheon since that's where you cloned the code from), on the branch "master", which is what your Dev environment tracks.
If you have a passphrase on your SSH key, you may need to enter it to authorize the push. If everything worked, you will see something like this:
Enumerating objects: 9, done. Counting objects: 100% (9/9), done. Delta compression using up to 8 threads Compressing objects: 100% (5/5), done. Writing objects: 100% (5/5), 466 bytes | 466.00 KiB/s, done. Total 5 (delta 4), reused 0 (delta 0) To ssh://codeserver.dev.....drush.in:2222/~/repository.git 27bf0fca..d2fce4ea master -> master
There is a handy list of Git commands (along with a lot of other documentation) on GitHub.
View the Changes on Pantheon
Pantheon instantly deploys the changes to your development server when the push command completes.
Navigate to your site's dashboard > click the Dev tab.
Click Visit Development Site to see the changes made by your new code.