[Jenkins] 웹훅을 이용한 Jenkins-Mattermost 연결

✅ Jenkins의 빌드 결과를 Mattermost 메신저로 전달해보자

MatterMost 설정

Webhook 추가

MatterMost > 왼쪽 상단 메뉴 버튼 > 통합 > 전체 Incoming WebHook 클릭

Webhook 설정

Incoming Webhook 추가하기를 누른 후, 아래와 같이 입력해주고 알림을 받을 채널을 설정한다.

설정 후, 저장을 누르면 아래와 같이 WebHook URL이 나온다. 

이 URL을 잘 기억하자!

Jenkins 설정

Jenkins > item > 구성 클릭

Curl 명령어로 보내기

Shell script를 실행하여 curl 명령어로 mattermost 메세지를 보내는 방법이다.

Build에서 Add build step > Execute shell 클릭 후, 가장 아래로 보내기.

위와 같이 코드를 입력한다. 

 

💡 $COMMIT_MSG: 가장 최근의 커밋 메세지를 가져온다.

💡 $GIT_BRANCH, $JOB_NAME, $BUILD_DISPLAY_NAME: 모두 젠킨스에서 제공하는 환경변수들이다. 자세한 내용은 아래 See the list of available environment variables를 클릭해서 확인하면 된다.

💡 REQUEST의 가장 아래줄에 MatterMost에서 생성했던 WebHook URL을 넣는다.

#!/bin/sh

COMMIT_MSG=$(git log --oneline --format=%B -n 1 HEAD | head -n 1)
REQUEST="curl -i \
        -X POST \
        -H 'Content-Type: application/json' \
        -d '{ \
                \"icon_url\": \"https://www.mattermost.org/wp-content/uploads/2016/04/icon.png\", \
                \"attachments\": [{ \
                		\"text\": \"$GIT_BRANCH Build & Depoly finished! :clap: \", \
                        \"author_name\": \"Jenkins\", \
                        \"author_icon\": \"https://www.jenkins.io/images/logos/jenkins/jenkins.png\", \
                        \"title\": \"$JOB_NAME $BUILD_DISPLAY_NAME - $COMMIT_MSG\" \
        }] \
        }'\
        https://{{WEBHOOK URL}}"
        
eval $REQUEST

이렇게! Build 성공 후, MM 메세지가 오는것을 확인할 수 있다.

주의해야 할 점은 Build 실패 시, 메세지가 오지 않는다는 것이다!!!

참고: https://docs.mattermost.com/developer/webhooks-incoming.html

Plugin을 활용하여 보내기

좀 더 간단하고 다양하게 쓸 수 있도록 Plugin을 설치해서 보내보자!

플러그인 설치

Jenkins > Jenkins 관리 > Plugin Manager 클릭

설치 가능에서 Mattermost Notification Plugin 을 찾아 설치한다!

빌드 후 조치 설정

Jenkins > item > 구성 클릭

빌드 후 조치에서 Mattermost Notifications를 클릭한다.

원하는 알림을 설정하고 

고급을 클릭한다.

💡 Endpoint : MatterMost 웹 훅 URL 

💡 Project Channel : MatterMost 채널 > 정보 보기 > URL 가장 뒤에 나오는 채널 이름

 

Test Connection을 누르면 연결에 성공했다는 Success메세지와 MatterMost 알림이 온다.

그 후, 저장을 하고 빌드를 실행하면 동일하게 알림이 온다~~~~ (형식은 다름)

---

이렇게 Jenkins와 MM를 연결하는 두가지 방법에 대해 알아보았다.

개인적으로 Curl을 사용하는게 더 커스터마이징이 편해서 위의 방법을 택했다 :)