HOWTO: Review Nuxeo Studio Configuration

Updated: April 3, 2024

This short tutorial demonstrates how branch management features in Nuxeo Studio can be used to review configuration made by other developers before it is pushed on a given branch.

Let's consider two users:

  • Bob is a new developer that just joined the project.
  • Sarah is his manager and wants to review his work before it gets pushed to the master branch.

Reviewing the Changes

Bob has some configuration made in a dedicated branch named feature/assetsmgt that is now ready to be reviewed. Sarah has to select the appropriate commit mode, merge the feature branch's content and take a decision.

Switching to an Appropriate Save Mode

To review a configuration, you need to use the advanced save mode to benefit from the possibilities described below. The advanced save mode provides a precise control.

  1. Go to Source Control > Commit Preferences.
  2. Switch to Advanced save mode.
  3. Save your changes.

Commit Mode

Once the configuration review is finished, you can switch back to another commit mode if you want to.

Adding Branch Content

Your goal is now to review the content in the asset management branch. Let's add it to the content of the master branch and check the results.

  1. Go to Source Control > Branch Management.
  2. Checkout the master branch.
  3. Click the Merge into my workspace button for the assetsmgt branch and confirm the change.
    The two branches are now merged.
  4. In Branch Management, select the master branch.

Changes pulled over from the other branch are visible in the Your Work In Progress zone. They are marked in green, because they are only visible from you at this stage until you decide to push them.

For more information about the changes, click on the corresponding commit.

Reviewing Changes

Several decisions are possible at this stage to finish the review:

Confirming Changes

To confirm the changes, you need to push the commits directly.

Click on the Push button in the bottom-right corner of the screen, in the status bar. The changes are pushed and your review is complete.

Reverting Changes

To revert changes, you need to Revert To a previous commit in the commits list.

  1. Click the Revert To button of the first commit in the Merged Commits listing.

    A new commit is created to take the configuration back to a previous step.

  2. Push all commits using the Push button.

    Changes are pushed and your review is complete.

Amending Configuration

A third option is to bring changes before sharing the final result.

  1. Make the changes you need using Nuxeo Studio, and save your work in progress.
  2. As you are using the Advanced save mode, you can pile up commits without ending the review by clicking Commit .
  3. When your changes are complete, push the changes using the Push button at the bottom-right corner of the screen, in the status bar.
    Changes are pushed and your review is complete.