Differences

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

--- git:get_started [2018/08/27 10:37] – [Generating and Registering an SSH Encryption Key] typos
+++ git:get_started [2024/08/20 21:38] (current) – external edit 127.0.0.1
@@ Line 55: / Line 55: @@
 An example sequence of commands and the expected terminal output is illustrated,
-{{git:gt_git_term_scrn.png?600x0|Generate SSH Encryption Keys}}
+{{git:gt_git_term_scrn.png?900x0|Generate SSH Encryption Keys}}
+. **Register SSH Encryption Public Key:**
+Now that we've generated an SSH public-private encryption key-pair, we need to let GitHub Enterprise know the public key and that it is associated to your account.
+In a web browser, go to [[https://github.gatech.edu | https://github.gatech.edu]]. Login using your GT username and password. At the welcome screen/dashboard page, click on the 'identicon' (5x5 pixelated image created from a hash unique to your account) in the upper right. Click 'Settings' from the drop down menu,
+{{git:gt_git_welcome_settings.png?600x0|GitHub Account Settings}}
+Under 'Personal Settings', on the left-hand side, select 'SSH and GPG keys'. Then press the 'New SSH key' button in the top right,
+{{git:gt_git_ssh_keys_scrn.png?600x0|GitHub Account SSH Keys}}
+Here, we'll add the public encryption key you previously generated from the terminal,
+{{git:gt_git_add_ssh_key_scrn.png?600x0|GitHub Account Add SSH Key}}
+In the '**Title**' field, enter a name for this key. The name should be something indicative of the machine on which this encryption key was generated. You may want to access GT's GitHub Enterprise from multiple machines; each machine will need to have an SSH public encryption key registered here. To distinguish which key belongs to which machine, a suggestion is to include the machine's 'hostname' in the name assigned in the 'Title' field (eg. 'smokescreen_ivalab').
+In the '**Key**' field, paste the public key contents you previously copied from the command ''cat <filename>.pub''. If you are unsure what text to copy, example text (to copy) is highlighted in the prior image of the Linux terminal. Note that text to be copied will begin with 'ssh-rsa '.
+===== GitHub Organization  =====
+Version-controlled files are organized into repositories maintained on GitHub Enterprise. An individual repository may contain all code, documentation and some data files associated with a single project. Furthermore, several commonly-themed repositories may be organized into a single git 'Organization'.
+Any Git Organization accessible to you will be display in a drop down menu when you click on your account name (top left) on the welcome/dashboard page.
+{{git:gt_git_select_org.png?600x0|Git Org List}}
+As an example, the IVALab has created an 'ivaMatlibs' Organization which contains several repositories housing commonly used Matlab code/libraries/utilities. Clicking on the Organization, from the drop down menu, then brings us to the Organization page, where all contained repositories are listed on the right-hand side, under 'Repositories'.
+{{git:gt_git_org_repos.png?600x0|Git Org Repo List}}
+We can select a repository from this list, 'groups', for example. This brings us the 'groups' Git repository web page. We can manage the repository from here as well as grab its SSH URL to later clone the repository onto a local machine,
+{{git:gt_git_copy_repo_url.png?600x0|Git Repo URL}}
+===== Clone a Repository  =====
+Here we present an example walk through in which we will clone a repository, 'rubbleTracker', onto our machine.
+From the 'Snakey' Organization web page, we select the 'rubbleTracker' repository from the 'Repositories' list on the right-hand side. This brings us to the 'rubbleTracker' Git repository page,
+{{git:gt_git_snakey_rubbletracker_scrn.png?600x0|rubbleTracker Repo URL}}
+Select 'Clone or download' to reveal the repository's URL. If the box that pops up is titled 'Clone with HTML', select the 'Use SSH' link on the top right of that box. We prefer all repositories be cloned via SSH and not HTML. The pop-up box should be titled, 'Clone with SSH'. Copy the URL in the text box (hint: begins with 'git@github.gatech.edu: ' and contains the repository name).
+Next, open a terminal. Create a directory, in your /home area, within which you'd like clone and work on Git repositories. For the sake of this example, we'll name this directory 'gt_git/'.
+<code>
+cd
+mkdir gt_git
+</code>
+Next, create a directory for the Git Organization in which the repository resides. In this case, the 'rubbleTracker' repo resides within the 'Snakey' Organization.
+<code>
+cd ~/gt_git
+mkdir Snakey
+cd Snakey/
+</code>
+Now clone the repository,
+<code>
+git clone git@github.gatech.edu:Snakey/rubbleTracker.git
+</code>
+A snapshot of expected terminal output is illustrated,
+{{git:gt_git_snakey_rubbletracker_term_scrn.png?600x0|Clone rubbleTracker Terminal}}
+===== Add a File to Repository  =====
+Let's a add a new file to our repository!
+<code>
+cd ~/gt_git/Snakey/rubbleTracker
+touch my_new_file.txt
+ls
+</code>
+A new file named 'my_new_file.txt' has been added in the directory, '~/gt_git/Snakey/rubbleTracker'.
+The following command will inform you of whether changes have been made to your local (version of the) repository, causing it to be out of sync with the remote repository.
+<code>
+git status
+</code>
+We first need to inform Git of any new files that it must track on our local machine.
+<code>
+git add my_new_file.txt
+</code>
+Now that the file is tracked, we can 'commit' it to be staged for the next push to the remote repository.
+<code>
+git commit -m "added new example text file"
+</code>
+The '-m' flag allows you to specify text describing the changes being committed. You should **ALWAYS** do this!
+Finally, we can push the staged changes to the remote repository,
+<code>
+git push origin master
+</code>
+Expected terminal output,
+{{git:gt_git_add_new_file.png?600x0|Add File to rubbleTracker - Terminal}}
+===== Update a File in Repository  =====
+We previously added an empty file, 'my_new_file.txt', to the repository.
+Now let's modify it and update the changes to the remote repository!
+<code>
+cd ~/gt_git/Snakey/rubbleTracker
+echo "Hello World!" >> my_new_file.txt
+cat my_new_file.txt
+</code>
+The commands above were a quick way to add simple text to our previously empty file. It now contains the text 'Hello World!'.
+If we run ''git status'', we see that Git is tracking the 'my_new_file.txt' and acknowledges there has been a modification to the file.
+Commit the changed file so that it can be uploaded to the remote server,
+<code>
+git commit -am "added some example text"
+</code>
+The '-a' flag specifies to automatically add any files currently tracked by git (that have been modified) to be staged for upload to the remote repo. The '-m' flag allows the user to enter descriptive text briefly describing the changes.
+Now push the staged changes to the remote repository,
+<code>
+git push origin master
+</code>
+Example terminal output is illustrated,
+{{git:gt_git_modify_file_term.png?600x0|Modify File in rubbleTracker - Terminal}}
+We additionally, see that the new file has been added via the repository's browser page,
+{{git:gt_git_modify_file_browser.png?600x0|Modify File in rubbleTracker - Browser}}
+===== Remove a File from Repository  =====
+In our final example walk through, we'll remove the text file we created from the repository and propagate this update/deletion to the remote repository.
+<code>
+cd ~/gt_git/Snakey/rubbleTracker
+git rm my_new_file.txt
+</code>
+''git rm'' will remove a file both from the local file system as well as from the list of files that git tracks for changes. Running ''git status'' will show that git has marked this file for deletion.
+Commit the change (ie. file deletion) to be staged for upload to the remote rpo.
+<code>
+git commit -m "removed example file"
+</code>
+Push the change,
+<code>
+git push origin master
+</code>
+Example terminal output is illustrated,
+{{git:gt_git_rm_file_term.png?600x0|Remove File from rubbleTracker - Terminal}}