GitHub

Table of contents

Flow

이미지 출처 : https://github.github.com/training-kit/downloads/github-git-cheat-sheet.pdf


Branch 생성

master branch 는 항상 배포가 가능해야 하기에 새로운 작업에 대한 새 브랜치를 생성한다.
작업하는 내용에 대해 브랜치의 이름으로 작성하기를 권장한다. 팀원 간 어떤 작업 중인지 파악이 용이하다.
ex) authentication, make-avatar …


Commit 추가

생성한 브랜치에서 작업을 시작하며 커밋을 추가해 간다.
작업의 기록이기에 커밋메시지는 작업에 대한 설명으로 작성하기를 권장한다.


Pull request 및 review

작업 후 커밋을 푸시하게 되면 해당 브랜치에 대한 풀리퀘스트 버튼이 활성화된다.(기본 풀리퀘스트 버튼으로도 가능)
풀 리퀘스트는 마스터 브랜치로 병합되기 전에 의견을 나눌 수 있도록 한다. 리뷰 등을 통해 변경 작업을 진행하고 커밋을 추가한다.

리뷰 방법

  • PR에 Files changed 탭을 선택한다.

  • 변경된 파일의 내용 중 리뷰하고자 하는 줄의 플러스 아이콘을 선택한다.

  • 리뷰 내용을 적고 start a review 버튼을 클릭한다.

  • 우측 상단의 review changes 버튼이 finish your review로 바뀐다. 해당 버튼을 누르고 제출하면 된다.

  • 그럼 PR의 conversation 탭의 아래부분에 리뷰가 나타난다.


Merge

프로젝트 관리자의 검토가 완료되면 마스터브랜치와 병합한다.
이때 closes #issue번호를 적으면 병합과 함께 해당 이슈도 닫힌다. 만약, 풀리퀘스트 생성 시 linked issues를 통해 이슈를 연결해 놓았다면 closes #issue번호가 없어도 자동으로 닫힌다.

SSH key 생성 및 설정

Mac OS 기준

$ ssh-keygen -t ed25519 -C "your_email@example.com"

생성 후에 github의 설정에 추가하기 위한 값 복사

// 공개키 파일명은 생성된 것으로
$ pbcopy < ~/.ssh/id_ed25519.pub

github - SSH keys에 새로운 키를 추가하여 복사한 값을 붙여넣고 추가하면 된다.

ssh key 변경에 따른 remote 저장소 연결 에러 대응

Host key verification failed. fatal: Could not read from remote repository.
...
  • 해결
    .ssh 파일 내 known_hosts에 github key 추가
$ ssh-keyscan github.com >> ~/.ssh/known_hosts

git history에 100M이상의 파일이 있을 경우

  • github에 push가 되지 않기 때문에 history에서 해당 파일을 정리해야 한다.
  • BFG Repo-Cleaner를 이용
brew install bfg

bfg --strip-blobs-bigger-than 100M [폴더 경로] // clean

git reflog expire --expire=now --all && git gc --prune=now --aggressive

위 작업 후 push 하면 정상적으로 push가 된다. 단, 커밋 해시값이 달라지기 때문에 해당 작업 시 확인 필수!