Push and Pull

Pushing and pulling enables you to keep your local files and your OneStream files in sync. Performing a push replaces the items on the OneStream server with your local content. Performing a pull replaces items on your local machine with OneStream server content.

Pushing and pulling only impacts compilable files, such as C# or VB.NET files. If you have a non-compilable file in your local project, pulling from the server will not impact that file.

NOTE: Items with the status Conflicts or Errors cannot be pushed or pulled.

Before pushing or pulling, you can view a preview of the results and review changes, providing easy visibility into incoming and outgoing changes before you apply them. After an item is pushed or pulled, a results window displays a confirmation of the changes.

When you select the drop-down arrow for a push or pull operation, the Push/Pull Selected and Preview Push/Pull options display. The option you choose becomes the default for following push/pull operations until a different value is selected.

The drop-down arrow for the Push button is selected to dispaly the Push Selected and Preview Push options

Push

To push your changes to OneStream, complete these steps:

  1. Complete and save the changes in your local files.

  2. In the Repository Items grid, use the checkboxes to select the items you want to push. To select all items in the repository, select the multiselect checkbox.

  3. Select your default push operation.

    Two items are selected from the grid and the Push Selected button is outlined

  4. The Confirm Push Operation dialog box displays. To confirm that you want to replace items on the OneStream server with your local content, select the OK button.

    To prevent the Confirm Push Operation dialog box from displaying again, select the Don't show this confirmation again for push and pull operations checkbox.

Once a push is completed, the Push Results window displays showing updates to the files. A push compiles on the server, and the Build Output tab displays compilation results

The Push Results window dispalys a successful build

Pull

To pull content from OneStream down to your local, complete these steps:

  1. Complete and save your changes in OneStream.

  2. Use the checkboxes to select the items you want to pull these changes into. To select all items in the repository, select the multiselect checkbox.

  3. Select your default pull operation.

    Two items are selected in the grid and the Pull Selected button is outlined

  4. The Confirm Pull Operation dialog box displays. To confirm that you want to replace items on your local machine with OneStream server content, click the OK button.

    To prevent the Confirm Pull Operation dialog box from displaying again, select the Don't show this confirmation again for push and pull operations checkbox.

    CAUTION: If you have added a file locally to any of the selected project items that have not been pushed to the server, performing a pull will delete this local file.

Once a pull is completed, the Pull Results window displays showing updates to your local files.

The Pull Results window displays ttwo items pulled with the Changed Files tab showing a new file added

Previews and Results

The Preview and Results windows display all changed files and provide visibility into line-by-line changes before and after push/pull operations. The left pane displays each item selected for the push/pull operation.

In the Push/Pull Preview window, all items in this pane are selected by default. Use the checkboxes to deselect any items you want to exclude from the push/pull operation.

One item is selected in the pane for the Pull operation

Each item displays with the following indicators:

  • Status

    • The Ready icon is a green checkmark Ready: The item is valid and ready to push and pull.

    • The Warning  icon is an orange triangle with an exclamation markConflicts: The item has conflicts with the server that must be resolved before you can push and pull.

    • The Error status icon is a red exclamation markError: The item has errors that must be resolved before you can push and pull.

  • Item name

  • The languages of the project file, which can be C# or VB.NET.

  • The total number of files altered

  • The total number of lines added and removed

The Changed Files tab displays a tree view of changes for the items selected in the pane. Each file displays the total number of lines changed and a change-type indicator:

  • The Added icon is a green AAdded: The file was added.

  • The Deleted icon is a red DDeleted: The file was deleted.

  • The Modified icon is an orange MModified: The file was modified.

When a file is selected in the navigation tree, the file viewer pane displays the modified lines.

The Push Results window dispalys with the file viewer showing what was added and deleted

The file viewer defaults to an inline view. To display a side-by-side view, select the Inline button.

The Inline button was selected and the side-by-side view displays to compare the files

If there are no changes being pushed or pulled, the window displays No changes detected.

The Pull Results window displays two successful pulls and the Changed Files tab displays a green checkmark and No Changes Detected

Push Results

A push operation compiles on the server, and the Push Results window displays the build output results with any errors or warnings. A banner displays above the grid indicating the compilation status. The grid shows the code for each error or warning, including the associated file and line/column number. You can filter the grid to display only errors or warnings.

The Push Results window dispalys a successful and an unsuccessful push. The build output displays two errors