[JAVA/Intellij] 프로젝트 Github 연동

이번시간에는 Intellij 프로그램에서 어떻게 프로젝트를 Github에 연동시킬지에 대해 알아보자.

 

0. Github 레포지포리 생성

1. 프로젝트에 .gitignore 파일 추가

.gitignore 이란?

.gitignore 파일이란 Git 버전 관리에서 제외할 파일 목록을 지정하는 파일이다.

Git으로 프로젝트를 관리할 때, 보안상 위험한 파일이나 원하지 않는 파일을 제외하는 것이다.

 

예를 들면,

• [NodeJS] npm module
• Java 컴파일된 파일 (.class)
• Java 보안 관련된 파일 (application.yml or application.properties)
• AWS 비밀 키(aws-access-key, aws-secret-access-key), JWT 비밀 키 등이 있다.

 

gitignore 파일을 추가하는 데는 두 가지 방법이 있다.

1) 파일을 생성해 입력하여 추가하는 방법과 2) 플러그인으로 추가하는 방법이다.

 

1) .gitignore 파일 생성

gitignore.io

다음 url에서 프로젝트에 맞는 '운영체제, 개발환경(IDE), 프로그래밍 언어'를 입력한 뒤 생성 버튼을 누른다.

[ALT]-[a] → [CTRL]-[c] : 페이지의 모든 글자들을 복사한 뒤,

프로젝트의 최상위 디렉토리에 .gitignore 파일을 생성하여

[CTRL]-[v] : 붙여넣은 뒤,

[CTRL]-[s] : 저장한다.

 

2) .gitignore 플러그인 이용

[shift]+[shift] : shift key를 빠르게 두 번 누르면 아래 왼쪽 그림과 같이 빠른 실행 창이 나타난다.

입력창에 plugins을 입력하고 선택한다.

그다음 Marketplace 탭을 선택한 뒤, 입력창에 gitignore을 입력한 뒤 설치한다. 

[Apply] 버튼을 선택해 적용시킨 뒤, [OK] 버튼을 선택해 빠져나온다.

.gitignore  플러그인 설치

 

.gitignore 파일은 보통 Github 업로드할 프로젝트의 최상위 디렉토리에 위치시킨다.

해당 디렉토리를 선택한 뒤 오른쪽 버튼을 누르면, New에 .ignore File 메뉴가 생긴 것을 알 수 있다.

해당 기능을 선택하면 오른쪽 아래 그림과 같은  창이 나타난다.

사용하는 언어와 프레임워크를 선택한 뒤 [Generate] 버튼을 선택하면, .gitignore 파일이 생성된다.

 

 

이제 제외하고 싶은 파일이나 폴더에 대한 정보를 추가해 보자.

 

필자의 경우 application.properties나 application.yml 파일을 제외하고 싶어서

.gitignore 파일에 다음과 같은 문구를 추가했다.

application.yml
application.properties

 

 

2. Intellij Github 연동

프로젝트를 깃허브에 연동시키는 데는 두 가지 방법이 있다.

1) 해당 프로젝트를 새로운 Repository로 생성하여 연동하는 방법과 2) 기존의 Repository에 프로젝트를 연동하는 방법이다.

 

1) 프로젝트 자체를 새로운 Repository로 생성하여 연동하는 방법

 [VCS]-[Share Project on Github] 선택

 

[VCS]-[Share Project on Github]

Repository name을 입력한 뒤 옵션들을 선택하고 2)번의 -git commit 과정을 동일하게 진행한다.

 

share project on github

 

2) 기존의 Repository에 프로젝트를 연동하는 방법

①  Git 실행 설정

git.exe 파일의 경로를 기억해 아래 파란색 부분에 입력한다.

 

enter git.exe file directory path

 

②  GitHub 계정 연동

그다음 두 가지 방식 중 하나를 사용해 깃허브에 로그인한다.

 

github login

 

③  Github Repository에 프로젝트 연동

- Create Git Repository(해당 프로젝트를 레포지토리로 생성하는 기능)

빠른 실행([shift]+[shift])에서 create git repository를 입력한 뒤 해당 기능을 선택한다.

 

create git repository

이후, 원하는 프로젝트를 선택한 뒤 OK 버튼을 누른다.

 

- Git Add (해당 프로젝트 파일들을 스테이징 영역에 추가)

Git-Add 버튼을 선택하여 프로젝트 파일들을 스테이징 영역에 추가한다.

 

git add

 

- Git Commit (배포 확정)

그다음 Git-Commit을 선택하고 변화에 대해 체크한 다음 커밋 메시지를 입력한 뒤, commit 한다.

 

git commit

- 해당 프로젝트를 레포지토리를 Github에 이미 존재하는 레포지토리의 하위에 연동

아래 url에 기존의 Github 레포지토리 주소를 입력한다.

https://github.com/사용자이름/(기존의)레포지토리이름 

github 레포지토리와 연동

 

브랜치 종류를 선택한 뒤(main, master), push 버튼을 눌러 깃허브에 업로드한다.

오류가 발생하지 않는다면, 깃허브에 들어가 해당 레포지토리에 잘 업로드되었는지 확인한다.

(본인의 경우 강의의 코드를 저장하기 위해 main 브렌치에는 정규 프로젝트를, master 브렌치에는 사이드 프로젝트를 연동하였으나,