[220926-220930] Git / Github

 

1. CLI / Vim

• 맥은 터미널, 윈도우는 git bash 키기

 

1) 명령어

• ls : 파일과 폴더를 보여줌 
• pwd : 현재 위치를 말해줌
• ls 의 flag : 옵션을 뜻함. -a 는 all 로 숨김 파일까지 탐색, -l 은 line by line 로 한 줄로 깔끔하게 출력
• cd : 파일 이동 / ex) cd Documents/
• mkdir : 폴더 생성 / ex) mkdir foldername
• touch : 파일 생성 / ex) touch filename.txt
• mv : 파일 이동 / ex) mv filename.txt foldername/
• cp : 복사 / ex) cp filename.txt filename2.txt
• rm : 파일 삭제 / ex) rm filename.txt
• rm -rf : 폴더 삭제 / ex) rm -rf foldername/
• mv : 이름 수정 / ex) mv filename.txt filename2.txt
• cat : 작성한 내용 확인 / ex) cat filename.txt
• vi : vim 창 열기 / ex) vi filename.txt
• code . : vscode 로 넘어가기

 

2) Vim 으로 마크다운 작성 방법

• vi README.md 입력 후 들어가자마자 i 누르면 insert 모드 시작, 작성할 수 있게 됨
• 1. 2. 3. : 순서 있는 리스트
• - , * , + : 순서 없는 리스트
• ``` <div></div> ``` : 코드 블럭 삽입
• **bold** : 볼드체 입력
• # : 제목, # 이 많아질수록 작아짐
• <!-- 주석 --> : 주석
• [링크 텍스트] (링크 url) : 링크 삽입
• ![이미지텍스트] (이미지 url) : 이미지 삽입
• *** , ----- : 구분선
• 줄바꿈으로 공백을 표현하고 싶으면 enter 두번해야 공백이 됨. 한번만 하면 붙어버림.
• esc 누르고 :wq 하면 저장하고 나가기, :w 하면 저장, q 저장하지 않고 종료, e! 수정한 것 무시하고 편집 상태

 

 

 

 

 

 

 

2. Branching Models

 

1)  flow

• git flow : 각 단계가 명확히 구분되어 주로 사용. 
• github flow : 주로 라이브러리(react) 에 쓰임. release 단계가 없어 바로 넘어감

 

2) git flow strategy

• feature - develop - release(줄이는 작업), version - main

 

3) git flow cheatsheet

• 이 프로그램을 이용하면 위 작업을 쉽게 할 수 있음
• window 의 경우, git bash 에서 git flow init 입력해주고 enter 키를 눌러주면 구조를 자동으로 만들어줌
• git flow feature start featurename : feature 시작
• git flow feature finish featurename : feature 끝
• feature 이름은 작업하는 내용에 따라 명확히, 작업 후 사용중인 브랜치가 아니라면 바로바로 지워주는 것이 좋음
• git flow release start v0.1 : 버전 릴리즈
• tagging 작업 labeling : commit vim 창, release note vim 창, 다시 commit vim 창
• git push -u origin develop : remote 에 없는 develop 으로 push 할 때, -u 는 upstream
• git checkout main : main branch 로 이동
• git push origin main : main 으로 push
• git push --tags : tag 를 push
• remote(원격저장소) 로 가서 tag → create release → Existing tag : Initial Release → 본문에 My first release → This is a pre-release 체크(베타버전이라는 소리) → publish release 누르면 끝

 

 

 

 

 

3. Revert

 

1) Rename : 이름 수정

• 그냥 이름을 수정해버리면 원래 파일은 deleted 가 뜸, 이럴 때는 staging 전까지 다시 이름을 돌려놓으면 됨
• git mv README.md unread.txt : git 으로 알려주면서 수정하면 renamed 가 뜸, 다만 물리량 변화없이 트리가 변경된 것이기 때문에 comitted 가 뜸

 

2)  Undoing

• 지금까지 작업한 것을 취소하고 싶을 때, 최신의 타임스탬프로 돌려놓는 것
• git restore unread.txt → 워킹트리 깨끗 / resotre 보다 오래된 것은 checkout

 

3) Unstaging

• 예전에는 git reset HEAD unread.txt , 요즘에는 git restore --staged unread.txt
• 여기서 HEAD 는 최신이라는 뜻
• git commit --amend : 최신 커밋 메시지 수정

 

4) Reset commit

• worst case : reset → 직전 3개의 commit을 삭제한 후, remote에 강제 push
• best case : revert → 현재 HEAD에서 직전의 3개의 commit을 순서대로 거슬러 올라가 해당 내역에 대해 commit, push 수행
• revert : git revert --no-commit HEAD~3.. → 삭제하는 commit 의 숫자만큼 commit 을 찍어줘야 하기 때문에 마지막에 한번에 commit 하겠다는 뜻으로 --no-commit 을 쓰고, 최신 commit 에서 부터 3개를 삭제하겠다는 뜻으로 HEAD~3 을 작성하고, 맨 뒤에 .. 은 꼭 해줘야 함

 

 

 

 

 

4. Git 협업 프로젝트

 

1) 팀장 : Organization 만들기

