-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgit-installation.qmd
54 lines (32 loc) · 3.94 KB
/
git-installation.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
---
title: Git and GitHub Access and Installation
subtitle: How to Install and Access Git and GitHub at the Urban Institute
---
This guide is intended to help Urban Institute employees get started accessing and installing Git and GitHub. You should generally only have to complete the steps in this guide once during your time at Urban.
We know that learning these tools can be a challenge, but we're here for you! Drop a message in the <a href="https://theurbaninstitute.slack.com/archives/C6J9AALDR" target="blank">#github Slack channel</a> if you run into issues, and we will be happy to help out.
## Installation and registration
### git installation for Windows
Install <a href="https://git-scm.com/downloads" target="_blank">Git for Windows</a>. Keep all default selections and **be sure to install Git Bash**. Git Bash is a command line for Windows that is useful for using Git. After installation, you should be able to right click and select `Git Bash Here`.
### git installation for Mac OS
Install <a href="https://git-scm.com/downloads" target="_blank">Git for Mac OS</a>. Mac already has the terminal. Open the terminal and type `git`. If everything is properly installed, a list of possible command will show up.
## GitHub account
Create a <a href="https://github.com/" target="_blank">GitHub account</a>. There is no need to associate your account with the Urban Institute or an Urban Institute email address. Many people want to use GitHub for personal projects, too.
**After creating an account, fill out Urban's <a href="https://app.smartsheet.com/b/form/9f0c5ba330dd4b73980fe5a6e17216b5" target="_blank">GitHub intake form</a> to join Urban's primary GitHub organization, <a href="https://github.com/UI-Research" target="_blank">UI_Research</a>.** Note that Urban has another GitHub organization, <a href="https://github.com/UrbanInstitute" target="_blank">UrbanInstitute</a>, that is primarily used for public-facing repositories.
## Configure Git and GitHub
Link your local Git to GitHub by submitting the following with your GitHub username in quotes:
```{.bash}
git config --global user.name "<your_github_username>"
```
You should also submit the email address linked to your GitHub account:
```{.bash}
git config --global user.email "<your_email_address>"
```
## Authentication and tokens
You will need to create a personal access token (PAT) to replace your password and provide enhanced security. <a href="https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/" target="_blank">Since 2021</a>, GitHub has required PATs to perform Git operations. To create a PAT:
1. Log into your <a href="https://github.com/" target="_blank">GitHub account</a>. Navigate to the drop-down menu in the top right corner with your profile picture. Select **Settings** near the bottom of this drop-down.
2. From your account settings, navigate to **Developer Settings**, at the bottom of the menu on the left.
3. From the developer settings, navigate to **Personal Access Tokens** in the menu on the left.
4. Click **Generate new token (classic)**. You may be prompted to re-enter your GitHub password.
5. Add a note to label the token. This is useful if you intend to generate multiple tokens for different uses. Then, set a time limit for the token – you can set this to never expire. Finally, select the scope of permissions you would like to give the token - you can select all options. Then click **Generate token**.
6. The generated token will appear. **Make sure to copy and safely store the token when it appears, as you will not be able to view it again**. Note that if you lose your token, you can always generate a new one. Use this in place of your GitHub password when prompted by Git (or when using the GitHub API).
The first time you attempt to clone (copy to your computer) a repository that is private on GitHub, Git will prompt you for your credentials. Your username is just your GitHub username. Your password should be the PAT that you created.