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 11:01] – [Github setup] willtools:github [2026/04/17 09:55] (current) – [Github setup] will
Line 1: Line 1:
 ====== Github setup ====== ====== Github setup ======
 Github (source forge) is not git (local-first distributed source control management software)! See [[:tools:git]] for using ''git''. Github (source forge) is not git (local-first distributed source control management software)! See [[:tools:git]] for using ''git''.
 +
 +See [[:tools:zenodo]] for creating a DOI for your code hosted on Github.com.
  
  
 Github setup includes Github setup includes
   - [[#new_repo|creating]] or [[#existing_repo|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>      * 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)
Line 31: Line 34:
   * Clone the copied url like <code bash>git clone git@github.com/$USER/$REPO</code>   * 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**+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 ====