Issue
깃허브 이슈는 소프트웨어 개발 과정에서 발생할 수 있는 버그, 개선사항, 질문 등을 트래킹, 관리 할 수 있는 시스템입니다.
프로젝트의 일정이나 다양한 이슈를 관리할 수 있고, 팀의 협업을 보다 효율적으로 할 수 있습니다.
Issue 사용방법
우측 상단의 New issue 버튼으로 새로운 issue 를 등록 할 수 있고, open 과 closed 로 이슈의 상태를 알 수 있습니다.
기존에 만들어져있는 issue 탬플릿이 있다면, 선택해서 사용 할 수 있습니다.
새로운 issue 템플릿을 원한다면, Settings - Features 의 issues 에서 Set up templates 를 통해 생성 할 수 있습니다.
기존 템플릿 혹은 비어있는 템플릿으로 이슈를 생성 하면, 우측에 여러 설정을 할 수 있는 것이 보이는데 각각 아래와 같습니다.
- Assigness: 해당 작업의 담당자
- Labels: 해당 작업의 성격
- Milestone: 해당 작업이 속한 파트
label 의 기본 세팅 이미지입니다.
생성, 수정, 삭제를 할 수 있으니 성격에 맞게 설정하면 됩니다.
마일스톤 세팅 이미지입니다.
이슈를 큰 파트로 나누기 위해 사용하는 편입니다.
종료된 issue 는 close issue 버튼을 통해 종료할 수 있습니다.
Projects
깃허브 프로젝트는 프로세스의 전반을 관리합니다.
Projects 사용방법
사용할 레포에서 Projects 탭을 누른 뒤, 버튼에서 New Project 를 눌러 새로운 프로젝트를 생성합니다.
기본적으로 Table, Board, Roadmap 중에 선택한 뒤에 필요한 기능을 추가하여 사용해도 되고, 제안해주는 기능에서 골라 사용할 수도 있습니다.
저는 Team Planning 을 선택하도록 하겠습니다.
프로젝트 생성 시, 다음과 같은 화면을 볼 수 있습니다.
Backlog, Teamcapacity, Current iteration 등 다양한 뷰로 프로세스 진행상황을 관리할 수 있습니다.
프로젝트 생성 후, 이름을 수정하고 싶다면 우측 상단의 버튼을 눌러 Settings 로 이동할 수 있습니다.
Settings 에서는 프로젝트 이름뿐만 아니라, 관리에 사용될 정보들을 수정하고 생성할 수 있습니다.
Backlog 의 화면 하단에서는 issue 를 바로 생성 할 수 있습니다.
위 이미지 처럼 # {repo name} 을 사용하여, 어떤 레포지토리에 이슈를 사용할 지 선택 할 수 있습니다.
다음과 같이 이미 존재하는 'test-01' 이라는 issue 를 등록 할 수 도 있고, 'Create new issue' 를 할 수도 있습니다.
새로운 이슈를 생성하는 화면입니다.
최상단의 버튼을 눌러, 기존에 사용하는 이슈 템플릿으로 변경할 수 있습니다.
기존 템플릿을 사용하는 화면입니다.
화면 하단을 보면, Assignee, Label, Milestone 을 각각 지정해준 것을 볼 수 있습니다.
이렇게 이슈를 생성 할 수 있습니다.
혹시 repo 와 연결하지 않고, 그냥 issue 를 생성했다면 위 이미지의 'test-03' 처럼 Draft 라는 표시와 함께 보여지게 됩니다.
우측의 버튼에서 'Convert to issue' 를 누르고 원하는 repository 를 등록해주면 됩니다.
생성한 이슈를 눌러서 들어가면,
우측에 Priority, Size, Estimate 등 설정 할 수 있습니다.
git project + issue + pr
Projects 를 생성하고 사용할 수 있게 되었는데,
branch 에서 해당 issue 에 맞는 commit 을 하는 경우에
자동으로 연동이 되게 하는 방법은?
해당 issue 의 기능을 작성할 브랜치 이름을 만들때, #이슈번호를 같이 넣어주면 좋다고 생각합니다.
( 보기 편하게 진행하기 위해 )
commit message 에도 #이슈번호 를 넣어서 작성하면, 나중에 github 에서 묶어서 보기 좋습니다.
Pull Request 작성 시, Comment 에 close {#이슈 번호} 를 직접 넣어서 연동시켜서 issue 를 닫아주어야 합니다.
( 닫아준다는 키워드가 없으면 닫히지 않음 )
혹은, PR 시 우측 Development 에서 수동으로 이슈 연결이 가능합니다.
( 키워드 입력하지 않아도 merge 시 자동 closed )
응? merge 되면 자동으로 닫히는게 아닌가? 안되는데;;
이렇게 생각했는데, default(main or master) 브랜치에만 적용이 가능합니다.
default 브랜치를 변경하지 않고,
다른 브랜치에 pr 을 날리고, merge 할때도,
issue 와 연동이 되어 자동으로 close 되었으면 좋겠다..
-> Github Action 을 통해서 해결 할 수 있는 방법이 있을 것 같은데... 아직 해결하지 못했답니다... 🥲
