Difference between revisions of "Annotated Git session using the sim-recon repository"

From GlueXWiki
Jump to: navigation, search
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
 +
I needed to update one monitoring plugin file, which was in a non-git directory in my home area.  This was the best way to go about it:
  
−
I needed to update one monitoring plugin file, which was in a non-git directory in my home area.  This was the best way to go about it.
+
Make a local copy of the entire sim-recon repository for myself.  This took about 5 seconds. OR... be sure to checkout the master branch and update it.
−
 
+
<pre style="color:darkblue">
−
 
+
−
Make a local copy of the entire sim-recon repository for myself.  This took about 5 seconds.
+
−
 
+
−
 
+
−
<span style="color:blue"><pre>
+
 
cd ~
 
cd ~
 
mkdir git
 
mkdir git
 
cd git
 
cd git
 
git clone https://github.com/JeffersonLab/sim-recon
 
git clone https://github.com/JeffersonLab/sim-recon
−
</pre></span>
+
</pre>
−
>
+
 
−
>
+
Check that the plugin in the repository is what I think it is   
−
> Check that the plugin in the repository is what I think it is   
+
<pre style="color:darkblue">
−
>
+
cd sim-recon/src/plugins/monitoring/CDC_online/
−
> cd sim-recon/src/plugins/monitoring/CDC_online/
+
git status
−
> git status
+
</pre>
−
>
+
 
−
>
+
Copy in my updated file  
−
> Copy in my updated file  
+
<pre style="color:darkblue">
−
>
+
cp ~/online/plugins/CDC_online/JEventProcessor_CDC_online.cc .
−
> cp ~/online/plugins/CDC_online/JEventProcessor_CDC_online.cc .
+
git status
−
> git status
+
</pre>
−
> # On branch master
+
<pre style="color:darkred">
−
> # Changed but not updated:
+
# On branch master
−
> #  (use "git add <file>..." to update what will be committed)
+
# Changed but not updated:
−
> #  (use "git checkout -- <file>..." to discard changes in working directory)
+
#  (use "git add <file>..." to update what will be committed)
−
> #
+
#  (use "git checkout -- <file>..." to discard changes in working directory)
−
> # modified:  JEventProcessor_CDC_online.cc
+
#
−
> #
+
# modified:  JEventProcessor_CDC_online.cc
−
>
+
#
−
>
+
</pre>
−
> List the changes between this copy and the original and make sure that they are all mine (use space to get to next page)
+
 
−
> git diff
+
 
−
>
+
List the changes between this copy and the original and make sure that they are all mine (use space to get to next page)
−
>
+
<pre style="color:darkblue">
−
> Make a new branch to contain and label my change
+
git diff
−
>
+
</pre>
−
> git branch cdcpluginupdate
+
 
−
> git status
+
 
−
> # On branch master
+
Make a new branch to contain and label my change
−
> # Changed but not updated:
+
 
−
> #  (use "git add <file>..." to update what will be committed)
+
<pre style="color:darkblue">
−
> #  (use "git checkout -- <file>..." to discard changes in working directory)
+
git branch cdcpluginupdate
−
> #
+
git status
−
> # modified:  JEventProcessor_CDC_online.cc
+
</pre>
−
> #
+
<pre style="color:darkred">
−
> no changes added to commit (use "git add" and/or "git commit -a")
+
# On branch master
−
>
+
# Changed but not updated:
−
>
+
#  (use "git add <file>..." to update what will be committed)
−
> Switch to the new branch, check the status and list the branches.  
+
#  (use "git checkout -- <file>..." to discard changes in working directory)
−
>
+
#
−
> git checkout cdcpluginupdate
+
# modified:  JEventProcessor_CDC_online.cc
−
> M src/plugins/monitoring/CDC_online/JEventProcessor_CDC_online.cc
+
#
−
> Switched to branch 'cdcpluginupdate'
+
no changes added to commit (use "git add" and/or "git commit -a")
−
>
+
</pre>
−
> git status
+
 
−
> # On branch cdcpluginupdate
+
Switch to the new branch, check the status and list the branches.  
−
> # Changes to be committed:
+
 
−
> #  (use "git reset HEAD <file>..." to unstage)
+
<pre style="color:darkblue">
−
> #
+
git checkout cdcpluginupdate
−
> # modified:  JEventProcessor_CDC_online.cc
+
</pre>
−
> #
+
<pre style="color:darkred">
−
>
+
M src/plugins/monitoring/CDC_online/JEventProcessor_CDC_online.cc
−
> git branch  
+
Switched to branch 'cdcpluginupdate'
−
> * cdcpluginupdate
+
</pre>
−
>   master
+
 
