Github + Slack 연동



 먼저 Slack 에서 Apps 의 +버튼을 통해 github을 검색하고  github을 설치한다.







 Slack의 어떤 채널에 연결을 할 지 선택할 수 있다.





설치가  완료되면  슬랙의 채널에서 /github signin 명령어를 통해 깃헙 계정에 로그인하여 연결한다.






로그인이 완료되면, Success! 라고 문구가 뜬다. 그리고,  특정 레퍼지토리랑 연결하기 위해,

/github subscribe [github ID] / [Repository명] 을 입력한다. 그러면 깃헙에 설치가 되어있지 않다고 설치하라는 문구가 뜬다.

설치해보자.






  팝업된 페이지의 밑으로 내려가보면 어떤 레퍼지토리에 액세스 권한을 줄지 선택할 수 있다. 연동할 레퍼지토리를 선택한다.





설치를 완료한 후, 다시 슬랙으로 돌아와 명령어를 다시 한 번 입력하면 해당 레퍼지토리를 github 봇이 구독한다.






깃헙 레퍼지토리에서 커밋, 푸시 등의 이벤트가 발생하면 Slack의 연동한 채널로 notification을 주게 된다.





 




Github 기초 사용법 - 3





목 차


   1. issue, labels, milestone
   2. project 활용







1. issue, labels, milestone


  issue  :  프로젝트를 진행하면서 발생하는 모든 이슈 (버그 발생, 개발, 풀 리퀘스트 등등)


 깃헙에서는 이슈기능을 통해 프로젝트에서 발생하는 모든 문제를 관리할 수 있도록 돕는다. 이슈는 아래 이미지와 같이 제목과 이슈에 대한 설명을 작성하여 생성할 수 있다.



  여러 이슈를 다음과 같이 만들어 볼 수 있다. 이해하기 쉽게 웹 어플리케이션을 개발할 때, HTML, CSS, JavaScript를 만드는 과정을 모두 이슈로 만들었다.





생성된 이슈는 리스트형태로 굉장히 관리하기 힘들어 보인다. 이슈가 굉장히 많아지면 어떤 이슈를 찾기가 점점 힘들어 질 것이다. 이러한 문제를 돕기위한 기능이 label 이다. 각 이슈에 대해 labeling을 통해 이슈를 검색할 수 있고, 이슈별 주제를 구분할 수 있다.


labels   :  각 이슈에 tag / label을 부여


 다음과 같이 Labels 탭(파란버튼) 에서 새로운 레이블을 만들 수 있고, 컬러 또한 지정할 수 있다.




 그리고, 이슈 상세 화면에서 오른쪽 사이드 메뉴의 Label을 통해 부여할 수 있다.




 또한, 해당 이슈에 대해 Assignees(책임자)를 부여할 수 있다.





  Assignees와 Labels를 각 이슈들에 부여한 후 목록페이지로 돌아오면 다음과 같이 깔끔하게 정리되어 있다. 이 label과 assignee를 통해 Filters 란에서 필터링하여 이슈를 검색할 수 있다.



 하지만, label과 assignees를 아무리 부여해도 무언가 부족하다. 각 기능별 서로 유사한 이슈들이 존재하며, 이 관련된 이슈들을 찾거나 해당 기능들이 얼마나 구현되었는지 파악하기 위해선 일일히 추적해야한다.


 이를 돕는 기능이 바로 MileStone기능이다. 마일스톤은 말그대로 이정표 역할을 하며, 이슈들을 그룹화한다.


Milestone   :  issue들의 그룹,  이정표로써 진행 상황을 표현


 마일스톤을 생성해보자. 




 이전에 Label을 부여한 것과 같이 이슈 상세페이지에서 마일스톤을 부여할 수 있다.




 마일스톤으로 3개의 이슈를 모두 묶을 수 있고, 만약 아래와 같이 하나의 이슈가 완료(close)되면 마일스톤의 진행상황이 업데이트 된다.

참고로 이슈페이지에서 @이름 을 통해 다른 사용자를 언급할 수 있고, # num 을 통해 커밋, 이슈 들을 참조해 소통을 원활하게 할 수 있다.






  이슈가 종료되면 아래 이미지와 같이 main page라는 마일스톤의 진행상황이 업데이트 되는 것을 볼 수 있다. 이 마일스톤 기능을 통해 연관된 이슈의 추적과 진행상황을 한 눈에 파악할 수 있다.












