Visualizing Git Workflows. A visual guide to 539 workflows

Transcription

1 Visualizing Git Workflows A visual guide to 539 workflows

2 Table of Contents Notation Collaboration Without Review or Branches Merge Conflicts Requesting Code Review Collaboration with Multiple Branches

3 Notation

4 Notation This is a single commit. The text is the commit ID. C4 This is a branch (i.e. sequence of commits). Each branch has a different color.

5 Notation These boxes show the state of a repository at a given location.

6 Notation C8 C4 This means that is storing two branches. One has 4 commits, the other has 3.

7 Notation C7 C8 C9 This means that s computer is storing local copies of the same two branches.

8 Notation C7 C8 C9 C7 C8 C4 Local Copy Remote Copy Same branches, different commits.

9 Notation I show branches like this: C4 C5 Other tutorials may show this: C5 C4 They mean the same thing

10 Collaboration Without Review or Branches

11 There is a master branch on github with two commits. Bob

12 clones the repository on her computer. Bob

13 Bob clones the repository on his computer. Bob

14 commits new code to her master branch Bob

15 pushes the feature branch to for all to see. Bob

16 Bob fetches s new changes from. Bob

17 Bob builds some of his code on s new commit. C4 Bob

18 C4 Bob pushes his code to for to see. C4 Bob

19 C4 pulls Bob s changes, so now everyone has the same code. C4 C4 Bob

20 Merge Conflicts What happens when we change the same file?

21 Imagine is fixing a bug. She starts by checking out a new purple branch, based off of her local master.

22 C4 Around the same time, bob pushes a new commit, C4, to master. Now the remote master (on ) is out of sync with s local master branch.

23 C4 creates a new commit, C5, to fix the bug on her new branch. C5

24 C4 Now pulls Bob s updated changes from to her computer. C4 C5 Bob put the new feature on the master branch, so when pulls, it goes to her local master branch. Notice how the last commit of the bug fix branch is different from master.

25 C4 Now adds her local bug fix to her local master branch. She does this by merging her changes from her bug fix branch to her master C4 C6 branch. C5 If there is a conflict with Bob s changes, this results in a special merge commit.

26 Requesting Code Review Do this for every change outside of SkunkWorks!

27 creates a new feature branch.

28 commits new code to her feature branch

29 pushes the feature branch to for all to see. She creates a pull request and asks for a review.

30 C4 C4 After addressing a few comments in a new commit, the Koz says Ayyyy that code looks good.

31 C4 After addresses any review comments and obtains approval, the Koz merges her changes to master. C4

32 C4 now pulls the new master from, and deletes her old branch. Now everyone has the same code. C4

33 Collaboration With Multiple branches

34 There is a master branch on github with two commits. Bob

35 Both and Bob clone the repository on their computers. Bob

36 creates a local orange branch. Bob creates a local purple branch. Bob

37 They both commit new code to each of their branches. C4 Bob

38 pushes the feature branch to for all to see. She requests a pull request. C4 Bob

39 The course staff merges s changes with the master branch on. C4 Bob

40 Both and Bob pull down the changes from master. C4 Bob

41 Bob merges master into his feature branch. C4 C6 Bob

42 C4 C6 Bob pushes his feature branch to master and asks for a PR. C4 C6 Bob