Difference between revisions of "GitHubWorkflow"
Jump to navigation
Jump to search
(Created page with "==Introduction== This page describes a recommended git workflow for use with the Mu2e Offline code once we have switched to GitHub.") |
|||
Line 2: | Line 2: | ||
This page describes a recommended git workflow for use with the Mu2e Offline code once we have switched to GitHub. | This page describes a recommended git workflow for use with the Mu2e Offline code once we have switched to GitHub. | ||
+ | |||
+ | ==Downloading Offline as a user and NOT a developer== | ||
+ | <b>Option 1</b>: you want the default primary version of the code (most people): | ||
+ | <ol style="list-style-type:roman"> | ||
+ | <li>clone the repo:</li> | ||
+ | git clone https://github.com/mu2e/Offline | ||
+ | <li>Done!</li> | ||
+ | </ol> | ||
+ | |||
+ | <b>Option 2</b>: A particular collaborator has a version or branch you want to use: | ||
+ | <ol style="list-style-type:roman"> | ||
+ | <li> Find their github user name</li> | ||
+ | <li> Determine what the name of the branch they are working on is (Note: this can be master!) | ||
+ | <li> Clone their fork:</li> | ||
+ | git clone https://github.com/<user name>/Offline | ||
+ | cd Offline | ||
+ | git checkout origin/<branch name> | ||
+ | <li>Done!</li> | ||
+ | </ol> | ||
+ | |||
+ | <b>Option 3</b>: You want to us pgit to avoid a long compilation time (IN PROGRESS) | ||
+ | <ol style="list-style-type:roman"> | ||
+ | <li> Create new directory to put your Offline repo in and move to that directory</li> | ||
+ | mkdir Offline | ||
+ | cd Offline | ||
+ | <li> As in Option 2, determine fork and branch name you wish to use</li> | ||
+ | <li> Create a partial checkout clone</li> | ||
+ | pgit2 setup https://github.com/<user name (or mu2e)>/Offline <branch name> | ||
+ | <li> You can now use as normal:</li> | ||
+ | source setup.sh | ||
+ | scons -j 4 | ||
+ | </ol> |
Revision as of 21:07, 16 August 2019
Introduction
This page describes a recommended git workflow for use with the Mu2e Offline code once we have switched to GitHub.
Downloading Offline as a user and NOT a developer
Option 1: you want the default primary version of the code (most people):
- clone the repo: git clone https://github.com/mu2e/Offline
- Done!
Option 2: A particular collaborator has a version or branch you want to use:
- Find their github user name
- Determine what the name of the branch they are working on is (Note: this can be master!)
- Clone their fork: git clone https://github.com/<user name>/Offline cd Offline git checkout origin/<branch name>
- Done!
Option 3: You want to us pgit to avoid a long compilation time (IN PROGRESS)
- Create new directory to put your Offline repo in and move to that directory mkdir Offline cd Offline
- As in Option 2, determine fork and branch name you wish to use
- Create a partial checkout clone pgit2 setup https://github.com/<user name (or mu2e)>/Offline <branch name>
- You can now use as normal: source setup.sh scons -j 4