Project 활용


 issue, label, milestone으로 프로젝트를 진행하면서 발생하는 이슈들을 관리하는 법에 대해 알아보았다. 하지만, 아직도 이슈가 한눈에 들어오지 않는다. LIST 열거 방식의 한계가 있어, 프로젝트가 현재 진행중이고 목표하고 있는 것이 무엇인지 한 눈에 파악하고 싶다. 프로젝트의 칸반보드 기능을 이용하면, 이슈들을 좀 더 조직화할 수 있고,  우선순위에 따라 정렬하거나 보다 한 눈에 workflow를 볼 수 있다.

 Project 메뉴로 이동해 create a project 버튼을 눌러보자.




 프로젝트의 이름과 템플릿을 설정한다. 여기서는 "automated Kanban"을 선택해, 기본 템플릿이 있고 이슈를 알아서 어느정도 관리해주는 템플릿을 선택한다.





프로젝트가 생성되면 아래와 같이 3개의 열로 구성된 기본 템플릿이 메인 창에 나타나며, 오른쪽 사이트 바엔 이전에 생성했던 열려있는(open) 이슈 카드 목록이 보인다. 3개의 열은 " To do ", " In Progress ", " Done "으로 구성되어, 해야할 Task와 진행 중인 Task, 완료된 Task를 묶을 수 있다.(그냥 Trello 보드랑 똑같이 쓰면 된다...)      


  오른쪽의 이슈 카드는 드래그를 통해 이슈의 상태에 따라 옮기면 된다.






 직접 issue 카드를 생성할 수 있으며, 설정의 "Convert to issue" 통해 실제 issue로도 변환할 수 있다.






 
이전에는 Trello 보드를 이용해 이슈들을 관리했었는데, Github 내에서도 이 project 기능을 통해 별도의 트렐로와 같은 툴을 쓰지 않아도 프로젝트의 이슈들을 정리하고 관리할 수 있어 편리한 것 같다.






  Github 기초 사용법 - 2



  이번 포스트에서는 로컬 저장소에서 작업한 내용을 Github의 원격저장소로 push하는 등의 원격저장소 활용방법에 대해 다룬다. github의 기본 명령어 (git init & status & add & commit) 및 Branch 와 충돌관리에 대해 잘 모른다면 이전 포스트 [Project Management/Github] - Github 기초 사용법 - 1를 참고하세요.





목 차


   1. Github 레퍼지토리 생성
   2. 원격저장소 연결(git remote)
   3. git push (로컬 -> 원격)
   4. 원격저장소와 로컬저장소 충돌 문제 (git pull & fetch)
   5. fork/clone 와 pull request






1. Github 레퍼지토리 생성

 
 Github의 계정을 생성한 후, Repositories 메뉴의 New 버튼을 통해 레퍼지토리를 생성한다. 지금은 README 파일은 생성은 하지말자.



 생성하면 다음과 같이 레퍼지토리가 생성된다. 레퍼지토리의 URL을 복사하자. Git Bash에서 이 원격 저장소와 연동을 위해 이 원격 저장소의 주소가 필요하다.










2. 원격저장소 연결 (git remote)

 
 Git Bash 터미널로 돌아가 이전 포스트[Project Management/Github] - Github 기초 사용법 - 1에서 작업했던 환경에서  방금 생성한 원격 저장소를 연결해보자. 그리고 git remote -v 로 목록을 확인해보자. 통상적으로 origin이란 별명을 사용한다.

 git remote add [원격저장소 별명] [원격저장소 주소] : 원격저장소 추가
 git remote -v : 원격저장소 목록 확인

e.g. remote add origin https://github.com/lis123kr/github.tutorial.git



 아무 변경사항이 없어보인다. 하지만 추가한 원격 저장소를 통해 이제 로컬 환경의 작업내역을 원격으로 전송할 수 있다.






3. git push (로컬 -> 원격)


 git push [원격저장소 별명] [브랜치 명] : 원격저장소에 [브랜치 명]의 작업내용을 전달

 git push 명령어를 통해 원격저장소에 변경 내용을 발행해보자. git push origin --all 을 통해 모든 브랜치를 전송하였다. 그리고 github의 원격 저장소에도 업로드된 것을 확인할 수 있다.



 







