Shelve changes to a topic stream

Shelving enables you to store local changes in a topic stream in a repository and optionally remove the changes from a work area.

For details about shelving guidelines and examples, see Shelve your personal changes.

Note: Shelving requires the use of Web Client Tools (supported on Windows only).

To shelve your changes:

  1. In the web client, open a stream. In the side panel, select Folders and Items.
  2. On the toolbar, select Shelve. The Shelve wizard opens.
  3. Enter a name for the topic stream, a unique branch name, and a description.

  4. Select the option to be applied after the shelving operation completes:

    • Reset the work area to the latest content of the stream in the repository.

    • Rehome the work area and associate it with the topic stream.

  5. Click Next. The Shelve wizard displays the work area you are shelving from, and the topic stream where your changes are shelved to. You can select a different work area.

  6. Optional) Set advanced options:

    Field Description
    Include local folders Enter an expression to specify files and folders in the work area that you want to include in the topic stream. For details, see Include and exclude files and folders.
    Exclude local files Enter an expression to exclude specific files and folders in the work area from the topic stream. For details, see Include and exclude files and folders.
    Include Select the local changes to include in the delivery: additions, deletions, modifications, and moves/renames.
    Ignore rules If you have defined ignore rules but want to skip them, select Disable restrictions from .dmignore files for this delivery.
    Skip summary before synchronization Select this option if you don't want to review the summary of the shelving actions before you start shelving.
    Close wizard on completion Select this option to automatically close the wizard after shelving.
  7. Click Shelve.

    1. If you selected to reset the work area, click Reset. The Update wizard opens. The stream to be used for the update is the same one that is associated with the work area. In the Advanced section, the following options are selected by default:

      • Reset work area changes to repository versions and paths.

      • Delete locally added files (such as files added by a local build process).

      To reset the work area, complete the Update wizard. For details, see Update work areas from streams.

Back to top

See also: