Git repository - Revision history

Nsallin at 21:02, 8 August 2025

2025-08-08T21:02:29Z

← Older revision		Revision as of 23:02, 8 August 2025
Line 107:		Line 107:

	Finally go on your local machine and use the ''git clone'' command:		Finally go on your local machine and use the ''git clone'' command:
	<pre~~><code~~>		<pre>
	git clone git@github.com:LHEP-neutrino/<your_repo>.git		git clone git@github.com:LHEP-neutrino/<your_repo>.git
	~~</code>~~</pre>		</pre>
	You are ready to go and do your super important work that now can be easily saved! Don't forget to pick the good manners like working on a branch, pulling the remote regularly to get the latest changes and pushing your work regularly to save it on the remote repo, and so on. You can find plenty of tutorials on basic uses or advances uses (like issue report, version release, CI/CO pipeline integration, ...), don't hesitate to ameliorate the LHEP github :).		You are ready to go and do your super important work that now can be easily saved! Don't forget to pick the good manners like working on a branch, pulling the remote regularly to get the latest changes and pushing your work regularly to save it on the remote repo, and so on. You can find plenty of tutorials on basic uses or advances uses (like issue report, version release, CI/CO pipeline integration, ...), don't hesitate to ameliorate the LHEP github :).

Nsallin at 21:02, 8 August 2025

2025-08-08T21:02:13Z

← Older revision		Revision as of 23:02, 8 August 2025
Line 107:		Line 107:

	Finally go on your local machine and use the ''git clone'' command:		Finally go on your local machine and use the ''git clone'' command:
	<code>		<pre><code>
	git clone git@github.com:LHEP-neutrino/<your_repo>.git		git clone git@github.com:LHEP-neutrino/<your_repo>.git
	</code>		</code></pre>
	You are ready to go and do your super important work that now can be easily saved! Don't forget to pick the good manners like working on a branch, pulling the remote regularly to get the latest changes and pushing your work regularly to save it on the remote repo, and so on. You can find plenty of tutorials on basic uses or advances uses (like issue report, version release, CI/CO pipeline integration, ...), don't hesitate to ameliorate the LHEP github :).		You are ready to go and do your super important work that now can be easily saved! Don't forget to pick the good manners like working on a branch, pulling the remote regularly to get the latest changes and pushing your work regularly to save it on the remote repo, and so on. You can find plenty of tutorials on basic uses or advances uses (like issue report, version release, CI/CO pipeline integration, ...), don't hesitate to ameliorate the LHEP github :).

Nsallin at 21:01, 8 August 2025

2025-08-08T21:01:18Z