• Github 에서 + 버튼 누르고 New organization 
• Free Plan 선택
• Organization account name(팀 이름) 작성, Contact email(대표 이메일) 작성, My personal account(개인 계정) 선택
• 팀원 초대, 당장 하지 않아도 됨. skip 도 가능
• survey 는 해도 안해도 상관 없음, 나가려면 New Organization
• skip 후 팀원 초대하려면 invite member 선택, owner 는 팀장 권한이니 member 선택
• repository 만들기 : 이름 작성, public 선택, license 는 mit, create 클릭하고 작업

 

2) 팀장 : 초기 Set UP

• Git bash 에서 git clone [주소] / 만들어진 해당 repository 이름으로 된 파일로 cd 명령어를 통해 이동
• gitignore.io 사이트로 가서 gitignore 파일에 들어갈 코드 생성
• Git bash 에서 touch .gitignore (파일 생성), vi .gitignore (수정) 해서 gitignore.io 에서 복사한 코드 붙여넣기
• README.md 파일 수정
• 이때, 설정 파일은 다른 폴더에 넣지 않고 메인에 놓기
• 기본 작업할 html, css, js, img 등 파일 생성해놓으면 좋음
• git status (상태확인) → git add → git commit → git flow init (branch 구조 만들기) → git push -u origin develop (첫 push)

 

3) 팀장, 팀원 : Issues 작성

• Issues 작성은 해야 될 일을 작성하는 것
• Issue 는 한글로 작성해도 됨. 할 일을 정하고 해당 Issue 를 해결하면 완료.
• 제목은 본인 이름 포함해 간단하고 명확하게 명시할 것. 본문은 설명, 할일, 참조 형식으로 작성.
• 할 일은 각자 선정하고, 체크박스 활용할 것

 

4) 팀장, 팀원 : fork 뜨기

• fork : 팀 organization 의 사본, 간접 기여 방식, 원본 리모트의 사본을 뜻함
• 팀 organization 에서 fork 라는 버튼을 클릭 후 Copy the main branch only 체크박스 해제
• 팀원 : Git bash 에서 fork 를 떠서 사본이 되고 자기 소유가 된 repository 의 주소를 가져다가 clone → git clone [주소]
• 팀장 : 이때 set up 을 완료한 원본 폴더가 남아있을텐데 이 폴더는 rm -rf [원래폴더명] 으로 지워주고 fork 뜬 사본 repository 를 git clone [주소]
• git flow init → ls (만들어졌는지 확인) → git flow feature start [이름] (feature branch 생성] → 작업, add, commit → git flow feature finish [이름] → git push -u origin develop (이후 push 할 땐 -u 없애도 됨)
• Github 에 fork 뜬 내 repository 로 이동해서 상단에 뜬 compare & pull requests 클릭하거나, pull requests 탭으로 가서 new pull request 버튼 클릭. 근데 후자를 추천
• 바뀐 내용이 똑같은 branch 로 들어가도록 develop 에서 develop 으로 가게 선택, 이때 오른쪽의 내 repository 부터 선택해주기
• pull request 의 제목, 내용 작성 : 작성한 issue 와 연결되도록 fix(수정), close(마무리), resolve(해결) 중 알맞은 키워드 고른 후 옆에 # 해주면 issue 자동완성이 뜸 / 키워드는 복수형(# 여러 개) 과거형 모두 가능(예: fixed, fixes)
• 완료되면 create pull reaquest

 

5) 팀장 : Code Review

• pull requests 탭 들어가서 
• Reviewers (리뷰할 사람, 팀장) 지정 - Assignees (pull requests 한 사람) 지정 - Labels (어떤 것을 했는지 구분) 지정
• files changed 에서 보고 코드 위 + 버튼 눌러서 리뷰
• 파일 당 상단 오른쪽에 viewed 라는 체크박스가 있는데 통과한 것은 체크, 통과 못한 거는 viewed 누르면 안됨 
• finish your review 클릭하고 확인해달라고 내용 작성, comment(단순한 제안, 해도 되고 안해도 되고), approve(승인), request changes(반려) 중 하나 선택해서 보냄. 이때 반려의 경우 반려된 것 고칠 때까지 마지할 수 없음

 

6) 팀원 : Request Changes 수정

• Git bash 에서 code . 해서 vscode 로 이동
• 수정할 사항 작업
•  vscode terminal 켜서 git add → git commit → git push origin develop
• 이때 pull reaquest 가 닫힐 때까지 나의 develop 으로 push 해도 팀의 develop 까지 쭉 연결되어 연동됨

 

7) 팀장 : 수정 사항 확인

• 해결된 것 확인 후 resolve conversation 클릭
• files changed 로 가서 viewed 체크, comment 작성 후 approve
• 그럼 merge 가능한 초록색 버튼으로 뜸, 추가 의견도 맨 하단에 작성 가능, merge 클릭

 

8) 팀장, 팀원 : pull 받기

• Git bash 에서 git remote -v 했을 때 upstream 이 없다면 git remote add upstream [팀주소] 하면 upstream 이 생김
• pull 받을 때는 팀의 develop 을 받아야 함, 그래서 git pull upstream develop
• 다른 사람 작업 내역이 내 develop 에 쌓임
• 따라서 디벨롭에서 작업을 할 수 있지만 하지 않는 이유는 중간중간 pull 을 받아야 하는 때가 오기 때문에. 그럼 내 작업과 다른 사람 작업이 충돌 할 수 있음