Documentation

Support

Unity Version Control

DevOps

On-prem

Gluon

Editor plug-in

Open Unity Dashboard

Unity Version Control

PARTIAL CHECKIN

Check in changes to a partial replica with the Unity Version Control CLI.
Read time 2 minutesLast updated 21 days ago

Description

Stores changes in the repository.

Usage

cm partial checkin | ci [<item_path>[ ...]] [-c=<str_comment> | -commentsfile=<comments_file>] [--all | -a] [--applychanged] [--keeplock] [--symlink] [--ignorefailed] [--machinereadable [--startlineseparator=<sep>] [--endlineseparator=<sep>] [--fieldseparator=<sep>]]

Options

Option / Argument

Description

-cSpecifies a comment to the changeset created in the checkin operation.
-commentsfileApplies the comment from the specified file to the changeset created in the checkin operation.
--all | -aIncludes also the items changed, moved, and deleted locally on the specified paths.
--applychangedApplies the checkin operation to the changed items detected in the workspace along with the checked out items.
--privatePrivate items detected in the workspace are also included.
--keeplockKeeps the lock of the locked items after the checkin operation.
--symlinkApplies the checkin operation to the symlink and not to the target.
--ignorefailedAny changes that cannot be applied (because the lock,
  1. a. exclusive checkout, cannot be adquired or because local changes are in conflict with the server changes) are discarded and the checkin operation continues without them. --machinereadable Outputs the result in an easy-to-parse format. --startlineseparator Used with the '--machinereadable' flag, specifies how the lines should start. --endlineseparator Used with the '--machinereadable' flag, specifies how the lines should end. --fieldseparator Used with the '--machinereadable' flag, specifies how the fields should be separated. item_path Items to checkin. Use double quotes (" ") to specify paths containing spaces. Use a whitespace to separate paths. Use . to apply checkin to current directory.

Help

Remarks

  • If <item_path> is not specified, the checkin will involve all the pending changes in the workspace.
  • The checkin operation always applies recursively from the given path.
  • To checkin an item:
  • The item must be under source code control.
  • The item must be checked out.
  • If the item is changed but not checked out, the '--applychanged' flag is not necessary unless <item_path> is a directory or it contains wildcards ('*').
Revision content should be different from previous revision in order to be checked in. Set the PLASTICEDITOR environment variable to specify an editor for entering comments. If the PLASTICEDITOR environment variable is set, and the comment is empty, the editor will be automatically launched to allow you to specify the comment.

Reading input from stdin

The 'partial checkin' command can read paths from stdin. To do this, pass a single dash "-". Example: 
cm partial checkin -
Paths will be read until an empty line is entered. This allows you to use pipe to specify which files to checkin. Example: 
dir /S /B *.c | cm partial checkin --all -
 (In Windows, checkins all .c files in the workspace.)

Examples

cm partial checkin figure.png landscape.png
(Applies the checkin to 'figure.png' and 'landscape.png' checked-out files.) 
cm partial checkin . -commentsfile=mycomment.txt
(Applies checkin to current directory and sets the comment from the 'mycomment.txt' file.) 
cm partial ci background.png -c="my comment" --keeplock
(Applies the checkin to 'background.png', includes a comment, and keeps the lock.) 
cm partial checkin --applychanged
(Applies the checkin to all pending changes in the workspace.) 
cm partial checkin link --symlink
(Applies the checkin to the symlink file and not to the target.) 
cm partial checkin . --ignorefailed
(Applies checkin to current directory, ignoring the changes that cannot be applied.)