4. 원격저장소와 로컬저장소 충돌 문제 (git pull & fetch)

 
 이번에는 원격 저장소와 로컬 저장소의 간격을 메우는 과정을 살펴보자. 새로운 기능을 로컬 저장소에서 구현했을 때는, commit하고 push하여 로컬 저장소에 업로드하면 되지만, 다른 팀원이 개발한 내역이 있어 원격 저장소의 작업 내역이 나의 로컬의 작업내역과 다를 때는 내 변경사항을 원격저장소에 업로드(Push)하면 충돌이 발생한다.

 이럴 때는 원격저장소의 변경사항과 나의 로컬저장소의 간격을 없애야한다. 즉, 원격저장소의 최신 변경사항으로 맞추어야 내 로컬 변경사항을 업로드할 수 있다. 이를 위한 명령어가 fetch와 pull이다. 

 git fetch : 원격 저장소의 변경 사항(commit) 들을 로컬저장소로 가져온다. (commit 내역을 가져온다)
 git pull   : 원격 저장소의 변경사항을 가져와 로컬에 병합한다.

 즉, git pull은 git fetch하고 git merge까지 해준다고 볼 수 있다. 그럼 이제 직접 해보자.

원격 저장소와 로컬 저장소의 간격을 만들기 위해 원격 저장소에서 내용을 수정해보자. github 저장소에서 C코드를 선택해 '펜' 버튼을 누르면 바로 수정가능하다. 주석 한줄을 추가한 후 밑에 commit 버튼을 통해 변경을 완료한다.

  




  이로써, 원격저장소에는 commit이 하나 더 생겼다. 내 로컬 환경과 간격이 생겼고, 로컬 환경에서 마찬가지로 주석을 작성해 push해보면 충돌이 발생한다.

 


 당연히 원격저장소와 로컬 저장소가 변경내역이 다르기 때문이다(원격과 로컬 각각 커밋이 하나씩 더 있다) . hint에는 git pull을 사용하라고 알려주지만 git fetch를 사용해보자. git fetch를 하면 아무 변화가 없어보인다. 파일도 로컬에서 변경한 내용 그대로이다. 하지만 git branch -a를 해보면 원격저장소의 임의의 브랜치(origin/master)가 생성되었다.

  


 git merge origin/master를 통해 원격저장소의 변경내역과 병합해보자. 변경내역에 충돌이 없다면 바로 병합이 되지만, 여기서 변경한 내역에는 충돌되는 부분이 있어 충돌이 발생했다. 충돌이 난 부분을 git diff를 통해 확인하고 해결하자.

 



 충돌을 해결한 후 원격저장소에 push하면 이제는 원격저장소와 로컬저장소가 같은 최신의 작업내역을 갖고있기 때문에 push 시 에러가 발생하지 않는다.




 지금까지의 변경내역을 그래프로 그려보면 다음과 같다. 각 점은 commit 내역을 의미하고 branch를 생성하고 병합한 내역과, 원격 저장소에서의 변경과 병합한 내역을 확인할 수 있다. 이 그래프는 Github 레퍼지토리에서 [Insights - Network]를 통해 확인할 수 있다.

   










5. fork/clone 와 pull request


 마지막으로 오픈소스의 발전 속도를 가속화하는 기능인 fork와 pull request에 대해 알아보자.

fork               : 다른 사용자의 원격저장소를 내 원격 저장소 복제
clone            : 원격 저장소를 로컬 저장소에 복제
pull request  :  저장소 간의 병합요청

  fork는 말 그대로 다른 사용자의 저장소를 내 저장소에 똑같이 복사하는 기능이다. pull request는 복사한 다른 사용자의 저장소에서 여러 기능 수정 및 추가를 한 후, 나의 변경 내역을 저장소 소유자(오리지널 저장소)에 병합요청을 하는 기능이다. 즉, 다른 사람의 소스를 내가 수정하고 변경요청을 통해 '기여'할 수 있는 기능이다.


 


 이를 직접 실습하기 위해선 또 하나의 계정이 필요하다. (저자는 두 개 있다)  다른 계정으로 지금까지 작업해온 저장소를 fork해보자. 레퍼지토리오른쪽 상단의 fork 버튼을 누르면 된다. fork 된 저장소의 원격 저장소 주소를 복사하여 git Bash에서 새로운 환경에 clone해보자. 




 
 clone한 저장소에서 git remote -v를 해보면 자동으로 복사했던 원격저장소(fork한)의 주소와 연결되어있다. 약간의 코드 수정을 하고 push까지 해보자. 
 


 
 Push까지 완료하면 fork 했던 원격 저장소를 보면 다음과 같이 커밋이 업데이트 되어있고, 기존 저장소와는 다르게 pull request가 있음을 확인할 수 있다. pull request를 해보자.




