Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tools:github [2025/10/16 10:44] – [Github setup] willtools:github [2026/06/17 14:13] (current) – [Github setup] will
Line 1: Line 1:
 ====== Github setup ====== ====== Github setup ======
 +Github (the source forge) speaks but is not ''git'' (the local-first distributed source control management software)! See [[:tools:git]] for using the ''git'' command line tool.
 +
 +See [[:tools:zenodo]] for creating a DOI for your code hosted on Github.com.
 +
  
 Github setup includes Github setup includes
-  - creating or finding an existing remote github repository url+  - [[#new_repo|creating]] or [[#existing_repo|finding]] an existing remote github repository url 
 +    * use **ssh** url like ''git@github.com:group/repo'' (instead of ''%%https://github.com/group/repo%%'') 
 +    * avoid conflicting histories: <wrap important>dont generate a readme when creating a new repo</wrap> 
   - syncing that with your files (on your computer, on rhea, on PSC, etc)   - syncing that with your files (on your computer, on rhea, on PSC, etc)
-  - authenticating with github for ''git push'' permissions. <wrap tip>ssh keys recommended</wrap> <wrap alert> ''sshkey-gen'' only once per user@server. don't run if existing ''~/.ssh/id*.pub''</wrap>+    * <wrap tip> be sure you ''cd'' to the right directory before running ''git'' commands</wrap> 
 +  - [[#ssh_keys|authenticating]] with github for ''git push'' permissions. See [[https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys|connecting-to-github-with-ssh]] 
 +    * <wrap tip>ssh keys recommended</wrap> 
 +    * <wrap alert> ''ssh-keygen'' only once per user@server. don't run if existing ''~/.ssh/id*.pub''</wrap>
  
 ===== New Repo ===== ===== New Repo =====
  
 <WRAP alert> <WRAP alert>
-If you have an existing directory you want to put on github, **DO NOT** generate a readme when creating the  github repository.+If you have an existing directory you want to put on github, **DO NOT** generate a readme when creating the  github repository. Instead, use the [[#existing_repo|Existing Repo section]] below instead.
 </WRAP> </WRAP>
    
   *  {{.:pasted:20251016-101712.png?100}} http://github.com/new or Home > green new repo   *  {{.:pasted:20251016-101712.png?100}} http://github.com/new or Home > green new repo
-  * {{.:pasted:20251016-101911.png?100}} Follow form to assign a name.  <wrap tip>only add readme, lic, etc if no project files exist yet</wrap>  +  * {{.:pasted:20251016-101911.png?100}} Follow form to assign a name.  <wrap important>only add readme, lic, etc if no project files exist locally yet</wrap>  
-  * {{.:pasted:20251016-102226.png?200}} Follow the instructions github provides  <code bash add_remote.bash>+  * {{.:pasted:20251016-102226.png?200}} Follow the instructions github provides <wrap tip>be sure to ''cd'' into the code directory before running ''git'' commands</wrap>  <code bash add_remote.bash>
 cd my-exsiting-data/ # go to the directory of your existing code cd my-exsiting-data/ # go to the directory of your existing code
 git remote add origin git@github.com:$USER/$REPONAME git remote add origin git@github.com:$USER/$REPONAME
Line 20: Line 29:
  
 ===== Existing Repo ===== ===== Existing Repo =====
 +
 +To get existing code onto your local workstation or server environment, run ''git clone'' to create a new local directory with the remote code.
  
   * Copy the ssh url of your new repository. Green ''<> Code'' button > ''Local'' Tab > ''SSH'' header.   * Copy the ssh url of your new repository. Green ''<> Code'' button > ''Local'' Tab > ''SSH'' header.
 {{:tools:pasted:20251016-101450.png?200|}} {{:tools:pasted:20251016-101450.png?200|}}
-  * Clone the copied url like ''git clone git@github.com/$USER/$REPO''+  * Clone the copied url like <code bash>git clone git@github.com/$USER/$REPO</code>
 ===== Authentication ===== ===== Authentication =====
-For ''git push'' to  github, you'll need some way to confirm your credentials. Authentication can happen with <wrap tip>**ssh keys** (recommended)</wrap> or an **app password**+Find github instructions on [[https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys|connecting-to-github-with-ssh]]. 
 + 
 +For ''git push'' to  github, you'll need some way to confirm your credentials. Authentication can happen with <wrap tip>**ssh keys** (recommended)</wrap> or an **app password**   
 + 
 +when using ssh keys (recommended) use ''git@github.com:group/repo'' (repo url) to use ssh-key based authentication -- on the terminal you can  
 +switch from https to ssh using ''vim .git/config''. 
 + 
 +{{.:pasted:20251212-153335.png}}
 ==== ssh keys ==== ==== ssh keys ====
  
-''git push'' can use ssh authentication. You need a key likely in ''~/.ssh/id_ed25519.pub''. +''git push'' can use ssh authentication unique to a user and computer pair. You need a key likely in ''~/.ssh/id_ed25519.pub''.
  
  
 Contents of ''~/.ssh/id_ed25519.pub'' should be pasted into ''new ssh key'' modal on https://github.com/settings/keys ((''top right user icon''->''settings''->''ssh and GPG keys'' -> ''new ssh key'')) Contents of ''~/.ssh/id_ed25519.pub'' should be pasted into ''new ssh key'' modal on https://github.com/settings/keys ((''top right user icon''->''settings''->''ssh and GPG keys'' -> ''new ssh key''))
 +<code bash>
 +cat ~/.ssh/id_ed25519.pub
 +</code>
 +
  
 {{:tools:pasted:20231024-130110.png?300}} {{:tools:pasted:20231024-130110.png?300}}