Version Control. Collaborating with git. Tim Frasier

Transcription

1 Version Control Collaborating with git Tim Frasier Copyright Tim Frasier 2015 This work is licensed under the Creative Commons Attribution 4.0 International license. Click here for more information.

2

3 Setting Up A Shared Repository Suppose you and your collaborator(s) are working on a project, and you would like to start sharing/editing files together. All collaborators will need to set up GitHub accounts here

4 Setting Up A Shared Repository One collaborator should then set up a GitHub repository for the shared files. (Instructions for this can be found on the GitHub site).

5 Setting Up A Shared Repository To transfer the first set of files to the GitHub repository, from a local repository, copy the remote address from the GitHub site...

6 Setting Up A Shared Repository...then push the local repository to the remote repository with the following commands (using whatever address is appropriate for you). git remote add origin git push -u origin master This assumes that you already have a local repository being tracked with git

7 Setting Up A Shared Repository The user who set up the GitHub repository should then add the other collaborators as collaborators on GitHub. This will give them access to the repository Do this by...

8 Setting Up A Shared Repository 1. Clicking on the Settings tab/icon,

9 Setting Up A Shared Repository 2. Clicking on the Collaborators option,

10 Setting Up A Shared Repository 3. Then entering the GiHub usernames for the collaborators

11 Setting Up A Shared Repository With the first files located on GitHub, other users can now start working with the same files.

12

13 Getting Data From An Existing Repository Since one collaborator has set up the GitHub repository, the others can now obtain those files, add their own, and start making changes to all of them To get a copy of the remote repository, use the command line to navigate to the desired location

14 Getting Data From An Existing Repository Then, clone the remote repository as a local repository using the following command (using the appropriate address for you). git clone This will make a folder (named sandbox here), that contains all of the files in the remote repository.

15 Getting Data From An Existing Repository Each user can then make changes, add files, etc. The process is then: 1. Add and commit as per usual to their local repository, then 2. Push these to the remote repository with the following command. git push origin master

16 Getting Data From An Existing Repository Then, before working on the project again, all users should pull the files from the remote repository, because others could have made changes git pull origin master

17 Getting Data From An Existing Repository Thus, your workflow should be a continuous cycle: git pull origin master at the beginning of each session to get most recent versions from remote repository git push origin master at the end of each session to synch remote repository Work with files git add... git commit... at the end of each session to synch local repository

18

19 Differences Between Local and Pulled Versions The git pull origin master command updates the local repository with that on the remote repository Same as doing both git add and git commit

20 Differences Between Local and Pulled Versions To see the differences (i.e., changes other people made to your file while you were away), will have to use log history git log --pretty=oneline

21 Differences Between Local and Pulled Versions Suppose the second commit down was my latest local commit, whereas the top commit is the most recent version from the remote repository Can use a standard git diff to see the differences between these two git diff --word-diff 58c738 e355a4

22

23 Working on Separate Aspects of a Project Many times when we work collaboratively, different people will be working on different aspects of a project, and only occasionally bring them together into one product. Writing different sections of a paper Working on code that does different parts of a routine etc.

24 Working on Separate Aspects of a Project In these cases, it doesn t make sense for all changes to be to master. Harder to track changes to specific sections Easier to mess up master Better to have each person working on a separate branch Still regularly synched with remote repository, but easier to track changes in each branch

25 Working on Separate Aspects of a Project Suppose I m writing a paper with someone else (Brenna). I am going to work on the Introduction, and she is going to work on the Methods Make a branch for each of these

26 Working on Separate Aspects of a Project First for the Introduction git checkout -b introduction master master introduction

27 Working on Separate Aspects of a Project Then the Methods git checkout -b methods master master methods introduction

28 Working on Separate Aspects of a Project On my introduction branch*, I create some new files and use git add and git commit to add them to my local repository To push these to the repository the first time, I use the following command git push -u origin introduction:intruduction Format is git push origin <local-branch-name>:<remote-branch-name> After this initial push, all others don t need the -u argument, e.g. git push origin introduction:introduction *A guide to switching branches is included at the end of these instructions

29 Working on Separate Aspects of a Project On her methods branch, Brenna creates some new files and use git add and git commit to add them to her local repository To push these to the repository the first time, she uses the following command git push -u origin methods:methods After this initial push, all others don t need the -u argument, e.g. git push origin methods:methods

30 Working on Separate Aspects of a Project Note that you have to push and pull each branch independently If I want to see Brenna s latest version of her Methods, I would type: git pull origin methods:methods If she wants to see my latest version of the Introduction, she would type: git pull origin introduction:introduction

31

32 Switching Branches Can tell what branch you re on by typing: git branch

33 Switching Branches Can tell what branch you re on by typing: git branch Shows I have 3 branches: introduction, master, and surface_structure. Also indicates that I am currently on the master branch.

34 Switching Branches Use the checkout command to change branches git checkout introduction git branch

35 Revised Workflow git pull origin <local-branch-name>:<remote-branch-name> at the beginning of each session to get most recent versions from remote repository git push origin <local-branch-name>:<remote-branch-name> at the end of each session to synch remote repository Work with files git add... git commit... at the end of each session to synch local repository

36 Creative Commons License Anyone is allowed to distribute, remix, tweak, and build upon this work, even commercially, as long as they credit me for the original creation. See the Creative Commons website for more information. Click here to go back to beginning