본 저장소와 fork 저장소의 변경사항을 보여주고 Create pull request 버튼을 통해 pull request를 생성할 수 있다. pull reqeust를 생성할 때, 보통 오픈소스 프로젝트에서는 template이 있어, 템플릿에 맞게 내용을 작성하여 병합요청을 해야한다.  





 다시 소유자의 계정으로 돌아가보자. pull reqeust 메뉴에 다른 사용자가 요청한 pull request가 생성되어있고, 내용을 확인할 수 있다.

 pull request를 받은 본 저장소의 소유자는 변경 내용을 확인하고 적합하다면 merge 버튼을 통해 병합할 수 있고, 또는 변경을 요청하며 병합을 거절할 수 있다.

 





 Merge를 하면 다른 유저가 변경한 코드 변경 내역을 원래의 저장소에 병합하게 된다. 다음 시간에는 위 이미지에서 오른쪽에 보이는 Reviewers 및 Labels, Project, Milestone에 대해 포스트할 계획이다.


  Github 기초 사용법 - 1




Git 이란 ?

 깃(Git)은 컴퓨터 파일의 변경사항을 추적하고 여러 명의 사용자들 간에 해당 파일들의 작업을 조율하기 위한 분산 버전 관리 시스템이다(wiki). 즉, 한마디로 개발자들에겐 소스코드의 버전관리를 위한 시스템이다!
 우리(개발자)는 개발을 할 때, 여러 어려움을 겪는다. 기능을 구현하다가 실패했을 때, 이전 상태로 돌아와야한다. 또는 설정파일을 잘못 수정했다가 백업을 해두지 않으면 큰 문제가 발생하기도 한다. 또는 여러명이 같이 협업을 할 때에도 코드의 일관성을 유지하는데 큰 어려움을 겪는다. 이러한 문제를 Git을 통해 해결할 수 있다.
 이번 포스트에서는 Git을 Terminal Interface를 통해 사용하는 방법에 대해 다룬다(우리는 개발자니까). 그리고 Git 설치는 생략한다.
Git 을 만든 '리누스 토발즈' 는 Git을 만들기 전에 BitKeeper라는 상용 버전관리 시스템을 사용하였으나, 어떤 계기로 인해 직접 Git을 만들기 시작했고, 소문에 의하면 2주만에 완성했다고 한다.   


목 차

   1. git init & status & add
   2. Commit
   3. Branch
   4. Merge
   5. 병합(merge) 충돌 관리
   



1. git init & status & add

  먼저 작업공간을 정한 후, Git Bash를 열고 git init을 생성하면 다음과 같이 초기화된다.




  git init을 완료하면 (master)가 추가됨을 확인할 수 있고, 내 작업공간에서 버전 관리를 위환 환경이 구성됨을 의미한다. 하지만 폴더 내에서는 아무 변화가 없어보인다.


 폴더에 파일 하나를 생성해보자. Hello, World를 출력하는 C코드를 작성해본다.

#include<stdio.h>

int main(){
    printf("Hello, World!\n");
    return 0;
}


  그리고 Git Bash 로 돌아가 git status를 입력하면 추적되지 않은 파일이 하나 생성되었음을 알려주고, 친절히도 변경사항을 저장하라는 git add 명령어를 제안한다. git add 명령어를 통해 변경사항을 저장하고 다시 status 명령어를 통해 확인해보자.


 git status : 현재 작업공간에서의 변경사항이 있는지 현재 상태를 알려줌

 git add [파일이름] : 변경된 파일을 (인덱스에) 추가함


 git add * : 현재 작업공간의 모든 파일의 변경사항을 추가




 git add 로 변경사항을 추가하였다. 하지만, 내용을 확정하려면 다른 명령어가 필요하다.




2. Commit

git commit : 변경 내용을 확정

 git add를 통해 변경사항을 추가하였지만, 언제든 코드는 수정될 수 있다. 따라서 변경사항을 확정하기 위해 commit 명령어가 필요하다. git commit을 해보자. git commit을 실행하면, vim 에디터로 넘어가면서 commit의 메세지를 작성하라고 알려준다. 메시지 작성하기 위해선(vim 사용법에 대해 자세히 다루진 않는다).  i 를 누르면 입력모드가 되며, 'message' 를 작성한 후, ESC 를 누르고,  " :(콜론)wq " 를 입력하면(w - write, q - quit) 저장할 수 있다. 메시지는 사용자가 임의의 메시지를 작성하면 된다. commit이 완료되면 마지막 이미지와 같이 추가된 하나의 파일이 저장됨을 확인할 수 있다.  


