Mattermost에서 Gitlab, Jira 연동 알림받기

💡 목적 : Mattermost 채널에 Gitlab과 Jira 변동사항을 알림받는 채널 만들기

 

목차

1. Gitlab 설정하기
2. Mattermost 설정하기
3. Jira 설정하기
4. 테스트

예상 소요시간 : 약 30분

 

---

 

1. Gitlab 설정하기

1 - 1 ) Gitlab 권한 확인하기

깃랩 해당 프로젝트의 권한이 Maintainer여야한다.

멤버에게 어떤 Max role을 주고, 각각 어떤 권한을 주면서 관리하는지는 관리자의 선택에 따라 달라진다.

필자는 팀장으로서 Owner가 부여한 Maintainer로 자체 변경할 순 없었고, 프로젝트 관리를 git flow 전략에 따라 수행하기로 해서 배포를 맡은 팀원만 Developer에서 Maintainer로 변경했다.
Developer는 develop 브랜치에만 push나 merge할 수 있다.(권한은 아래 설정하는 곳 나옴)

 

1 - 2 ) 기본 브랜치 변경

기본 브랜치 설정을 위해 Settings - Repository - Branch defaults - Expand로 들어간다

 

기본값은 master 브랜치가 선택되어 있다

참고로 프로젝트를 생성한 직후 README도 만들지 않은 상태라면, 마스터 브랜치도 뜨지 않을 수도 있다.

필자의 경우가 그랬는데, 한 번 clone 후 README를 만드는 등 아무 커밋이나 남기고 push하면 된다.

이때, develop 브랜치도 생성해주어야 한다.

 

 

1 - 3 ) 브랜치 보호 권한 변경

Protected branches

직전의 기본 브랜치 설정에서 좀 내리면 나오는 브랜치 보호 설정란이 있다.

필자는 포스팅 서두에서 설명한 것 처럼 master 브랜치는 메인테너들만, develop 브랜치는 Developers들도 push & merge 할 수 있게 권한을 설정했다.
여기서 master 브랜치는 릴리즈 할 정도의 개발이 완료 된 후 진행되므로, 우선 아무도 push 할 수 없도록 잠가두었다.

 

1 - 4 ) Jira 연결

Settings - Integrations 에서 Jira와 Mattermost를 연동할 수 있다.

Add an integration 목록에서 Jira와 Mattermost notifications 을 찾을 수 있다.

쓰진 않았지만 활용할만한게 있나 둘러봤는데, Discord나 MSTeams 혹은 이메일로도 알림을 받을 수 있다.
또한 Jenkins나 JetBrains의 배포 관리 툴인 TeamCity도 연동할 수 있다.

 

Jira 탭에서 설정한다.

Web URL은 Jira 프로젝트의 Base URL 이어야 한다.

Base URL이란, 웹 주소에서 변하지 않는 부분, 사이트 안에서 어디로 가든 주소에서 일정하게 보이는 부분, 첫 페이지의 주소 라고 할 수 있다.
필자는 Jira 프로젝트를 누르면 보드의 활성 스프린트 화면이 첫 화면이라 그 URL을 입력했다.
이메일과 password는 Jira 로그인때 사용하는 정보를 입력하면 된다.

 

Trigger 를 설정하자

Commit과 Merge 메세지를 확인해서 Jira 이슈를 완료로 바꿔준다!

체크 후 아래 설정만 Move to Done으로 바꾸면 된다.

잘 이용하면 다양한 관리가 가능 할 것 같은데, Jira와 Gitlab의 연결을 본격적으로 사용하기엔 전문 관리 담당이 따로 있어야 할 것 같아서 간단한 기능만 사용해 볼 생각이다.

이제 설정을 마치고 save를 누른다.

 

Active integrations 에 Jira가 표시된다.

 

1 - 5 ) Mattermost 연결

Mattermost notifications 설정하기

원하는 항목을 체크해서 사용하면 된다. 깃랩에서 관리하는 레포지토리의 변동사항을 감지해 MM으로 알림을 주는건데, 가능한 자세히 나왔으면 좋겠어서 대부분 체크했다. 

Webhook 부분은 MM에서 받아와야한다. 바로 아래에서 알아보자.

 

 

---

 

2. Mattermost 설정하기

2 - 1 ) Webhook 받기

왼쪽 상단 그리드 버튼에서 [통합] 탭으로 들어간다.

통합으로 들어가기 전, 알람을 받고 싶은 채널을 미리 개설해두자.

보통은 private 방으로 만들어두고, 프로젝트 개발에 참여하는 팀원만 초대한다.

 

전체 Incoming Webhook 으로 들어간다.

설명으로는 외부 시스템에서 보내는 메시지를 받을 수 있다고 되어있다.

반대로 외부로 보내는 것도 가능하고, 슬래시 명령어로 외부 서비스에 이벤트를 보낼 수도 있는 것 같다.

이전 Gitlab설정에서 MM에서 슬래시 명령어 란이 있었는데 이런 기능이 아닌가 싶다.

 

Incomming Webhook을 추가한다.

 

Webhook 설정을 완료하고 저장한다.

