[Android] Android Studio에서 Github 연동하기

Android Studio 버전 : Android Studio Arctic Fox | 2020.3.1 Patch 1
Git 버전 : 2.33.0

Github 계정 연동

1. Github에 연동하고 싶은 안드로이드 프로젝트를 오픈한 뒤, [File] > [Settings] 클릭

 

2. [Version Control] > [Git] 에서 [Test] 버튼을 클릭하면 Git 버전을 확인할 수 있다.

 

3. [Version Control] > [Github] 에서 "+" 버튼을 클릭한다. ("Add Account..." 글씨 클릭시 로그인 방식 선택 불가)

 

4.  3가지 메뉴가 표시되는데, 자신이 편한 로그인 방식을 선택한다.

• Log in via Github : Github로 로그인 (username, password)
• Log in with Token : Github에서 발급받은 Personal access token 으로 로그인 (Personal access token)
• Log in to Github Enterprise : GithubEnterprise로 로그인 (username, password)

 

5. 나는 토큰을 이용한 로그인 방법을 선택했다. "Log In with Token..."를 선택한 뒤 Token란에 사전에 발급받은 Personal access token을 붙여넣은 뒤 "Add Account" 클릭
*Token은 Github Repository 연동 시 패스워드 대용으로 사용되는 것으로, 이전에 토큰을 사용한 적이 없으면 새로 생성하고 토큰키를 잊어버렸을 경우에는 재발급 받아야한다. [Generate]를 클릭하면 Github 홈페이지에서 [Settings] > [Developer settings] > [Personal access token]으로 연결된다.

 

6. Github 계정이 추가되었으면 [OK] 클릭

 

Git Repository 생성

로컬 환경에서 사용할 Git Repsitory를 생성한다. (=Local Repository)

1. [VCS] > [Create Git Repository] 클릭  *VCS : Version Control System

 

2. Git에 연동하고자 하는 안드로이드 프로젝트를 선택한 뒤 [OK] 클릭

 

3. 프로젝트 파일들이 빨간색으로 표시될텐데, 아직 Commit되지 않은 파일들을 나타내는 것이다.

 

4. 파일 탐색기로 해경 경로를 들어가보면 .git 폴더가 생긴것을 볼 수 있다. 해당 폴더가 git의 관리하에 들어가게 됐다.

 

Github Repository 생성

Github 홈페이지에서 사용될 원격 Repository를 생성한다. (=Remote Repository)

1. Github 로그인 > [Repositories] > [New]

 

2. Repository name, Description 등을 작성 한 뒤 [Create Repository] 클릭
Add .gitignore에 체크한 뒤 Template를 Android로 설정해주면 Android 프로젝트 파일에서 세팅파일과 같이 Github에 업로드할 필요가 없는 파일들을 자동으로 Push대상에서 제외시켜 준다.

 

3. 새로 생성한 Repository의 HTTPS 주소를 복사해둔다.

 

4. Repository의 default branch가 "main"으로 되어 있을 것이다. 편의를 위해 "master"로 바꿔준다. branch 콤보박스 클릭 > "View all branches"

 

5.  이름을 변경하고자 하는 branch 옆의 연필 모양 버튼 클릭

 

6. "master" 입력 후 [Rename branch] 클릭

 

Git Repository - Remote Repository 연동

1. 파일 탐색기에서 안드로이드 프로젝트 폴더(.git이 존재하는 폴더)로 이동한다. 폴더 내 빈공간을 우클릭 한 뒤 [Git Bash Here] 클릭 (=현재 경로에서 Git 콘솔창 실행)

 

2. git명령어를 입력해 Local Repository와 Remote Repository를 연결해준다.

> origin 이라는 이름으로 Remote Repository를 연결

git remote add origin {HTTP 주소}

> 현재 연결되어 있는 Remote Repository 출력

git remote -v

 

Commit

1. Android Studio로 돌아가서 [Git] > [Commit] 을 클릭하거나, 단축키 [Ctrl + K] 를 누른다.

 

2. [Commit] 탭이 활성화되며 "Unversioned Files"에 아직 한번도 commit되지 않은 파일들이 표시된다.
*내가 연동한 안드로이드 프로젝트는 Module이 여러 개이기 때문에(하나의 프로젝트에 여러 앱이 존재함) .gitignore이나 동일한 이름의 파일이 여러 개 표시되고 있는 것일 뿐이므로 문제는 없다.

 

2. Commit 하고자 하는 파일에 체크한 뒤, 하단에 Commit Message를 작성한다.
*구글 검색창에 "commit message convention", "commit message 규칙" 등을 검색해 참고하는 걸 추천

 

3. 마지막으로 [Commit]을 클릭하여 파일을 Commit한다.

• [Commit] : Commit 수행, Git Repository(Local)에 변경사항이 반영된다.
• [Commit and Push] : Commit과 Push가 동시에 이뤄져, Git Repository(Local)와 Remote Repository(Github)에 변경사항이 모두 반영된다.
• Amend : 체크 시 History상 가장 최근 Commit에 이번 Commit을 포함시킨다. (=최근 커밋 갱신, 수정)
  *Git Message에 오타가 났거나, 소스코드에 사소한 변경이 생겼을 경우 유용하다.

 

4. "Default Changelist"에서 파일들이 사라지고, Event Log에 "file committed: commit message~" 와 같은 로그가 표시되면 성공적으로 커밋이 이뤄진 것이다. 커밋 실패 시 화면 우측 하단에 "Fail Commit~"과 같은 경고창이 표시된다.

 

Push

1. 이제 변경사항을 원격 저장소에도 업로드 해야한다. [Git] > [Push]를 클릭하거나, 단축키 [Ctrl + Shift + K] 입력

 

2.  Push창 우측에 Commit된 파일들이 표시된다. [Push] 클릭
: 현재 Local Git Repository의 master 브랜치 내용을 → Remote Repository(origin)의 master 브랜치에 Push한다.

 

3. 아래와 같은 메시지가 표시되면 Push가 성공적으로 이뤄진 것이다.

 

4. 참고로 안드로이드 스튜디오 우측 하단 [{Branch Name}] 버튼을 클릭해서 브랜치(Branch)를 변경할 수 있다.
*Branch : Commit & Push 분기 단위, 기준 소스코드에서 분기해 별도의 workspace를 가짐.
*master : 브랜치(Branch) 생성 시 기본으로 지정되는 dafault name (이전까지는 default name이 main이었음)

 

5. Git Repository에 들어가보면 모든 파일들이 제대로 업로드 된 걸 확인할 수 있다.

 

6. Android 프로젝트 - Github 연동 완료. 앞으로는 [Commit], [Push], [Fetch], [Pull] 등 Git 기능을 이용해 파일들을 관리해나가면 된다.