WebStorm 9.0.2 Web Help

Commit Changes Dialog

VCS | Commit Changes
VCS | Show Changes View - Local - Context menu of a file or change list - Commit Changes
View | Tool Windows | Changes - Local - Context menu of a file or change list - Commit Changes


Use this dialog box to commit (check in) changes from the selected change list to the repository and, optionally, to create a patch file.

The options available in this dialog depend on the version control system you are using.

Toolbar

Item Tooltip and Shortcut Description Available in
vcsToolbarCompareIcon Show Differences
Ctrl+D
Click this button to open the Differences dialog box that points at the inconsistencies between your local working copy of the selected file and the file in the repository. All VCSs
vcsToolbarMoveChangelistIcon Move to Another Changelist
F6
Click this button to add the selected file(s) to another changelist. The Move to Another Changelist dialog box opens where you can select an existing changelist or create a new one. All VCSs
refresh Refresh Changes
Ctrl+F5
Click this button to reload the Changed files tree view so it is up-to-date. All VCSs
rollbackSVN Rollback Click this button to revert all changes made to the local working copy of the selected file(s). All VCSs
vcsToolbarJumpToSourceIcon Jump to source
F4
Click this button to open the source code of the selected file in the editor. All VCSs
vcsToolbarRevertUnchangedIcon Revert Unchanged Files Click this button to revert the files that have not been modified locally. Subversion
Perforce
vcsToolbarGroupByDirIcon Group by Directory
Ctrl+P
Click this button to toggle between the flat view and the directory tree view. All VCSs
expandAll.png
collapseAll
Expand or collapse all nodes
Ctrl+NumPad+
Ctrl+NumPad -
Click these buttons to expand or collapse all nodes in the directory tree. These buttons are not available in flat view. All VCSs

Controls

Item Description Available in
Changed files This tree view displays the list of changed files. Select check boxes next to the files to be checked in. All VCSs
Comment In this text box, describe the changes to be checked in. This comment will be also used as the name of the patch file, if you decide to create a patch. As you type, WebStorm checks the spelling and highlights words in question.

This functionality is available if the Spelling code inspection is enabled.

All VCSs
Change list From this drop-down list, select the change list that contains the modified files to be checked in or included in the patch. By default, the active change list is suggested. All VCSs
Summary This section displays summary statistics on the currently selected change list, such as the number of modified, new, and deleted files. The area also shows how many files of each type are shown and how many of them will be committed. All VCSs
Author Use this drop-down list to specify the person who created the changes to be checked in. Git
Amend Commit Select this check box to replace a previous commit with the current changes. Git, Mercurial
Keep files locked Select this check box to keep the files locked after they are checked in. Subversion
Jobs This area is available only if you select the Enable Perforce Jobs Support check box on the Perforce page of the Settings dialog box.

Use the controls in this area to search forPerforce jobs, link jobs to the selected changelist, and detach currently linked jobs.

  • Unlink selected jobs button delete - click this button to detach the selected job from the changelist.
  • Edit associated jobs button icon_openLocalVersion - click this button to open the Edit Jobs Linked to Changelist dialog box where you can search for available jobs, view their details, and link the desired job to the changelist.
  • Find and link job matching the pattern button add - click this button to start quick search for the job that matches the pattern specified in the text box and attach the job to the changelist.
    In the text box, specify the exact name of the desired job or a search pattern according to the Perforce jobs syntax rules.

The list box in the bottom of the area displays the jobs that are currently attached to the changelist.

Perforce
Before Submit/
Before Commit
Use this area to define which additional activities you want WebStorm to perform before checking in the selected files. The available options are:
  • Optimize imports: select this check box to haveredundant import statements removed.
  • Reformat code: select this check box to perform code formatting according to theProject Code Style settings.
  • Rearrange code: select this check box to rearrange your code according to thearrangement rules preferences.
  • Perform code analysis for affected files: select this check box to run code inspection on the files to be committed.
  • Check TODO (<filter name>): select this check box to review the encountered TODO items matching the specified filter. Click the Configure link to choose an existing TODO filter or open the TODO page of the Settings dialog box and define a new filter to be applied.
  • Revert unchanged: select this check box to revert unchanged files.

    This option is only available for Perforce.