−
>
+
<pre style="color:darkblue">
−
>
+
git status
−
> Add the file to the list of files to be committed/uploaded to the repository
+
</pre>
−
> git add JEventProcessor_CDC_online.cc
+
<pre style="color:darkred">
−
>
+
# On branch cdcpluginupdate
−
> git status
+
# Changes to be committed:
−
> # On branch cdcpluginupdate
+
#  (use "git reset HEAD <file>..." to unstage)
−
> # Changes to be committed:
+
#
−
> #  (use "git reset HEAD <file>..." to unstage)
+
# modified:  JEventProcessor_CDC_online.cc
−
> #
+
#
−
> # modified:  JEventProcessor_CDC_online.cc
+
</pre>
−
> #
+
<pre style="color:darkblue">
−
>
+
git branch  
−
> Tell git to use my username and email address that I used when joining the GlueX github team
+
* cdcpluginupdate
−
>
+
   master
−
> git config --global user.name "Naomi Jarvis"
+
</pre>
−
> git config --global user.email "nsj@cmu.edu"
+
 
−
>
+
Add the file to the list of files to be committed/uploaded to the repository
−
>
+
<pre style="color:darkblue">
−
> Commit change to the local repository
+
git add JEventProcessor_CDC_online.cc
−
>
+
 
−
> git commit -m "updated cdc_online for fa125 new format"
+
git status
−
>
+
</pre>
−
>
+
<pre style="color:darkred">
−
> Send it to the remote repository.  The first branchname given is the local name, the second is the new name on the remote repo (usually no need to change it).
+
# On branch cdcpluginupdate
−
>
+
# Changes to be committed:
−
> git push origin cdcpluginupdate:cdcpluginupdate  
+
#  (use "git reset HEAD <file>..." to unstage)
−
> error: The requested URL returned error: 403 Forbidden while accessing https://github.com/JeffersonLab/sim-recon/info/refs
+
#
−
> fatal: HTTP request failed
+
# modified:  JEventProcessor_CDC_online.cc
−
>
+
#
−
> This did not work, check the age of git
+
</pre>
−
>
+
 
−
> git —version
+
Commit change to the local repository
−
> git version 1.7.1
+
<pre style="color:darkblue">
−
>
+
git commit -m "updated cdc_online for fa125 new format"
−
> Try again from a different computer with a more recent git, as 1.7.1 is known to be problematic
+
</pre>
−
>
+
 
−
> git —version
+
Send it to the remote repository.  The first branchname given is the local name, the second is the new name on the remote repo (usually no need to change it).
−
> git version 2.5.0
+
<pre style="color:darkblue">
−
>
+
git push origin cdcpluginupdate:cdcpluginupdate  
−
> git push origin cdcpluginupdate:cdcpluginupdate  
+
</pre><pre style="color:darkred">
−
> Counting objects: 7, done.
+
error: The requested URL returned error: 403 Forbidden while accessing https://github.com/JeffersonLab/sim-recon/info/refs
−
> Delta compression using up to 4 threads.
+
fatal: HTTP request failed
−
> Compressing objects: 100% (7/7), done.
+
</pre>
−
> Writing objects: 100% (7/7), 1.43 KiB | 0 bytes/s, done.
+
This did not work, check the age of git
−
> Total 7 (delta 6), reused 0 (delta 0)
+
 
−
> To https://github.com/JeffersonLab/sim-recon
+
<pre style="color:darkblue">
−
> * [new branch]      cdcpluginupdate -> cdcpluginupdate
+
git —-version
−
>
+
</pre>
−
>
+
<pre style="color:darkred">
−
> ONE MORE THING.  Need to issue the pull request on the web page (for someone to approve the addition)
+
git version 1.7.1
−
>
+
</pre>
−
> Go to https://github.com/JeffersonLab/sim-recon and sign in on the RHS.
+
Try again from a different computer with a more recent git, as 1.7.1 is known to be problematic.  (At CMU, try Victor or usr/local/bin/git)
−
> Below ‘Simulation and Reconstruction for GlueX’ there was a pale yellow box showing the name of my new branch, and on the RHS inside the box was
+
 
−
> a green button ‘changes and pull request’.  Click it.
+
<pre style="color:darkblue">
−
>
+
git —-version
−
> Now wait for someone else to merge it. (or not).
+
</pre><pre style="color:darkred">
−
>
+
git version 2.5.0
 +
</pre>
 +
<pre style="color:darkblue">
 +
git push origin cdcpluginupdate:cdcpluginupdate  
 +
</pre><pre style="color:darkred">
 +
Counting objects: 7, done.
 +
Delta compression using up to 4 threads.
 +
Compressing objects: 100% (7/7), done.
 +
Writing objects: 100% (7/7), 1.43 KiB | 0 bytes/s, done.
 +
Total 7 (delta 6), reused 0 (delta 0)
 +
To https://github.com/JeffersonLab/sim-recon
 +
  * [new branch]      cdcpluginupdate -> cdcpluginupdate
 +
</pre>
 +
 
 +
ONE MORE THING.  Need to issue the pull request on the web page (for someone to approve the addition)
 +
 
 +
