Recently my team at work migrated to git from TFS for our VSTS repositories. The main reason we did this switch was to have an artifact to prove (in a CMMI inspection) that we did code reviews during our development process. We also wanted to adopt the gitflow workflow while working on our Scrum Sprints. The gitflow branching and merging strategy has been great for us so far. Below is a wiki for all of the scenarios we have during our Sprint. Enjoy!
Git Scenario Workflows
New sprint branch VSTS Method
New sprint has started and you need to see remote branches on your pc that have been added to the VSTS git repo
- Create feature branch in VSTS from dev
Associate work item(s) to feature branch when creating branch.
- Run git commands to see new branch and switch to it
git checkout dev git pull git checkout my-feature-branch-name
New sprint branch Command-Line Method
New sprint has started and you want to start working on a feature branch without creating a branch on VSTS first.
- Create feature branch in command line using the following command:
git checkout -b "BranchName"
Naming Conventions for Branches
- When you are ready to send your branch the server (after committing) run:
You will be given a command to enter to set the “upstream” of the server. Simply copy and paste the command into Cmdr and it will properly set it. Then run: git push
- Create a pull request for your newly pushed code Ensure to associate your Pull request to the work item for your branch. The difference with command line vs VSTS branch creation is that you associate your PBI’s to your branch at the end (during PR creation) versus on creating of the branch in VSTS.
Stage & Commit code changes to feature branch
When you have made changes and need to commit them to your local feature branch repo.
git status *if you want to see what changes you have currently made git add . *to add all files currently modified in repo git commit -m "comment for work I just completed"
Push code changes to feature branch
git pull git push
Get code from dev -> feature-branch
git checkout dev git pull git checkout feature-branch-name git merge dev solve merge issues, if any git push origin feature-branch-name
Checkout remote feature-branch for pull request review etc
git checkout dev git pull git branch -r shows you the remote branches you can checkout git checkout name_of_the_branch do not include origin prefix
If you would like to make changes set the branch upstream to the origin branch. Then you will be able to
git push to that origin branch if needed.
git branch -u origin/name_of_the_branch
Pull Request feature-branch -> dev
Use VSTS pull request feature in the branches area to submit a request. We use Branch Policies to ensure 1 person reviews it, a work item is linked, and the Merge Strategy is “No-fast-forward merge”.
Pull Request dev -> master
We use the “Swash Merge” VSTS Branch Policy under “Enforce a merge Strategy”. This will condense all the changes in a pull request into one commit with one parent.
Clear previous branches from PC
New sprint has started and you need to remove feature/bug/change branches that were added to your pc during the previous sprint.
Remove remote branches
git branch -r *to see remote branches on your local pc git remote prune origin git branch -r *to verify changes were made
Or you can set a global git config setting which will prune your branches on fetch.
git config --global fetch.prune true
Then, every time you do a
git pull or
git fetch your origin branches will be pruned.
Remove local branches
git branch *to see local branches on your pc git branch --merged | grep -v "\*" | xargs -n 1 git branch -d git branch *to verify local branches were removed