PyCharm 2019.3 Help

Configure Version Control Options

PyCharm aims at making your experience with version control features independent of the version control system (VCS) that you use. Therefore, most of the settings apply to all VCSs. There are also some VCS-specific, which are configured on the corresponding pages under the Version Control page of PyCharm settings Ctrl+Alt+S.

Configure general version control settings

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Version Control.

  2. Specify which version control related actions should require confirmation.

  3. Specify which operations should be performed in the background.

  4. Configure history cache handling.

  5. Define issue navigation rules to switch from check-in comments to corresponding issues in an issue tracking system.

You can define that certain version control related activities should be performed only after confirmation from your side. Such activities can be listed on the Version Control | Confirmation page of PyCharm settings Ctrl+Alt+S Confirmation settings page.

Specify which actions should require confirmation

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Version Control | Confirmation.

  2. In the Files Creation/Deletion area, define how files created or deleted in PyCharm should be added to or removed from a version control system. The available options are:

    • Show options before adding to version control

    • Add silently

    • Do not add

  3. In the Display options dialog when these commands are invoked area, specify the commands, for which you want PyCharm to display the Options dialog. The available options are:

    • Check Out

    • Status

    • Get Latest Version

    • Update

    • Undo Check Out

  4. Configure additional settings for working with changelists by selecting or clearing the corresponding checkboxes:

    • Specify whether the read-only state of files should require explicit cancellation.

    • Specify whether meaningful comments on committing files to the repository should be required.

    • Specify whether uncommitted changes should be moved to another changelist.

    • Specify whether and how to create a changelist if the commit operation fails.

You can enable background execution of certain version control related activities. These activities are specified on the Version Control | Background page of PyCharm settings Ctrl+Alt+S.

Specify the operations to run in the background

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Version Control | Background.

  2. Enable background execution of the necessary actions by selecting the corresponding checkboxes. Background execution can be set for the following actions:

Configure history cache handling

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Version Control | Background.

  2. Set the cache scope. Depending on the version control system you are using, do one of the following:

    • Specify the maximum number of changelists to be stored in the cache.

    • Specify the maximum number of days for a changelist to be stored in the cache.

  3. Specify whether and how often (in minutes) you want your version control system to refresh the cache.

Certain settings are applicable to the version control systems assigned to the whole project, or its directories. The others are related to the selected version control systems. Use the respective VCS pages under the VCSs node of the Settings dialog to define VCS-specific settings.

Configure VCS-specific settings

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Version Control | [VCS Name].

  2. Set up options as required. For detailed information, see VCS-specific pages of the Version Control settings.

Last modified: 10 December 2019