Github Projects 사용해보기 (1)

 

안녕하세요 :) Zedd입니다.

오늘은 그냥 Github 프로젝트 만들어보는..

 

# Issues

개인프로젝트 진행 할 때, 할 일들을 까먹지 않게 기록하고 싶었습니다. 

그리고 그것들을 Repository에 있는 Issues기능으로 

이렇게요.

아시는 분은 아시겠지만, 이슈에는 아래 그림처럼 번호가 있고, (#7)

커밋 메세지에

"#7 어쩌구 저쩌구"를 넣으면, 

이슈에 자동으로 관련 커밋을 보여줍니다. 

 

# 할 일 관리가 안된다

할 일 기록해야지! → 만만한 Issues탭에 가서 issue만들기

이런 Flow로 Issues탭을 메모장(?)느낌으로 사용하고 있었습니다.

 

결과적으로 할 일 관리가 전혀 안되는 느낌이었습니다.

물론 Issues가 할 일 관리용으로 쓰는게 아니어서 제가 불편하다고 느낀거겠죠!?

이슈가 많아지면 찾는것도 귀찮고, 회사에서 JIRA를 쓰고 있어서 그런지..

저는 "그래 지금 내가 할 일이 뭐지?" 이걸 먼저 정해야..일이 잘되거든요. 

Issues로는 지금 내가 할 일을 찾기가 너무 힘들었습니다. 

 

 

# Github Projects

이러한 이유때문에 

Github Projects 기능을 사용해보려고 합니다.

만드는 법은 간단합니다.

Create a Project를 눌러줍니다.

Create a Project를 누르면 나오는 화면입니다. 

프로젝트 보드 이름, 설명을 써줍니다.

중요한 부분을 설정해야하는데요.

프로젝트 템플릿입니다.

 

# Project Template

- None 

- Basic kanban

- Automated kanban

- Automated kanban with reviews

- Bug triage

이렇게 5개의 템플릿이 존재합니다.

각각 어떤건지 알아볼텐데요, 

참고로 이 글에서는 None으로만 만들어볼 예정입니다. 

 

None은 완전히 빈 프로젝트 보드로 시작하는 설정입니다.

Column을 추가하고, 자동화 설정(automation settings)을 직접 구성할 수 있는 템플릿입니다. 

# None

None은 만들면 이렇게 아무것도 없습니다.

Add a column을 누르면

이렇게 Column을 만들 수 있습니다. Preset으로 많이 쓰이는것들도 만들어져있군요. 

 

# Preset: None으로 만들기 

Preset을 안쓰고 그냥 만들어봤습니다. 그냥 평범하게 만들어지고..

이렇게 Note를 만들 수 있습니다.

(Issues탭에 있는 Issue를 끌어와 추가할 수도 있습니다.) 

 

# Preset: To do, In progress, Done사용해보기 

Preset을 사용해보겠습니다. 

Preset을 누르면 꽤나 본격적으로..설정할 수 있습니다.

To do부터 보겠습니다.

 

1. Preset: To do

2개의 섹션으로 나눠져있습니다.

- 첫번째 섹션(Issue관련) 

Newly added - 이 프로젝트에 추가된 이슈를 만들면, 해당 이슈는 자동으로 Todo에 들어가게 해주는 설정. 

Issues탭에 가서 Issue를 만들고, 우측의 프로젝트에서 만든 프로젝트를 선택해줍니다. 

다시 Projects탭에 가서, 아까 만든 To Do Column을 보면, 

이렇게 자동으로 이슈 카드가 To Do Column에 추가된 것을 볼 수 있습니다. 

 

Reopened - close 된 이슈가 이 프로젝트에서 reopen되었을시, 자동으로 To Do쪽으로 옮겨지게되는 설정. 

Done Column이 만들어져있다고치고..해당 이슈를 끝내고 Done쪽으로 옮겼습니다.

물론 이슈쪽에서도 close가 되었습니다.

이 친구를 Reopen하겠습니다.

Done에 있었지만, 다시 To Do로 돌아온 것을 볼 수 있습니다.

 

- 두번째 섹션(PR관련) 

첫번째 섹션과 똑같아 보이지만, 이건 PR과 관련된 설정입니다. 

Newly added - 이 프로젝트에 추가된 Pull Request가 생성되면, 자동으로 To do에 추가하는 설정입니다. 

PR을 만들어보겠습니다.

다시 Projects탭으로 가서, To do로 가보면

PR이 To do에 추가된 것을 볼 수 있습니다.

Reopend - 이 프로젝트에 추가되었고, close된 PR이 다시 열리면 To Do에 추가하겠다는 설정입니다. 

이건 굳이 보여드리진 않을게요.

 

2. Preset: In progress

2개의 섹션으로 나눠져있습니다.

- 첫번째 섹션(Issue관련)

Todo의 reopned 설정이랑 똑같습니다.

이 프로젝트에 추가된 이슈가 reopen됐을 시 To Do에 추가될지, In progress에 추가될지입니다.

저는 이미 To Do에서 이슈가 reopen되면 To Do에 추가해줘! 설정을 켜놨기 때문에 

"The To Do column is already using this rule"이라고 나오는 것입니다.

저는 To Do에 들어갔으면 좋겠으니 켜진 않을게요.

 

- 두번째 섹션(PR관련)

- Newly added, Reopened은 To Do와 똑같습니다. 생략.

- Approved by reviewer : PR이 최소 필수 approving review를 받으면 자동으로 이 Column으로 이동하겠다는 말입니다. Pending approval by reviewer가 활성화 된 경우 권장한다고 합니다.

- Pending approval by reviewer : 리뷰어가 requests changes를 하거나, 필요한 최소 승인 리뷰 수를 충족하지 못할 때 자동으로 이 Column으로 이동하겠다는 말입니다. Approved by reviewer 설정이 활성화 된 경우 권장된다고 합니다.

 

Approved by reviewer와Pending approval by reviewer는 글로만 봐서는 와닿지 않을 수 있습니다. 

Github Projects (2)글의 Automated kanban with review 부분을 보시면 도움이 되실겁니다. 

 

3. Preset: Done

2개의 섹션으로 나눠져있습니다.

- 첫번째 섹션(Issue관련)

프로젝트에 추가된 이슈가 close되면 자동으로 Done으로 옮겨질지 결정하는 설정입니다.

To Do에 테스트라는 이슈가 있고, 이슈로 가서 그걸 close해보겠습니다.

자동으로 Done으로 옮겨집니다.

- 두번째 섹션(PR관련) 

- Merged : PR이 merge되면 자동으로 Done으로 옮겨주는 설정. 

- Closed with unmerged commits : PR이 merge되지 않은 채 닫히면 자동으로 Done으로 옮겨주는 설정

To Do에 PR이 있고, 이걸 Merge하지 않고 그냥 Close해보겠습니다.

(Merge하면 당연히 Done으로 들어가겠죠? Merged 설정을 on해놨으면)

이렇게 Done으로 옮겨지는 것을 볼 수 있습니다.

저는 merge되지 않고 그냥 close된 PR을 Done으로 옮기고 싶지 않으니 설정을 비활성화 해놔야겠습니다.

왜이렇게 화질구지 됐지..?

이렇게 드래그 하여 카드를 옮길 수도 있습니다.

또한, 우상단에 있는

Add cards를 눌러, 만들어진 Issue들을 추가할 수 있습니다.

 

# 끝으로 

- None  ✅

- Basic kanban

- Automated kanban

- Automated kanban with reviews

- Bug triage

 

위 5개의 템플릿 중 , None으로 하여 만들어봤습니다.

아예 빈 보드에서 column추가나, 설정을 전부 내 맘대로 할 수 있었습니다.

다른것들도 궁금하니 한번씩 다 봐야겠습니다.

 

새해 복 많이 받으세요! 

다음 글: Github Projects 사용해보기 (2) 읽으러가기