... | ... | @@ -36,7 +36,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.
|
|
|
6. Begin development
|
|
|
|
|
|
##### PhpStorm Gitflow 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.
|
|
|
|
... | ... | @@ -50,23 +50,7 @@ This assumes that you have already installed the [PhpStorm Gitflow](phpstorm-git |
|
|
3. Name the new branch (Gitflow will prepend either `feature/`, `release/` or `hotfix/` to the branch name for you)
|
|
|
* The name should be a lowercased, dash-separated and a potentially shorter version of the Gitlab Issue **Subject** - e.g. `restrict-droppable-for-draggables`
|
|
|
4. Gitflow created the branch (based on your **develop** branch), and checked it out
|
|
|
5. Create the branch on Gitlab (for collaborative purposes), by choosing **Publish Feature** from the Gitflow menu.
|
|
|
|
|
|
##### PhpStorm Workflow
|
|
|
|
|
|
There are several ways to access the Git commands in PhpStorm. 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.
|
|
|
|
|
|
1. Make sure you are on the **master** branch
|
|
|
* The right-side of the **Status Bar** at the bottom, you should see **Git: {BRANCH NAME}**
|
|
|
* If the **{BRANCH NAME}** is not **master** then click the branch name to open the branches popup menu. From the **Local Branches** section, choose **master -> origin/master** > **checkout**.
|
|
|
2. Pull changes from Gitlab (origin). Click the **Update Project** button *(has an icon that says "VCS" with a blue downward arrow below it)* located on the right side of the upper **Navigation Bar**.
|
|
|
3. Click the **Git: {BRANCH NAME}** menu towards the right-hand side of the **Status Bar** to reveal the **Git Branches** popup menu
|
|
|
4. Choose **New Branch** to create your issue/development branch and follow these naming conventions...
|
|
|
* Should start with a (single) main **label** for the Gitlab Issue, followed by a slash - e.g. `bug/`
|
|
|
* Should be a lowercased, dash-separated and a potentially shorter version of the Gitlab Issue **Subject** - e.g. `bug/restrict-droppable-for-draggables`
|
|
|
4. PhpStorm creates the branch and checks it out so you are now in your new branch. You should now see your newly created branch name as the selected branch in the **Status Bar**. If you don't, check it out.
|
|
|
5. Create a remote branch on Gitlab (origin) by opening the Terminal via the **Tools** > **Open Terminal...** menu item, and then entering this command: `git push origin {ISSUE BRANCH NAME}` where `{ISSUE BRANCH NAME}` is the name of the issue branch that you just created - e.g. `git push origin bug/restrict-droppable-for-draggables`
|
|
|
|
|
|
5. Create the branch on Gitlab (for collaborative purposes), by choosing **Publish Feature** from the Gitflow menu.
|
|
|
|
|
|
#### Develop, Commit, Push
|
|
|
|
... | ... | @@ -82,6 +66,8 @@ There are several ways to access the Git commands in PhpStorm. These instructio |
|
|
|
|
|
##### 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.
|
|
|
|
|
|
1. Whenever development for this issue occurs, make sure you have the branch that was created for this issue checked out
|
|
|
* The right-side of the **Status Bar** at the bottom, you should see **Git: {ISSUE BRANCH NAME}**
|
|
|
* If the **{ISSUE BRANCH NAME}** isn't the correct branch created for the issue, then click the branch name to open the branches popup menu. From the **Local Branches** section, choose correct branch and select **checkout**.
|
... | ... | |