Push, Pull, and Approve Process: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
VisualWikitext
(Created page with "== Viewing Your Working Branch == When you want to move from your own version of the model to view or edit another team member's or project team's model or vice versa, you will need to change branches. To view the branch you are currently working in: # Login to PHENOM # When you login, note in your Dashboard that you are working on a particular branch '''INCUDE IMAGE''' {{Info | 1=This branch inherits from a larger project branch that the rest of your team also inherit...")
 
m (fixed image positioning)
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Viewing Your Working Branch ==
== Pulling Changes from the Parent ==
When you want to move from your own version of the model to view or edit another team member's or project team's model or vice versa, you will need to change branches.
To view the branch you are currently working in:
# Login to PHENOM
# When you login, note in your Dashboard that you are working on a particular branch


'''INCUDE IMAGE'''
=== <u>Pull Request</u> ===
Pulling allows you to get changes from the project you have inherited from. These changes can either be accepted or ignored.


{{Info | 1=This branch inherits from a larger project branch that the rest of your team also inherits from.
To pull from your parent project, open the tab shown below:
All your work will be done in your branch and will not be visible to anyone except those you have granted express permission to.
Should you wish to collaborate with someone else, you may grant permission to someone else so that they can work on your branch with you. This is done by creating a ticket in the support center, and we will notify you and the other user once the change has been made.}}


== Navigating to Manage Models > Projects ==
[[File:Pull1 2.png|1000px|border]]
# Login to PHENOM
# In the Left Navigation bar, click MANAGE MODELS
[[File:Phenom-manage-mode.png|none]]
== Switching branches ==
To switch between branches:
# Select the project you want to update in the Projects list
# In the project's details panel, elect the Switch Branch icon from the Branch ribbon next to the relevant model
# Select a branch from the drop-down list of available branches
# Click the "Switch" button


'''INCUDE IMAGE'''
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. The pull may fail and tell you that you are missing certain model elements. These could be something such as trying to merge an attribute of an entity without including the entity itself, or a Service but not the view that it points to, etc.


{{Info | 1=Branch Merging provides a way to share content with other data modelers while keeping separate workspaces.}}
=== <u>Pull Review Project</u> ===
Instead of a traditional pull, you may decide to create a pull [[Review Projects | Review Project]]
. Select the changes as you would in a traditional pull, but then check the 'New Review Project' option. You will need to specify a name and description of the pull [[Review Projects | Review Project]]. To ensure that the integrity of the model contents is maintained during review, you may also decide to enable Project Locking. Only one pull [[Review Projects | Review Project]] can exist per child.


== Managing Branch Properties & Permissions ==
To create a pull [[Review Projects | Review Project]], see the image below:
To manage branch properties, select the branch you want to update in the Models list. It will open the branch's details panel on the right and you will be able to rename the branch, manage users' permissions to the branch, or delete the branch.


'''INCUDE IMAGES'''
[[File:PullReviewProject.png|1000px|border]]


== Pulling Changes from the Parent ==
After the pull [[Review Projects | Review Project]] is created, the pull page will display it's details.
Pulling allows you to get changes from the branch you have inherited from. These changes can either be accepted or ignored.
 
== Pushing Changes to the Parent ==  
To push your changes to your parent project with a push request, open the tab shown below:


To pull from your parent branch open the tab shown below
[[File:PushRequest.png|1000px|border]]


You may select any changes made in the tree on the left or from the Merge Summary, specify the push requests name and description, then press the "Request Push" button. This will not result in any change to your parent project yet, as these changes must be approved by someone with the correct permissions on your parent project.


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


The pull may fail and tell you that you are missing certain model elements. These could be something such as trying to merge and attribute of an entity without including the entity itself, or a Service but not the view that it points to, etc.
=== <u>Push Request</u> ===
To approve changes that have been requested from one of your children projects, open the tab shown below:


Pushing Changes to the Parent
[[File:ApprovePushRequest2.png|1000px|border]]
To push your changes to your parent branch, open the tab shown below


