About Git configuration for GitHub Desktop
GitHub Desktop uses your local Git configuration settings and provides the option to configure some of these settings, such as the global author information and the default branch that is used when creating a new repository.
GitHub Desktop allows you to set the name and email address you would like associated with the commits you make in your repositories. If your name and email address have already been set in the global Git configuration for your computer, GitHub Desktop will detect and use those values. GitHub Desktop also allows you to set a different name and email address for an individual repository. This is useful when you need to use a separate work email address for a specific repository.
If the email address that has been set in your Git configuration does not match an email address associated with the GitHub account you are currently logged in to, GitHub Desktop will show a warning prior to committing.
GitHub Desktop also allows you to change the default branch name that you would like to use when creating new repositories. By default, GitHub Desktop uses main as the default branch name in any new repositories you create.
Совет
Anyone will be able to see the email address in your Git configuration if you make public commits. For more information, see Setting your commit email address.
Configuring your global author information
Configuring your global author information in GitHub Desktop will update the name and email address in your global Git configuration. This will be the default name and email address for all new local repositories you create in GitHub Desktop.
-
In the menu bar, select GitHub Desktop, then click Settings.
-
In the "Settings" window, click Git.
-
In the "Name" field, type the name you'd like to use for your Git configuration.
-
In the "Email" dropdown menu, select the email address you would like to use for your commits. You can select an email address associated with your GitHub account, or select "Other" and enter another email address.
-
Click Save.
-
Use the File menu, then click Options.
-
In the "Options" window, click Git.
-
In the "Name" field, type the name you'd like to use for your Git configuration.
-
In the "Email" dropdown menu, select the email address you would like to use for your commits. You can select an email address associated with your GitHub account, or select "Other" and enter another email address.
-
Click Save.
Configuring different author information for an individual repository
You can change the name and email address used to author commits in a specific repository. This local Git configuration will override your global Git configuration settings for this one repository only.
-
To switch to the repository for which you want to set specific configuration, use the "Current Repository" dropdown menu.
-
In the "GitHub Desktop" menu bar, select Repository and click Repository Settings....
-
In the "Repository Settings" window, in the left sidebar, click Git Config.
-
Under "For this repository I wish to", select Use a local Git config.
-
In the "Name" field, type the name you'd like to use for your local Git configuration.
-
In the "Email" dropdown menu, select the email address you would like to use for your commits. You can select an email address associated with your GitHub account, or select "Other" and enter another email address.
-
Click Save.
-
In the Repository menu, click Repository settings....
-
In the "Repository Settings" window, in the left sidebar, click Git Config.
-
Under "For this repository I wish to", select Use a local Git config.
-
In the "Name" field, type the name you'd like to use for your local Git configuration.
-
In the "Email" dropdown menu, select the email address you would like to use for your commits. You can select an email address associated with your GitHub account, or select "Other" and enter another email address.
-
Click Save.
Configuring your default branch for new repositories
You can configure the default branch that will be used when you create a new repository in GitHub Desktop. For more information about the default branch, see About branches.
-
In the menu bar, select GitHub Desktop, then click Settings.
-
In the "Settings" window, click Git.
-
Click the Default branch tab.
-
Edit the name of the default branch as needed.
-
Click Save.
-
Use the File menu, then click Options.
-
In the "Options" window, click Git.
- Click the Default branch tab.
- Edit the name of the default branch as needed.
- Click Save.
Configuring your shell environment for Git hooks
GitHub Desktop runs Git hooks in your configured shell environment. This means hooks have access to the same environment variables, shell configuration files (such as .bash_profile or .zshrc), and tools as when you run Git from the command line. Tools installed via version managers, such as nvm or rbenv, will also be available to your hooks.
You can configure hook environment settings in the Hooks tab of the Git settings pane.
-
In the menu bar, select GitHub Desktop, then click Settings.
-
In the "Settings" window, click Git.
-
Click the Hooks tab.
-
Use the File menu, then click Options.
-
In the "Options" window, click Git.
- Click the Hooks tab.
The following settings are available:
- Load Git hook environment variables from shell: When enabled, GitHub Desktop loads environment variables from your shell when executing Git hooks. Enable this if your hooks depend on tools installed via version managers such as
nvm,rbenv, orasdf.
- Cache Git hook environment variables: Caches hook environment variables to improve performance. Disable this if your hooks rely on frequently changing environment variables.
For more information about Git hooks in GitHub Desktop, see Working with Git hooks in GitHub Desktop.