Github Organization 프로젝트 세팅하기

프로젝트를 Github Organization에서 진행하고 FE, BE 등 각 파트 별 리포지토리를 분리해서 관리하고자 한다.

 

프로젝트는 4명이서 약 3개월 진행하는 사이드 프로젝트이다.

리포지토리 하나로 관리해도 괜찮은 규모의 프로젝트지만, 협업 도구로 github의 PR과 이슈 등을 관리하고, CI/CD로 gitaction을 사용하기 위해 파트 별 리포지토리를 분리해야해서 Oragnization을 선택했다.

 

Organization 직접 보러 가기

---

 

🔷 Organization 생성 및 초대

생성 및 초대는 어려운 내용이 아니므로 간략히 적는다.

github - [ Your oragnization ] - [ New organization ]

 

요금제, 이름, 대표 이메일, 개인/기업 여부 선택 등이 이루어진다.

 

---

 

🔷 권장 설정

첫 화면으로 권장되는 설정들 리스트가 나타난다.

회원초대 및 권한 설정, PR 생성해보기, Git Action 생성해보기 등 협업 툴의 기능을 둘러 볼 수 있도록 안내되어 있다.

 

결과적으로 초대 및 권한 설정 외에는 딱히 쓸모가 없었다. PR은 템플릿을 만들것이고, Git Action의 CI/CD는 추후에 진행 할 것이기 때문이다.

 

pull을 땡기지 않고서는 merge할 수 없다는 등의 protection rule을 설정하고 싶었는데, 적용하려면 유료 요금제를 신청해야 해서 포기했다.

 

---

 

🔷 Organization Overview README.md 설정하기

organization 메인 페이지의 우측 상단 팔로우 버튼 바로 아래를 보면, 설정 하면 좋다는 것들이 나타난다.

 

1. organization 공개/비공개 설정
2. create a README
3. pin repositories
4. hide the tasks we've suggested

1, 3번은 개인 github 리포지토리에도 있는 설정과 같다.

4번은 이전 권장 설정 목록을 가리는 기능이다.

여기서 중요한게 3번인데, organization은 리포지토리가 여러개여서 나중에 한 번에 볼 때 어떻게 정리 할까 궁금했다.

3번을 눌러 만들어보니 '[organization 이름]/.github'라는 특수한 리포지토리가 생성되었다.

 

생성된 리포지토리에 'profile' 폴더가 생기고, 그 안에 README.md 가 생성된다.

이 README는 해당 리포지토리에 들어올 때 보이는게 아닌, organization 메인 화면에 보이는 리드미를 꾸밀 수 있다.

다만, 이미지를 다른 폴더에 두고 상대경로로 했을때는, 제대로 나타나지 않는 오류가 있었다.

 

organization 리드미를 꾸민 모습이다.

'.github' 리포지토리에 회고 기록 및 대표 README.md 를 두기로 했고, 위의 리드미는 간략 소개와 대표 리드미 주소를 가리키도록 꾸몄다.

 

---

 

🔷 리포지토리 생성하기

여러 리포지토리를 생성하는데, 템플릿을 만들어 사용 할 수 있다.

이전 포스팅에 정리해두었다.

 

Github 이슈, PR 템플릿 및 label 간단 복사 방법

 

 

---

 

🔷 Organization 프로젝트 생성하기

 

organization의 상위 탭에서 Projects를 들어간다. [ New project ]를 눌러 프로젝트를 생성한다.

 

 

생성 후 Item 을 2개 생성했고, 컬럼 속성인 Status 에 Bug를 추가한 모습이다.

지금은 이슈가 아닌 Item만 생성되어있는데, Issue를 생성하면 자동으로 Todo에 들어갈 것이다.

 

이상으로 프로젝트 진행을 위한 organization 설정을 모두 마쳤다!

하나하나 찾아가면서 하다보니 생각보다 시간이 걸렸던 것 같다.

하지만 github의 협업툴 기능에 대해서 자세히 알수 있게된 것 같다.