This tab shows any push requests as 'Merge Requests' that have been made by any of your child projects in addition to the completed and deleted push requests. On selection of one of these options, you may select which of the requested changes you would like to make to your model by selecting them in the tree on the left or from the Merge Summary, then hitting the 'Approve' button.


You may select any changes made in the tree on the left, then press the "request push" button. This will not result in a change to your parent branch yet, as these changes must be approved by someone with the correct permissions on your parent branch.
The merge may fail and tell you that you are missing certain model elements. These could be something such as trying to merge and attribute of an entity without including the entity itself, or a Service but not the view that it points to, etc.


Approving Changes from a Child
=== <u>Push Review Project</u> ===
To approve changes that have been requested from one of your children branches, open the tab shown below
Instead of a traditional approve, you may decide to create a push [[Review Projects | Review Project]] instead. Select the changes as you would in a traditional push, but then check the 'New Review Project' option. You will need to specify a name and description of the push [[Review Projects | Review Project]]. To ensure that the integrity of the model contents is maintained during review, you may also decide to enable the [[Review_Projects#Project_Locking|Project Lock]] for the destination Project. Note that only one [[Review Projects | Review Project]] may exist per push request.


To create a push [[Review Projects | Review Project]], see the image below:


This tab shows any push requests that have been made by any of your child branches. On selection of one of these options, you may select which of the requested changes you would like to make to your model by selecting them in the tree on the left, then hitting the "Approve" button.
[[File:ApproveReviewProject2.png|1000px|border]]


The pull may fail and tell you that you are missing certain model elements. These could be something such as trying to merge and attribute of an entity without including the entity itself, or a Service but not the view that it points to, etc.
After the [[Review Projects | Review Project]] is created, selecting the corresponding push request will display it's details.

Latest revision as of 15:11, 31 January 2025

Pulling Changes from the Parent

Pull Request

Pulling allows you to get changes from the project you have inherited from. These changes can either be accepted or ignored.

To pull from your parent project, open the tab shown below:

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. The pull may fail and tell you that you are missing certain model elements. These could be something such as trying to merge an attribute of an entity without including the entity itself, or a Service but not the view that it points to, etc.

Pull Review Project

Instead of a traditional pull, you may decide to create a pull Review Project . Select the changes as you would in a traditional pull, but then check the 'New Review Project' option. You will need to specify a name and description of the pull Review Project. To ensure that the integrity of the model contents is maintained during review, you may also decide to enable Project Locking. Only one pull Review Project can exist per child.

To create a pull Review Project, see the image below:

After the pull Review Project is created, the pull page will display it's details.

Pushing Changes to the Parent

To push your changes to your parent project with a push request, open the tab shown below:

You may select any changes made in the tree on the left or from the Merge Summary, specify the push requests name and description, then press the "Request Push" button. This will not result in any change to your parent project yet, as these changes must be approved by someone with the correct permissions on your parent project.

Approving Changes from a Child

Push Request

To approve changes that have been requested from one of your children projects, open the tab shown below:

This tab shows any push requests as 'Merge Requests' that have been made by any of your child projects in addition to the completed and deleted push requests. On selection of one of these options, you may select which of the requested changes you would like to make to your model by selecting them in the tree on the left or from the Merge Summary, then hitting the 'Approve' button.

The merge may fail and tell you that you are missing certain model elements. These could be something such as trying to merge and attribute of an entity without including the entity itself, or a Service but not the view that it points to, etc.

Push Review Project

Instead of a traditional approve, you may decide to create a push Review Project instead. Select the changes as you would in a traditional push, but then check the 'New Review Project' option. You will need to specify a name and description of the push Review Project. To ensure that the integrity of the model contents is maintained during review, you may also decide to enable the Project Lock for the destination Project. Note that only one Review Project may exist per push request.

To create a push Review Project, see the image below:

After the Review Project is created, selecting the corresponding push request will display it's details.

Retrieved from "https://kb.phenomportal.com/index.php?title=Push,_Pull,_and_Approve_Process&oldid=1379"