제목과 설명은 원하는데로 적으면 되고, 채널은 미리 파둔 알림용 채널을 연동한다.
고정도 눌러주고 저장한다.

 

Webhook의 URL이 잘 생성되었다.

이제 URL을 복사해서 이전 Gitlab에서의 MM 설정을 마무리하자.

 

Webhook URL을 입력하고 Save한다.

 

Active integrations에 Jira와 MM 이 잘 나타나면 성공이다.

 

2 - 2 ) Mattermost에 Jira 연결하기

Jira를 연결 할 채널에 슬래시 지라('/jira ')를 쳐보자.

이미 설정되어 있는 다양한 옵션이 있다!

'/jira help'를 쳤더니 옵션을 보여준다.

 

채팅으로 '/jira connect'를 치고 엔터를 누른다.

필자는 두 가지를 선택할 수 있었는데, 'jira.~~.com' 과 '~~~.atlassian.nt' 두 가지 주소가 나타났다.

이 중에서 아틀라시안 주소를 선택한다.

 

Jira 로그인 한다.

필자는 Jira에서 로그인 한 구글로 로그인했다.

 

로그인 완료 후 [Approve]를 눌러 Jira에서 MM 으로 연결을 허용한다.

 

채팅으로 '/jira subscribe'를 치면 위와 같은 창이 나타난다.

Create Subscription을 눌러 연결 설정을 생성한다.

 

설정에서 중요한건 Jira에서 생성한 프로젝트를 알맞게 선택하는 것이다.

그 외에 제목은 적당히 작성하고, 이벤트는 받고싶은 목록을 선택한다.

필자는 이 기능을 처음 사용해봐서 모든 태그를 다 눌러었는데 후회하고 다시 수정했다.
이슈 생성과 수정을 켜놓으니 너무 빈번하게 알람이 나타났다.

위 정도가 깔끔하고 좋은 것 같다.

 

Mattermost에 Jira 연결 완료

 

2 - 3 ) Mattermost에 Gitlab 연결하기

연결할 채널에 '/gitlab connect'를 입력한다.

귀여운 여우 깃랩 봇이 링크를 하나 보내준다.

클릭해서 들어가면 깃랩 로그인 창이 나타난다. 로그인한다.

 

Jira와 마찬가지로 Gitlab도 연동을 허용한다.

이때 갑자기 봇이 DM을 보냈다.
링크를 눌러서 사용 방법을 보내준 것 같은데, 관리자님이 연락한 건 줄 알고 깜짝놀랐다.
잘 연동되었으면 왼쪽하단에 깃랩 여우 마크가 추가된다. 귀엽다.
마크를 누르면, 내 깃랩 프로젝트 목록 화면으로 이동된다.

 

---

 

3. 테스트

3 - 1 ) Jira 알림 테스트

테스트를 위해 Jira에서 임시 스프린트와 이슈를 생성하자.

알림 채널에 잘 나타난다! 아무것도 설정하지 않은 이슈라서 우선순위만 나타난다.
링크를 누르면 해당 이슈의 상세보기 페이지로 이동된다.

(여기서 이슈 생성과 수정 마다 알람이 떠서 알람설정을 변경했다.)

 

이제 이슈 완료처리를 테스트해보자 스프린트는 시작을 눌러놓자.

 

3 - 2 ) Gitlab - Jira 연동 + Mattermost 알람 테스트

커밋을 남기고 Push해보자

커밋 메시지 제목에 '[프로젝트번호]-[이슈번호]' 형태로 넣으면 Jira이슈와 연결된다.

필자는 Github Desktop 을 사용하는데, Git bash나 다른 GUI 툴을 사용해도 가능하다.

 

Mattermost에 알람이 잘 나타난다.

develop를 누르면 Gitlab의 커밋 목록으로 이동된다.

그 옆은 프로젝트 명이며, Gitlab 프로젝트 메인 화면으로 이동한다.

Compare chages와 아래 커밋 번호는 해당 커밋의 상세 페이지로 이동한다.

이동한 페이지에서 Jira 이슈 번호를 누르면, Jira의 이슈 상세 페이지로 이동한다.

커밋 상세 페이지로 넘어간 모습과 Jira의 해당 이슈 상세보기 페이지로 넘어간 모습이다.

설정이 완료되었다!

 

---

 

4. 마치며

 

커밋 메세지에 Jira 이슈번호를 넣어서 자동 '완료됨' 상태로 바꾸고 싶었지만,
Jira에 앱 추가 권한이 없어서 실패했다. 관리자님에게 문의를 남겼는데 가능할 지 모르겠다.

 

여러 프로그램을 연결하는 작업은 개발 지식에 아주 큰 도움이 된 것 같다.

이 내용을 따라하는건 30분을 예상하지만, 작성에는 6시간이나 걸렸다...

특히 Jira 이슈 상태 변화에 절반을 쏟았지만 실패한게 너무 아쉽다.

이 글을 참고하는 분들은 시간을 아끼고 큰 도움이 되었으면 한다.

 

다음 포스팅을 참고했다👍 : https://pythontoomuchinformation.tistory.com/453