CVS
Git,
Subversion,
Perforce
After Submit/
After Commit
Use this area to define which additional activities you want WebStorm to perform after checking in the selected files. The available options are:
  • Run tool: in this drop-down box, appoint the external tool to launch after the selected changes are checked in. Choose the one of the available third-party tools or click the Browse button browseButton.png and configure integration with the required tool in the External Tools dialog box that opens.
  • Upload files to: in this drop-down list, specify the server access configuration to use for uploading the committed files to a local or remote host, a mounted disk, or a directory. To suppress uploading, choose None.
  • Always use selected server: select this check box to have WebStorm by default upload files according to the server access configuration specified in the Upload files to: drop-down list.

    The drop-down list and the check box are only available if the Remote Hosts Access plugin is enabled.

  • Tag committed files: select this check box to have a tag assigned to the checked in files. In the text box, type the name of the tag. To have a previously assigned tag replaced with the new one, select the Override existing tags check box.

    This option is only available for CVS.

  • Auto-update after commit: select this check box to have your project automatically updated after the commit is completed. Enabling this option will help to prevent your working copy against mixed-revision state.

    The mixed-revision state of a working copy may affect the Move and Rename refactoring applied to folders so items in revisions different from the moved subtree root will be tracked separately, which can be confusing.

    When the Auto-update after commit is enabled:

    • Merge will fail with an error if the merge target is a mixed-revision working copy.
    • Your own changes will never cause a 409 conflict.

    This option is only available for Subversion integration.

All VCSs
Details The pane is by default hidden, to unfold it click the arrow icon next to the pane title. In this pane, explore the differences between the base repository version of the file selected in the Changed Files list and the version to be checked in.

The pane consists of two areas:

  • The affected code as it was in the base revision.
  • The affected code as it is after the change is introduced.
The pane can be split horizontally or vertically.

In each area, WebStorm numbers both changes and the lines involved in them.

To close the pane, click the Change Details button previewUsages once more.

Item Tooltip and Shortcut Description
expandAll.png More/Less Lines Click this button to open a slider and specify the number of lines to be shown above and below the updated code fragment at the caret.
arrowDown.png arrowUp.png Next/previous change Click this button to move to the next/previous updated piece of code.
edit Jump to Source Click this button to open selected file in the editor, with the line in the Change Details pane, where the caret currently rests, having the focus in the editor.
projectToolWindowSettingsIcon.png Settings Click this button to show the list of options that define the appearance of the pane:
  • Top/Bottom: Select this option to have the pane split horizontally, so the base revision is shown in the upper part and the locally updated version is shown in the bottom part of the pane.
  • Left/Right: Select this option to have the pane split vertically, so so the base revision is shown in the left-hand part and the locally updated version is shown in the right-hand part of the pane.
  • Use soft wraps: Select this option to have the soft wraps (or word wraps) used.
All VCSs
Submit/Commit Click this button with drop-down to do one of the following:
  • Submit/Commit: select this option to check in the changes to your version control.
  • Commit and Push: select this option to have the changes pushed to the remote repository immediately after commit.

    This operation is available when you are using Git or Mercurial integration.

  • Create Patch: select this option to have WebStorm generate a patch based on the changes to be checked in. In the Create Patch dialog box that opens, type the name of the patch file and specify whether you need a reverse patch.
  • Remote Run: select this option torun your personal build.

    This operation is available when you are logged in to TeamCity. Refer to TeamCity plugin documentation for details.

All VCSs

See Also

Last modified: 11 December 2014
comments powered by Disqus