IntelliJ 프로젝트에 Gist 연동하기 (Github Gist Clone - Commit - Push)

IDE에서 모든 Gist 작업을 하고 싶은 캠퍼 분들이 계실 것 같아서

저 역시 두고두고 참고할 겸 리서치 후 한 번 정리해 봤습니다.

도움이 됐으면 좋겠습니다!

혹시 더 좋은 방법이나 개선할 사항이 있다면 댓글로 알려주시면 감사하겠습니다 ☺️

주의사항

Gist는 코드 스니펫 공유용이라서 빌드나 실행은 고려하지 않고

단일 파일 단위로 보여주고 복사하는 데 목적이 있습니다.

따라서, 폴더의 업로드가 불가능하기 때문에

이 방법은 소스 코드 파일을 올릴 때 루트 폴더로 잠시 옮겨서 업로드하는 방법을 사용하고 있습니다.

루트 폴더로 옮길 경우 패키지와 실제 경로가 맞지 않아 오류가 발생할 수 있습니다.

이후에는 반드시 src/main 같이 원래의 경로로 옮겨서 작업을 하시길 추천 드립니다.
또한, 이 글은 IntelliJ와 Github를 연동하셨다는 전제하에 작성 했습니다.

 

추가적으로 이미지의 경우 직접 Gist에 들어가서 수정해줘야 제대로 보이기 때문에
결국 최종적으로는 웹에 접속해서 이미지를 업로드 해줄 필요가 있습니다.

이 경우 작업이 겹쳐 충돌나지 않게 주의하시기 바랍니다.

---

 

Secret Gist 생성

먼저 Gist로 이동하여 Secret Gist를 만들어줍니다.

Discover gists

 

 

그리고 사용할 파일들을 미리 만들어 줍니다.

여러 파일을 추가하셔도 괜찮습니다.

 

Gist를 만들고 파일을 생성한 뒤 오른쪽 상단에서

Embed가 아닌 Clone via HTTPS로 바꿔 링크를 복사해줍니다.

IntelliJ 프로젝트 생성

 

이제 IntelliJ로 이동하여 프로젝트를 생성해줍니다.

저는 향후 패키지 의존성을 추가할 일이 있을까 싶어서 Gradle로 프로젝트를 빌드 했습니다.

프로젝트를 만든 뒤 IntelliJ 프로젝트에서 터미널로 이동하여

git init

git remote add origin {위에서 복사한 Gist주소}
 
git fetch

git checkout -t origin/main

 

위와 같이 입력해줍니다.
git clone을 사용하지 않은 이유는 저희는 빈 폴더가 아니라 이미 빌드된 프로젝트를 이용했기 때문입니다.

 

그럼 위와 같이 README.md가 최상위 디렉토리 하위에 생기게 됩니다.

git clone을 사용하여 하위 디렉토리를 지정해줘도 되지만

저희는 코드 파일도 같이 관리해야 하기 때문에

서브 모듈없이 함께 관리하는게 편하지 않을까 생각이 들어서 이 방법을 사용했습니다.

 

이제 추가적으로 사용할 kt 파일과 md 파일을 생성하고

git status 를 터미널에 입력하면

 

저희는 최상위 디렉토리에 git이 있기 때문에 하위 파일들이 모두 뜨게 됩니다.

따라서 .gitignore 파일에 아래와 같이 추가를 해줍니다.

# IntelliJ IDEA 관련 파일 및 폴더
.idea/
*.iml

# Gradle Wrapper 및 빌드 산출물
/build/
/out/
.gradle/
gradle/
gradlew
gradlew.bat

# Gradle 설정 파일 제외
build.gradle.kts
gradle.properties
settings.gradle.kts

# Gist에 폴더를 올릴 순 없기 때문에 소스 코드 경로도 제외
src/main/

# git ignore 파일 제외
.gitignore

 

그 후 다시 git status를 입력하면

md 파일처럼 저희가 작성한 문서들만 추척되고 있습니다.

한글 폰트가 깨지는 이유는 터미널 인코딩 문제라 신경 쓰지 않아도 괜찮습니다.

하지만 저희는 Gist에서 소스 코드도 공유를 해야 하기 때문에

Gist에 소스 코드를 업로드 해야 하는 시점에만

잠깐 kt 파일을 드래그하여 루트 폴더(최상위 디렉토리)로 리팩토링 해줍니다.

(업로드 이후에는 다시 src/main으로 옮겨서 작업하셔야 패키지 경로 등이 꼬이지 않습니다)

그럼 kt파일도 동일하게 추적되는 것을 볼 수 있습니다.

이제 git add . 을 입력하여 모든 파일을 스테이징 영역에 올려줍니다.

src/main을 git ignore에 등록하여 제외한 이유가 위처럼 문서들을 편하게 관리(추가)하기 위함입니다.

그럼 위와 같이 스테이징 영역에 수정된 파일들이 모두 올라가게 됩니다.

 

이후 git commit -m "원하는 메세지" 를 입력하여 commit을 해줍니다.

터미널에서 인코딩 문제로 한글 폰트가 깨졌지만 실사용에 문제는 없습니다.

commit을 완료 했으면 최종적으로 git push 를 입력해서 Gist에 푸쉬를 해줍니다.

 

위처럼 push가 성공하면

 

Gist에 모든 자료가 정상적으로 업로드된 것을 확인할 수 있습니다.

 

웹에서 파일을 추가한 경우

그런데 만약, Gist(Web)에서 파일을 추가(수정)한 경우가 있을 수 있습니다.

 

만약 위처럼 웹에서 Gist에 파일을 추가했을 경우

터미널에 git pull origin main 을 입력하면 됩니다.

정상적으로 IntelliJ 프로젝트 내로 파일이 불러와진 것을 확인할 수 있습니다.

웹과 IDE에서 동시에 작업할 경우 충돌이 발생할 수 있으니
한 곳을 정하고 작업하시는 것을 추천 드립니다.

 

생각보다 정보량이 적어서

초급자가 리서치한 내용을 바탕으로 구현한 방법이라

조금 허술한 방법일 수 있습니다.

더 좋은 방법이 있다면 공유해주시면 감사하겠습니다! ☺️