User Tools

Site Tools


wphase:repository

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
wphase:repository [2015/01/23 16:59]
wphase
wphase:repository [2015/02/03 11:06] (current)
wphase
Line 1: Line 1:
 ======= Using Git for W-phase ======= ======= Using Git for W-phase =======
  
-===== W-phase Index ===== +===== How to use Git ===== 
-  * [[wphase:​documentation|Documentation]] + 
-  * [[wphase:tutorial|Tutorial]] +Instead of repeating things that were said elsewhere, let us just give some pointers
-  * [[wphase:repository|Repository]] +  * [[http://​git-scm.com/​download|Download Git]] 
-  * [[wphase:realtime|Real-time]] +  * [[http://git-scm.com/|Git Community]] 
-  * [[wphase:​todo|Todo]] +  * [[http://​schacon.github.com/​git/​user-manual.html|Git User Manual]]
-  * [[wphase:discussion|Discussion]]+
  
-===== Configure ssh-keys for GitHub ===== 
  
-https://​help.github.com/​articles/​generating-ssh-keys 
  
 ===== Make sure your version of Git is OK ===== ===== Make sure your version of Git is OK =====
Line 32: Line 29:
 error: The requested URL returned error: 403 while accessing https://​github.com/​eost/​wphase.git/​info/​refs error: The requested URL returned error: 403 while accessing https://​github.com/​eost/​wphase.git/​info/​refs
 </​code>​ </​code>​
-please make sure to update git to version 1.7.10 or later (see above), otherwise use +please make sure to update git to version 1.7.10 or later (see above).
-<​code>​ +
-git clone https://​yourusername@github.com/​eost/​wphase.git wphase_package +
-</​code>​+
  
-===== Regular daily usage (for regular users) =====+===== Regular daily usage: master branch ​(for regular users) =====
  
-  * To update your local copy of the W-phase repository (pull changes)+  * To update your local copy of the W-phase repository (pull changes ​from the master branch, i.e., stable version)
 <​code>​ <​code>​
 cd /​to/​the/​wphase/​directory/​ cd /​to/​the/​wphase/​directory/​
 git pull origin master git pull origin master
 +</​code>​
 +
 +
 +===== Regular daily usage: develop branch (for developers) =====
 +
 +**If you would like to contribute or if you have any questions/​suggestions,​ [[zacharie.duputel@unistra.fr,​luis.rivera@unistra.fr|please contact us]].**
 +
 +  * After cloning the repository, one may want to list existing branches
 +<​code>​
 +git branch -a
 +</​code>​
 +
 +  * To update your local copy of the W-phase repository (pull changes from the develop branch)
 +<​code>​
 +git pull origin develop
 +* master
 +  remotes/​origin/​HEAD -> origin/​master
 +  remotes/​origin/​develop
 +  remotes/​origin/​master
 +</​code>​
 +Notice the * character that prefixes the "​master"​ branch: it indicates the branch that you currently have checked out. 
 +
 +   * If you want to work on the develop branch, you can create a local version using:
 +<​code>​
 +git checkout -b develop origin/​develop
 +</​code>​
 +
 +   * To see the last commit on each local branch, you can run 
 +<​code>​
 +git branch -v
 +* develop 308999e Enable python3 compatibility in bin/​traces_regional.py (...)
 +  master ​ 2f33728 Correction numero de version -> r249
 +</​code>​
 +
 +   * To switch from one branch to another
 +<​code>​
 +git checkout master
 +</​code>​
 +or
 +<​code>​
 +git checkout develop
 </​code>​ </​code>​
  
Line 55: Line 90:
 git diff git diff
 </​code> ​ </​code> ​
- 
-===== Regular daily usage (for developers) ===== 
  
    * To prepare the content staged for the next commit, use:    * To prepare the content staged for the next commit, use:
Line 67: Line 100:
 git commit -m "log message describing the changes"​ git commit -m "log message describing the changes"​
 </​code> ​ </​code> ​
 +
 +   * Before pushing the results, you can synchronise and see the local database using
 +<​code>​
 +git fetch origin
 +git branch -a
 +git branch -v
 +(etc...)
 +</​code>​
  
    * You can then push your changes to your GitHub fork    * You can then push your changes to your GitHub fork
 <​code>​ <​code>​
-git push origin ​master+git push origin ​develop
 </​code> ​ </​code> ​
 +
 +   * To merge develop into the master branch
 +<​code>​
 +git checkout master
 +git merge develop
 +</​code> ​
 +
 +   * To create a new version tag, edit "​Version:​ rXXX" in bin/​Arguments.py and bin/​RUNA3.csh. You should also add the corresponding tag using:
 +<​code>​
 +git tag -a rXXX -m "Short description of this release"​
 +</​code>​
 +
 +   * Listing the available tags in Git is straightforward. Just type
 +<​code>​
 +git tag
 +</​code>​
 +
 +   * You can also see the tag data along with the commit that was tagged by using
 +<​code>​
 +git show r252
 +</​code>​
 +===== Configure ssh-keys for GitHub =====
 +
 +https://​help.github.com/​articles/​generating-ssh-keys
  
wphase/repository.1422028746.txt.gz · Last modified: 2015/01/23 16:59 by wphase