Review Projects

Review Projects 101

A Review Project in PHENOM is a temporary merge workspace created during the Push, Pull, and Approve Process. The objectives of a Review Project are to:

• Allow data modeling prior to finalizing the merge
• Facilitate a thorough review of incoming changes
• Provide additional pages to aid the review process

Review Project Management

To learn about the creation of Review Projects, view the Push, Pull, and Approve Process.

When in PHENOM > Manage Models > Projects, the user can view the Review Projects they have access to under the destination Project within the Project Tree. Expand the destination Project in the Project Tree, then expand the Review Projects folder.

Viewing the Review Projects folder. (Review Projects folder only exists if a Review Project exists for the desination Project)

To view the corresponding push/pull request for your Review Project, simply select the Review Project from the Project Tree. The user can also access the the related Review Project for a push/pull request either on the pull or on the approve page where the Review Project was initiated.

Selecting the Review Project and viewing the associated Merge Request.

Review Projects can be altered in every way that a normal project can, but they cannot be copied or published. Additionally, the Push, Pull, and Approve pages are consolidated into the Review Tab when switched to a Review Project, which contains pages specific to the Review Project.

Project Locking

When initiating a Review Project from either the pull or approve page, users have the option to secure the destination Project by selecting 'Lock Current Project During Review'. This lock ensures that no changes can be made to the modeling content while it's under review. Once the merge is ready to be finalized, the Project lock must be removed to finalize the merge. Multiple Review Projects can exist simultaneously so it is important for the user to manage the single lock on the destination Project during review.

Note that while Project locking is optional, it is encouraged to use the Project lock to prevent external changes being made to the destination Project during review.

Creation of Review Project on the pull page with 'Lock Current Project During Review' enabled.

Review Project Specific Pages

Finalize Merge

The Finalize Merge page functions as a hub where users can review the changes selected from the push/pull request and finalize the merge directly.

Accessed from a Review Project in PHENOM > Manage Models > Review > Finalize Merge, as seen below:

Commits

The Commits page lists each Commit point for the Review Project. Commits enable users to roll back the Review Project to a previous version, reflecting the model content as it was at the time the Commit was created.

Accessed from a Review Project in PHENOM > Manage Models > Review > Commit, as seen below:

Commits page with the initial Commit displayed within the list.

When the Review Project is initiated, an initial Commit is always created. Additionally, the user can create a Commit at any time during the review from the Commit page or before rejection of review changes.

Users can rollback to any Commit at any time. It's crucial to understand that rolling back to a Commit will delete all subsequent Commits and revert any changes made after that Commit. To rollback to a Commit, simply select the desired Commit from the list, then click the 'Rollback To Commit' icon located in the top bar of the page:

Selecting a Commit to rollback changes.

Update Review

The Update Review page is very similar to the pull page found in the Push, Pull, and Approve Process. Users can select additional changes from the push/pull request that were not initially chosen during the creation of the Review Project. These changes can either be accepted or ignored.

Accessed from a Review Project in PHENOM > Manage Models > Review > Update Review, as seen below:

Update Review page with several additions not yet merged into the Review Project from the associated push/pull request.

Here you will be prompted to select nodes from the tree on the left or from the Merge Summary. You may choose to ignore certain changes and accept others. Any changes accepted will overwrite your current version of those model elements.