git commit -m "message"    :  -m 옵션을 통해 메세지를 바로 입력할 수 있다.


 


 




3. Branch

 Branch는 가지를 치는 것과 같다. 처음 git을 초기화하면 master 브랜치가 생성된다(터미널에 표현되는 것처럼). 브랜치는 새로운 기능을 구현하기 위해 현재 코드 상태에서 새로운 가지로 뻗어나가 기능을 구현한 후, 완료되면 기존의 가지(master 또는 다른 branch)에 병합할 수 있다. 




  브랜치를 생성해보자. git branch python을 통해 python이라는 이름의 브랜치를 생성한다. 그리고 git checkout으로 브랜치를 변경할 수 있다.


git branch [브랜치 명] : 브랜치 생성

git branch -a  또는 git branch --list)   :   브랜치 ( -a : 모든 ) 목록 확인

git checkout [브랜치 명] : [브랜치 명] 브랜치로 작업환경 변경





 브랜치를 변경하여도 아직 작업공간에서는 변화가 없다. python 브랜치에서 Hello, World를 출력하는 python 코드를 작성하고 commit까지 해보자.



 그리고 git checkout master 브랜치로 다시 이동해보면, 방금 작성했던 python 파일이 사라진다. 즉, python 브랜치에서 코드를 작성하고 변경한 내역이기 때문에 master 브랜치와는 독립적으로 동작함을 확인할 수 있다.

 






  

4. Merge

 git merge  [브랜치 명] : '현재' 브랜치에서 [브랜치 명]의 변경사항을 병합


 git merge를 통해 다른 브랜치와 병합할 수 있다. 주의할 점은 '현재' 브랜치에서 변경한다는 점이다. 즉, master 브랜치에서 git merge python을 하는 것(python 브랜치를 master 브랜치에 병합)과, python 브랜치에서 git merge master (master 브랜치를 python 브랜치에 병합) 하는 것은 다르다


 master 브랜치에서 python branch를 병합해보자.





병합을 하고 나면 python 브랜치에만 있던 python 코드가 master 브랜치에 병합되어 합쳐짐을 확인할 수 있다. 여기까지 git의 기초 사용법에 대해 다루었다. 다음은 각 브랜치를 병합 시에 쉽게 발생할 수 있는 충돌을 관리하는 법에 대해 다룬다.





5. Merge 충돌 관리

 여러명이 같은 기능을 수정하거나 하면 충돌이 쉽게 발생한다. 즉, 두 명이서 같은 파일에서 작업하면 기존의 내용이 서로 다를 수 있으며, git은 어떤 코드를 반영해야할지 모르게 된다. 충돌이 나는 상황을 살펴보자.


 먼저 python 브랜치에서 python 코드에 주석을 작성하고, commit한 후, master 브랜치에서도 똑같이 주석을 다른내용으로 작성하고 commit을 완료해보자.




 그리고, master 브랜치에서 python 브랜치를 병합해보자. 



 충돌이 발생했다고 표시되며, 브랜치 표시가 (master|MERGING) 으로 변경되었다. master|MERGING 상태는 충돌을 해결하기 위한 임의의 브랜치라고 볼 수 있다. 사용자는 충돌이 발생한 코드를 확인해 변경 후 commit을 하면 충돌을 해결할 수 있다. 

참고로, git diff 명령어를 통해 어디서 충돌이 발생하였는지, 어떤 변경이 있었는지 추적할 수 있다.


<<<<<<HEAD : 현재 브랜치의 표시

 [HEAD]의 코드

=========== : 현재 브랜치와 병합 브랜치의 구분선

 [병합 할 브랜치]의 코드

>>>>>>[브랜치 명] : 


 git diff : 병합 전 어떻게 바뀌었는지 확인가능


 두 주석 모두 변경사항으로 반영하기로 하고, commit을 해보자. 그러면 (master|MERGING)에서 다시 (master) 브랜치로 돌아옴을 확인 할 수 있다.

 



 여기까지 git의 기본 사용법에 대해 다루었다. 사실 아직 git의 가장 인기있는 호스팅 사이트인 github을 사용하지 않고, 로컬 저장소 환경에서만 git의 사용법을 다루었다...(작성하다보니 너무 친절해져서...) 앞으로는 Github의 원격 저장소 및 issue, project 등 여러 기능까지도 다룰 계획이다.




+ Recent posts