Go to https://github.com/JeffersonLab/sim-recon and sign in on the RHS.
 +
 
 +
Below ‘Simulation and Reconstruction for GlueX’ there was a pale yellow box showing the name of my new branch, and on the RHS inside the box was
 +
a green button ‘compare and pull request’.  Click it.
 +
 
 +
Now wait for someone else to merge it. (or not).
 +
 
 +
 
 +
 
 +
<h3>Other git things</h3>
 +
List tags: git tag -l<br/>
 +
Checkout tag: git checkout tagname<br/>
 +
Revert to tag called tagname: git reset --hard tagname<br/>
 +
<br/>
 +
Updating my local branch with changes in the remote master, eg to make my_branch consistent with tag 4.17.0:
 +
 
 +
<pre style="color:darkblue">
 +
git checkout master
 +
git pull
 +
git checkout 4.17.0
 +
git branch tag4.17.0
 +
 
 +
git checkout my_branch
 +
git merge tag4.17.0
 +
git commit
 +
</pre>
 +
I followed instructions to start up emacs and start the git server (M-x server-start, M is shift+command), typed a comment into the buffer, saved and exited emacs.

Latest revision as of 11:05, 1 March 2023

I needed to update one monitoring plugin file, which was in a non-git directory in my home area. This was the best way to go about it:

Make a local copy of the entire sim-recon repository for myself. This took about 5 seconds. OR... be sure to checkout the master branch and update it. 

cd ~
mkdir git
cd git
git clone https://github.com/JeffersonLab/sim-recon

Check that the plugin in the repository is what I think it is 

cd sim-recon/src/plugins/monitoring/CDC_online/
git status

Copy in my updated file 

cp ~/online/plugins/CDC_online/JEventProcessor_CDC_online.cc .
git status

# On branch master
# Changed but not updated:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#	modified:   JEventProcessor_CDC_online.cc
#


List the changes between this copy and the original and make sure that they are all mine (use space to get to next page) 

git diff


Make a new branch to contain and label my change 

git branch cdcpluginupdate
git status

# On branch master
# Changed but not updated:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#	modified:   JEventProcessor_CDC_online.cc
#
no changes added to commit (use "git add" and/or "git commit -a")

Switch to the new branch, check the status and list the branches. 

git checkout cdcpluginupdate

M	src/plugins/monitoring/CDC_online/JEventProcessor_CDC_online.cc
Switched to branch 'cdcpluginupdate'

git status

# On branch cdcpluginupdate
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#	modified:   JEventProcessor_CDC_online.cc
#

git branch 
* cdcpluginupdate
  master

Add the file to the list of files to be committed/uploaded to the repository 

git add JEventProcessor_CDC_online.cc

git status

# On branch cdcpluginupdate
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#	modified:   JEventProcessor_CDC_online.cc
#

Commit change to the local repository 

git commit -m "updated cdc_online for fa125 new format"

Send it to the remote repository. The first branchname given is the local name, the second is the new name on the remote repo (usually no need to change it). 

git push origin cdcpluginupdate:cdcpluginupdate 

error: The requested URL returned error: 403 Forbidden while accessing https://github.com/JeffersonLab/sim-recon/info/refs
fatal: HTTP request failed

This did not work, check the age of git 

git —-version

git version 1.7.1

Try again from a different computer with a more recent git, as 1.7.1 is known to be problematic. (At CMU, try Victor or usr/local/bin/git) 

git —-version

git version 2.5.0



git push origin cdcpluginupdate:cdcpluginupdate 

Counting objects: 7, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (7/7), done.
Writing objects: 100% (7/7), 1.43 KiB | 0 bytes/s, done.
Total 7 (delta 6), reused 0 (delta 0)
To https://github.com/JeffersonLab/sim-recon



* [new branch]      cdcpluginupdate -> cdcpluginupdate

ONE MORE THING. Need to issue the pull request on the web page (for someone to approve the addition)

Go to https://github.com/JeffersonLab/sim-recon and sign in on the RHS.

Below ‘Simulation and Reconstruction for GlueX’ there was a pale yellow box showing the name of my new branch, and on the RHS inside the box was a green button ‘compare and pull request’. Click it.

Now wait for someone else to merge it. (or not).


Other git things

List tags: git tag -l
Checkout tag: git checkout tagname
Revert to tag called tagname: git reset --hard tagname

Updating my local branch with changes in the remote master, eg to make my_branch consistent with tag 4.17.0: 

git checkout master
git pull
git checkout 4.17.0
git branch tag4.17.0

git checkout my_branch
git merge tag4.17.0
git commit

I followed instructions to start up emacs and start the git server (M-x server-start, M is shift+command), typed a comment into the buffer, saved and exited emacs.

Retrieved from "https://halldweb.jlab.org/wiki/index.php?title=Annotated_Git_session_using_the_sim-recon_repository&oldid=119472"