[CI/CD] Jenkins Trigger 정보 Discord로 보내기

System 작업실/DevOps

[CI/CD] Jenkins Trigger 정보 Discord로 보내기

주니쓰🧑‍💻 2023. 6. 1. 21:04

728x90

젠킨스 마스터

COUPANG

www.coupang.com

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

🗂 목차

⚠️ 아래 목차 중 몇몇개의 링크가 걸리지 않는 문제로 글 맨 하단에 다음 글로 이동할 수 있게 해 두었습니다.

🤔 내가 만난 문제

⛔️ [Jenkins] java.lang.OutOfMemoryError: Java heap space

🚀 Jenkins Trigger 정보 Discord로 보내기

🔽 개요

📦 구성도

📦 소개

여러 개발자들이 작업을 할 때, Dev Branch나, Master Branch에 Merge가 되어 CI/CD가 진행되게 되면 어떤 단계를 거쳐 어떻게 진행되고 있는지 Jenkins Web Service를 보지 않는다면 확인할 수가 없어요.

하지만, Jenkins와 같은 중요한 Service는 꼭 필요한 사람 외에는 접근이 불가해야 할 것이고, 접근이 불가한 사람들도 CI/CD 진행 사항이 궁금할 것이고, 접근이 가능하다고 하더라도 굳이 Web Service를 보지 않고, 확인할 수 있다면 더 좋을거에요.

Jenkins Trigger를 받을 수 있는 SNS는 Slack도 있지만, 주니는 Discord를 통해 받는 것을 해보려고 합니다.

현재 주니가 하고 있는 Project는 Discord Bot을 통해 많은 것들을 할 수 있기 때문이에요.

🔽 Jenkins

📦 설정(Configure)

최초 Discord와 연결을 위해 Jenkins PlugIn을 설치해 주어야 해요.

위와 같이 Discord Notifier PlugIn을 설치해 줍니다.

참고로 현재 주니가 구성한 Jenkins Job은 MultiBranch Pipeline Item이기 때문에
빌드 후 기능 Option이 존재하지 않아요.

그래서 주니는 pipeline Script를 이용해서 작성해 줄거에요.

728x90

🔽 Discord

📦 설정(Configure)

최초 위와 같이 채널을 하나 만들어 줄게요.

그런 뒤 해당 채널 설정창으로 들어와 위와 같이 연동으로 이동해 줍니다.

이 곳에서 Webhook 만들기를 선택해 줄게요.

이렇게 설정을 하고, 웹후크 URL 복사를 눌러 만들어진 URL을 획득하고, 변경사항 저장하기를 눌러줄게요.

그런 뒤 jenkins file에 Build가 성공했을 때와 실패했을 때 알림을 받기 위한 내용을 추가해 주었어요.

위의 link 부분 Discord 알림 Message에 Title 문자열에 하이퍼링크 처리를 하여 클릭하면
Jenkins로 이동할 수 있게 처리해주기 위함이에요.

webhook URL에는 Discord에서 받은 URL을 넣어주면 되요.

이렇게 하고, Gitea로 Push를 하게 되면 Jenkins에 Trigger가 걸리게 되고,
작업이 끝나면 아래와 같이 Discord에 알림이 오는 걸 확인할 수 있어요.

하지만, 위와 같이 jenkinsfile에 Discord Webhook 주소를 Hard Coding하는 건 좋은 방법이 아니에요.

그래서 Jenkins Credentials를 이용해서 안전하게 해당 값을 보관하고, 가져올 수 있도록 해 볼게요.

Jenkins 관리 -> Credentials -> System -> Global credentials (unrestricted)

이 곳에서 Add Credentials을 눌러 줄게요.

최초 kind는 Secret text로 선택해 주세요.

secret 부분에는 Discord Webhook URL을 입력해 주고, ID에는 해당 Credentials에 이름을 넣어주면 되요.

그리고, Description에는 설명을 작성해 주면 된답니다.

그런 뒤 create 버튼을 눌러 줄게요.

pipeline {
    agent any
    environment {
        WEBHOOK_URL = credentials("Total-Back-Office-BE-Discord-Webhook")
    }
    
    stages {
        stage('Start') {
            steps {
                echo "Hello, Juny hehe!! 😀"
            }
        }
    }

    post {
        success {
            discordSend description: "Jenkins CI/CD Trigger Alarm",
                footer: "Build 성공 하였어요. 😀",
                link: env.BUILD_URL, result: currentBuild.currentResult,
                title: "Jenkins CI/CD Trigger Discord를 통해 받기 시험 중 입니다.",
                webhookURL: env.WEBHOOK_URL
        }

        failure {
            discordSend description: "Jenkins CI/CD Trigger Alarm",
                footer: "Build 실패 하였어요. 😢",
                link: env.BUILD_URL, result: currentBuild.currentResult,
                title: "Jenkins CI/CD Trigger Discord를 통해 받기 시험 중 입니다.",
                webhookURL: env.WEBHOOK_URL
        }
    }
}

그리고 위와 같이 jenkins File을 수정해 주었어요.