... | @@ -6,7 +6,9 @@ |
... | @@ -6,7 +6,9 @@ |
|
|
|
|
|
This guide takes you step-by-step through our Gitlab workflow from issue to completion. We start by creating an issue on Gitlab, and then creating a development branch for the issue on Git. All development for that issue happens on that issue branch. Eventually once the issue concerns have been committed and pushed, we walk through the steps of initiating and accepting a merge request, which is the final step of the workflow.
|
|
This guide takes you step-by-step through our Gitlab workflow from issue to completion. We start by creating an issue on Gitlab, and then creating a development branch for the issue on Git. All development for that issue happens on that issue branch. Eventually once the issue concerns have been committed and pushed, we walk through the steps of initiating and accepting a merge request, which is the final step of the workflow.
|
|
|
|
|
|
#### Create an issue
|
|
---
|
|
|
|
|
|
|
|
## Create an issue
|
|
|
|
|
|
1. Go to Gitlab project and click **Issues** from the header navigation
|
|
1. Go to Gitlab project and click **Issues** from the header navigation
|
|
2. Check to see if issue already exists (check both open and closed issues)
|
|
2. Check to see if issue already exists (check both open and closed issues)
|
... | @@ -22,10 +24,11 @@ This guide takes you step-by-step through our Gitlab workflow from issue to comp |
... | @@ -22,10 +24,11 @@ This guide takes you step-by-step through our Gitlab workflow from issue to comp |
|
4. Fill out the **Details** field and any other fields that you want to set (Assign to, Milestone).
|
|
4. Fill out the **Details** field and any other fields that you want to set (Assign to, Milestone).
|
|
5. Click **Submit new issue**
|
|
5. Click **Submit new issue**
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
#### Create development branch
|
|
## Create development branch
|
|
|
|
|
|
##### Generic Git Workflow
|
|
#### Generic Git Workflow
|
|
|
|
|
|
1. Checkout **master** branch
|
|
1. Checkout **master** branch
|
|
2. Pull changes from **origin/master**
|
|
2. Pull changes from **origin/master**
|
... | @@ -36,7 +39,7 @@ This guide takes you step-by-step through our Gitlab workflow from issue to comp |
... | @@ -36,7 +39,7 @@ This guide takes you step-by-step through our Gitlab workflow from issue to comp |
|
5. Create remote branch by pushing to origin using the same branch name.
|
|
5. Create remote branch by pushing to origin using the same branch name.
|
|
6. Begin development
|
|
6. Begin development
|
|
|
|
|
|
##### PhpStorm Workflow
|
|
#### PhpStorm Workflow
|
|
|
|
|
|
This assumes that you have already installed the [PhpStorm Gitflow](phpstorm-git-flow) plugin. All interaction with Gitflow is done via the **Gitflow** menu towards the right-side of the PhpStorm **Status Bar**, which is located at the bottom of the screen. If you do not see your status bar, make sure to enable the **View** > **Status Bar** option in your PhpStorm menu.
|
|
This assumes that you have already installed the [PhpStorm Gitflow](phpstorm-git-flow) plugin. All interaction with Gitflow is done via the **Gitflow** menu towards the right-side of the PhpStorm **Status Bar**, which is located at the bottom of the screen. If you do not see your status bar, make sure to enable the **View** > **Status Bar** option in your PhpStorm menu.
|
|
|
|
|
... | @@ -56,9 +59,11 @@ This assumes that you have already installed the [PhpStorm Gitflow](phpstorm-git |
... | @@ -56,9 +59,11 @@ This assumes that you have already installed the [PhpStorm Gitflow](phpstorm-git |
|
* If the issue branch has already been created on Gitlab, choose **Track {TYPE}** from the Gitflow menu and choose the origin (Gitlab) branch you want your local issue branch to be linked to.
|
|
* If the issue branch has already been created on Gitlab, choose **Track {TYPE}** from the Gitflow menu and choose the origin (Gitlab) branch you want your local issue branch to be linked to.
|
|
* If an issue branch hasn't been created on Gitlab, create one by choosing **Publish {TYPE}** from the Gitflow menu. This will also link your local issue branch to the remote one just just created.
|
|
* If an issue branch hasn't been created on Gitlab, create one by choosing **Publish {TYPE}** from the Gitflow menu. This will also link your local issue branch to the remote one just just created.
|
|
|
|
|
|
#### Develop, Commit, Push
|
|
---
|
|
|
|
|
|
##### Generic Workflow
|
|
## Develop, Commit, Push
|
|
|
|
|
|
|
|
#### Generic Workflow
|
|
|
|
|
|
1. Whenever development for this issue occurs, make sure you have the branch that was created for this issue checked out
|
|
1. Whenever development for this issue occurs, make sure you have the branch that was created for this issue checked out
|
|
2. All commits should reference the issue. Do this by placing a `#{ISSUE ID}` somewhere in the commit message - e.g. `#4: Add start() event listener that kills overlay`.
|
|
2. All commits should reference the issue. Do this by placing a `#{ISSUE ID}` somewhere in the commit message - e.g. `#4: Add start() event listener that kills overlay`.
|
... | @@ -67,7 +72,7 @@ This assumes that you have already installed the [PhpStorm Gitflow](phpstorm-git |
... | @@ -67,7 +72,7 @@ This assumes that you have already installed the [PhpStorm Gitflow](phpstorm-git |
|
4. Repeat until issue is resolved.
|
|
4. Repeat until issue is resolved.
|
|
5. Pull from `origin/master` and merge into your local issue branch and then push the issue branch one more time to the origin (Gitlab) before moving on to "creating a merge request" step.
|
|
5. Pull from `origin/master` and merge into your local issue branch and then push the issue branch one more time to the origin (Gitlab) before moving on to "creating a merge request" step.
|
|
|
|
|
|
##### PhpStorm Workflow
|
|
#### PhpStorm Workflow
|
|
|
|
|
|
These instructions make use of the **Navigation Bar** at the top of the PhpStorm window and the **Status Bar** at the very bottom of the PhpStorm window. Make sure they are visible by enabling the **View** > **Navigation Bar** and **View** > **Status Bar** menu items.
|
|
These instructions make use of the **Navigation Bar** at the top of the PhpStorm window and the **Status Bar** at the very bottom of the PhpStorm window. Make sure they are visible by enabling the **View** > **Navigation Bar** and **View** > **Status Bar** menu items.
|
|
|
|
|
... | @@ -86,8 +91,9 @@ These instructions make use of the **Navigation Bar** at the top of the PhpStorm |
... | @@ -86,8 +91,9 @@ These instructions make use of the **Navigation Bar** at the top of the PhpStorm |
|
7. Choose **Finish {TYPE}** from the Gitflow menu in the bottom status bar.
|
|
7. Choose **Finish {TYPE}** from the Gitflow menu in the bottom status bar.
|
|
* This will switch back to your **develop** branch, merge in the changes from the issue branch, and then delete your local issue branch.
|
|
* This will switch back to your **develop** branch, merge in the changes from the issue branch, and then delete your local issue branch.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
#### Create Merge Request
|
|
## Create Merge Request
|
|
|
|
|
|
1. Go to Gitlab project and click **Merge Requests** from the header navigation
|
|
1. Go to Gitlab project and click **Merge Requests** from the header navigation
|
|
2. Click the **New Merge Request** button
|
|
2. Click the **New Merge Request** button
|
... | @@ -95,8 +101,9 @@ These instructions make use of the **Navigation Bar** at the top of the PhpStorm |
... | @@ -95,8 +101,9 @@ These instructions make use of the **Navigation Bar** at the top of the PhpStorm |
|
4. If someone else is responsible for accepting the merge request, then it might be helpful to assign the merge request to them and use the **Description** to communicate any extra information to them.
|
|
4. If someone else is responsible for accepting the merge request, then it might be helpful to assign the merge request to them and use the **Description** to communicate any extra information to them.
|
|
5. Click **Submit merge request** button
|
|
5. Click **Submit merge request** button
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
#### Handling the Merge Request (Project Admin)
|
|
## Handling the Merge Request (Project Admin)
|
|
|
|
|
|
1. Go to Gitlab project and click **Merge Requests** from the header navigation
|
|
1. Go to Gitlab project and click **Merge Requests** from the header navigation
|
|
2. Select the merge request that you are interested in
|
|
2. Select the merge request that you are interested in
|
... | | ... | |