← Older revision		Revision as of 23:01, 8 August 2025
Line 19:		Line 19:
	The '''remote''' github acts as the main repository. You can '''clone''' this repository on '''local''' machine which allows you to work on it. Once your work done, you can '''push''' your work from your local to the remote repo, such that it is saved in the cloud and other people can access it. On the other way around, if somebody else pushed something from their local repo to the remote one, then you can '''pull''' the changes from the remote repo to your local one such that you can use the work from others.		The '''remote''' github acts as the main repository. You can '''clone''' this repository on '''local''' machine which allows you to work on it. Once your work done, you can '''push''' your work from your local to the remote repo, such that it is saved in the cloud and other people can access it. On the other way around, if somebody else pushed something from their local repo to the remote one, then you can '''pull''' the changes from the remote repo to your local one such that you can use the work from others.

	To clone a repo, first you will have to 'link' your machine to the remote repo. An easy way to do this is to set up an ssh key, follow [https://docs.github.com/en/authentication/connecting-to-github-with-ssh this tutorial], under generate a new ssh key. Note that if you want to clone many repo on the same machine, you will have to generate one key per repo. If you do not want to add your ssh key to your agent everytime you connect to your machine, you can add the following commands in the ''.bashrc'' or ''.bash_profile'':		To clone a repo, first you will have to 'link' your machine to the remote repo. An easy way to do this is to set up an ssh key pair on your local machine and register it on github, follow [https://docs.github.com/en/authentication/connecting-to-github-with-ssh this tutorial], under generate a new ssh key. Note that if you want to clone many repo on the same machine, you will have to generate one key per repo. If you do not want to add your ssh key to your agent everytime you connect to your machine, you can add the following commands in the ''.bashrc'' or ''.bash_profile'':
	<div class="toccolours mw-collapsible mw-collapsed" style="width=100%; overflow:auto;">		<div class="toccolours mw-collapsible mw-collapsed" style="width=100%; overflow:auto;">
	<div style="font-weight:bold;line-height:1.6;">Automatically add your ssh key(s) to the ssh-agent </div>		<div style="font-weight:bold;line-height:1.6;">Automatically add your ssh key(s) to the ssh-agent </div>
Line 97:		Line 97:
	</div></div>		</div></div>

	Once your key is set up, you are ready to clone the repo on your local machine.		Once your key is set up, you are ready to clone the repo on your local machine. See the following screenshot for the number references

	[[File:Git_HowToClone_LHEP.png\|thumb\|upright=2.3\|Where to find the ssh address of the git repo]]		[[File:Git_HowToClone_LHEP.png\|thumb\|upright=2.3\|Where to find the ssh address of the git repo]]
Line 103:		Line 103:
	# Select ssh		# Select ssh
	# Copy the repo link		# Copy the repo link

			Note that if you have many repos on the same machine you will have to use an alias host instead of ''github.com'' and register it in a config file as described [https://docs.github.com/en/authentication/connecting-to-github-with-ssh/managing-deploy-keys#using-multiple-repositories-on-one-server here].

			Finally go on your local machine and use the ''git clone'' command:
			<code>
			git clone git@github.com:LHEP-neutrino/<your_repo>.git
			</code>
			You are ready to go and do your super important work that now can be easily saved! Don't forget to pick the good manners like working on a branch, pulling the remote regularly to get the latest changes and pushing your work regularly to save it on the remote repo, and so on. You can find plenty of tutorials on basic uses or advances uses (like issue report, version release, CI/CO pipeline integration, ...), don't hesitate to ameliorate the LHEP github :).

Nsallin at 20:35, 8 August 2025

2025-08-08T20:35:38Z

← Older revision		Revision as of 22:35, 8 August 2025
Line 99:		Line 99:
	Once your key is set up, you are ready to clone the repo on your local machine.		Once your key is set up, you are ready to clone the repo on your local machine.

	[[File:Git_HowToClone_LHEP.png\|thumb\|upright=2.3\|~~How~~ to ~~clone a~~ git repo.]]		[[File:Git_HowToClone_LHEP.png\|thumb\|upright=2.3\|Where to find the ssh address of the git repo]]
	# Click on the expandable green clone button		# Click on the expandable green clone button
	# Select ssh		# Select ssh
	# Copy the repo link		# Copy the repo link

Nsallin at 20:34, 8 August 2025

2025-08-08T20:34:54Z

← Older revision		Revision as of 22:34, 8 August 2025
Line 97:		Line 97:
	</div></div>		</div></div>

	Once your key is set up, you are ready to clone the repo on your local machine		Once your key is set up, you are ready to clone the repo on your local machine.

	[[File:Git_HowToClone_LHEP.png\|thumb\|upright=1.~~5\|center~~\|How to clone a git repo.]]		[[File:Git_HowToClone_LHEP.png\|thumb\|upright=2.3\|How to clone a git repo.]]
			# Click on the expandable green clone button
			# Select ssh
			# Copy the repo link

Nsallin at 20:32, 8 August 2025

2025-08-08T20:32:51Z

← Older revision		Revision as of 22:32, 8 August 2025
Line 99:		Line 99:
	Once your key is set up, you are ready to clone the repo on your local machine		Once your key is set up, you are ready to clone the repo on your local machine

	[[File:Git_HowToClone_LHEP.png\|thumb\|center\|How to clone a git repo.]]		[[File:Git_HowToClone_LHEP.png\|thumb\|upright=1.5\|center\|How to clone a git repo.]]

Nsallin at 20:25, 8 August 2025

2025-08-08T20:25:47Z

← Older revision		Revision as of 22:25, 8 August 2025
Line 96:		Line 96:
	</pre>		</pre>
	</div></div>		</div></div>

			Once your key is set up, you are ready to clone the repo on your local machine

			[[File:Git_HowToClone_LHEP.png\|thumb\|center\|How to clone a git repo.]]

Nsallin at 20:11, 8 August 2025

2025-08-08T20:11:52Z

← Older revision		Revision as of 22:11, 8 August 2025
Line 23:		Line 23:
	<div style="font-weight:bold;line-height:1.6;">Automatically add your ssh key(s) to the ssh-agent </div>		<div style="font-weight:bold;line-height:1.6;">Automatically add your ssh key(s) to the ssh-agent </div>
	<div class="mw-collapsible-content">		<div class="mw-collapsible-content">
	<~~syntaxhighlight lang="bash"~~>		<pre>
	# Run the ssh-agent if not running yet		# Run the ssh-agent if not running yet

Line 94:		Line 94:
	ssh-add ~/.ssh/id_ed25519_your_ssh_key0 &>/dev/null		ssh-add ~/.ssh/id_ed25519_your_ssh_key0 &>/dev/null
	ssh-add ~/.ssh/id_ed25519_your_ssh_key1 &>/dev/null		ssh-add ~/.ssh/id_ed25519_your_ssh_key1 &>/dev/null
	</~~syntaxhighlight~~>		</pre>
	</div></div>		</div></div>

Nsallin: Created page with "From the https://docs.github.com/en/get-started/start-your-journey/about-github-and-git official Github website:
GitHub is a cloud-based platform where you can store, share, and work together with others to write code. Storing your code in a "repository" on GitHub allows you to: * Showcase or share your work. * Track and manage changes to your code over time. * Let others review your code, and make suggestions to improve it. * Collaborate on a shared..."

2025-08-08T20:10:39Z

Created page with "From the https://docs.github.com/en/get-started/start-your-journey/about-github-and-git official Github website: <blockquote> GitHub is a cloud-based platform where you can store, share, and work together with others to write code. Storing your code in a "repository" on GitHub allows you to: * Showcase or share your work. * Track and manage changes to your code over time. * Let others review your code, and make suggestions to improve it. * Collaborate on a shared..."

New page

From the [[https://docs.github.com/en/get-started/start-your-journey/about-github-and-git official Github website]]:
<blockquote>
GitHub is a cloud-based platform where you can store, share, and work together with others to write code.

Storing your code in a "repository" on GitHub allows you to:

* Showcase or share your work.
* Track and manage changes to your code over time.
* Let others review your code, and make suggestions to improve it.
* Collaborate on a shared project, without worrying that your changes will impact the work of your collaborators before you're ready to integrate them.
* Collaborative working, one of GitHub’s fundamental features, is made possible by the open-source software, Git, upon which GitHub is built.
</blockquote>
The [https://github.com/LHEP-neutrino LHEP Github] is the place where the repos should be stored in order to be accessible throughout LHEP members. It is a very good practice to work from repos, as cited, this helps keeping track of your work and allow others to easily use it.

== Getting access to LHEP Github ==
If you aren't a member yet, (once you have an [https://github.com/signup account]) contact an owner (e.g. [[mailto:serhan.tufanli@unibe.ch Serhan]] or [[mailto:nicolas.sallin@unibe.ch Nicolas]]) to get added. Then you will be able to create your repository or use an already existing one.

== Cloning the repo on a local machine ==
The '''remote''' github acts as the main repository. You can '''clone''' this repository on '''local''' machine which allows you to work on it. Once your work done, you can '''push''' your work from your local to the remote repo, such that it is saved in the cloud and other people can access it. On the other way around, if somebody else pushed something from their local repo to the remote one, then you can '''pull''' the changes from the remote repo to your local one such that you can use the work from others.

To clone a repo, first you will have to 'link' your machine to the remote repo. An easy way to do this is to set up an ssh key, follow [https://docs.github.com/en/authentication/connecting-to-github-with-ssh this tutorial], under generate a new ssh key. Note that if you want to clone many repo on the same machine, you will have to generate one key per repo. If you do not want to add your ssh key to your agent everytime you connect to your machine, you can add the following commands in the ''.bashrc'' or ''.bash_profile'':
<div class="toccolours mw-collapsible mw-collapsed" style="width=100%; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">Automatically add your ssh key(s) to the ssh-agent </div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="bash">
# Run the ssh-agent if not running yet

# Function to start a new agent and save its info
# from https://docs.vscentrum.be/accounts/ssh_agent.html
start-ssh-agent() {
#
# Start an ssh agent if none is running already.
# * First we try to connect to one via SSH_AUTH_SOCK
# * If that doesn't work out, we try via the file ssh-agent-environment
# * And if that doesn't work out either, we just start a fresh one and write
# the information about it to ssh-agent-environment for future use.
#
# We don't really test for a correct value of SSH_AGENT_PID as the only
# consequence of not having it set seems to be that one cannot kill
# the ssh-agent with ssh-agent -k. But starting another one wouldn't
# help to clean up the old one anyway.
#
# Note: ssh-add return codes:
# 0 = success,
# 1 = specified command fails (e.g., no keys with ssh-add -l)
# 2 = unable to contact the authentication agent
#
sshfile=~/.ssh/ssh-agent-env
#
# First effort: Via SSH_AUTH_SOCK/SSH_AGENT_PID
#
if [ -n "$SSH_AUTH_SOCK" ]; then
# SSH_AUTH_SOCK is defined, so try to connect to the authentication agent
# it should point to. If it succeeds, reset newsshagent.
ssh-add -l &>/dev/null
if [[ $? != 2 ]]; then
echo "SSH agent already running."
unset sshfile
return 0
else
echo "Could not contact the ssh-agent pointed at by SSH_AUTH_SOCK, trying more..."
fi
fi
#
# Second effort: If we're still looking for an ssh-agent, try via $sshfile
#
if [ -e "$sshfile" ]; then
# Load the environment given in $sshfile
. $sshfile &>/dev/null
# Try to contact the ssh-agent
ssh-add -l &>/dev/null
if [[ $? != 2 ]]; then
echo "SSH agent already running; reconfigured the environment."
unset sshfile
return 0
else
echo "Could not contact the ssh-agent pointed at by $sshfile."
fi
fi
#
# And if we haven't found a working one, start a new one...
#
#Create a new ssh-agent
echo "Creating new SSH agent."
ssh-agent -s > $sshfile && . $sshfile
unset sshfile
}

# Start the ssh-agent
start-ssh-agent
#&>/dev/null

# Add the key
ssh-add ~/.ssh/id_ed25519_your_ssh_key0 &>/dev/null
ssh-add ~/.ssh/id_ed25519_your_ssh_key1 &>/dev/null
</syntaxhighlight>
</div></div>