Review Projects: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
m (wip)
m (commit section)
Line 8: Line 8:
To learn about the creation of Review Projects, view the [[Push,_Pull,_and_Approve_Process|Push, Pull, and Approve Process]].
To learn about the creation of Review Projects, view the [[Push,_Pull,_and_Approve_Process|Push, Pull, and Approve Process]].


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


[[File:ReviewProjectInTree2.png|thumb|600px|none|Viewing the Review Projects folder. (Only exists if a Review Project exists)]]
[[File:ReviewProjectInTree2.png|thumb|600px|none|Viewing the Review Projects folder. (Only exists if a Review Project exists)]]
Line 19: Line 19:


== Project Locking ==
== 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 model while it's under review. Once the merge is ready to be finalized, the project lock can be removed. Multiple Review Projects can exist simultaneously so it is important for the user to manage the single lock on the destination project during review.
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 model while it's under review. Once the merge is ready to be finalized, the Project lock can be removed. Multiple Review Projects can exist simultaneously so it is important for the user to manage the single lock on the destination Project during review.
<br>
<br>


Line 26: Line 26:


== Review Project Specific Pages ==
== Review Project Specific Pages ==
=== [[Finalize Merge]] ===
=== <u>Finalize Merge</u> ===
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.
<br>
<br>
Accessed from a Review Project in PHENOM > Manage Models > Review > Finalize Merge, as seen below:
 


=== [[Commits]] ===
=== <u>Commits</u> ===
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.
<br>
<br>
Accessed from a Review Project in PHENOM > Manage Models > Review > Commit, as seen below:
[[File:CommitsInit.png|800x512px|thumb|none|Commits page with the initial Commit displayed within the listing.]]


=== [[Update Review]] ===
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.
<br>
<br>
The user may also rollback to any Commit at any time. However, it is important to note that rolling back to a Commit deletes all Commits and reverts all changes created after the rollback Commit. To rollback to a Commit, select the Commit from the listing, and then click the 'Rollback To Commit' icon in the top bar:
[[File:CommitRollback.png|800x512px|thumb|none|Selecting a Commit to rollback changes.]]
 
 
=== <u>Update Review</u> ===
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.
<br>
<br>
Accessed from a Review Project in PHENOM > Manage Models > Review > Update Review, as seen below:




== Sample Workflow ==
== Sample Workflow ==

Revision as of 13:05, 8 January 2025

Review Projects 101

A Review Project in PHENOM is a temporary merge workspace merge 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 features 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 see the Review Projects they have access to under the destination Project. Expand the destination Project in the Project Tree, and then expand the Review Projects folder.

Viewing the Review Projects folder. (Only exists if a Review Project exists)

To view the corresponding merge 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 merge request on the pull or approve page where the Review Project was initiated.

Note that Review Projects cannot be copied or published.

Selecting the Review Project and viewing the associated Merge Request.

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 model while it's under review. Once the merge is ready to be finalized, the Project lock can be removed. 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 listing.

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.

The user may also rollback to any Commit at any time. However, it is important to note that rolling back to a Commit deletes all Commits and reverts all changes created after the rollback Commit. To rollback to a Commit, select the Commit from the listing, and then click the 'Rollback To Commit' icon in the top bar:

Selecting a Commit to rollback changes.


Update Review

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 > Update Review, as seen below:


Sample Workflow