Skip to content
김채민 edited this page Aug 9, 2024 · 4 revisions

🛎️ Discord Github Notification

프로젝트 설명

이 프로젝트는 GitHub Action을 통해 GitHub에서 발생하는 다양한 이벤트(예: Pull Request 생성, 이슈 생성 등)를 Discord 채널 알림으로 전송하는 프로세스를 단순화해주는 서비스입니다.
이 Action을 사용하면 중요한 개발 이벤트를 놓치지 않고 바로 Discord에서 확인할 수 있습니다!
이 Action은 커스텀 알림 메시지를 지원하며, 한국어 🇰🇷와 영어 🇬🇧 중 원하는 언어로 알림을 받을 수 있습니다.

👤 개발자: 김채민(Aleph Kim)


🔧 주요 기능

📝 PR 알림

Pull Request 생성, 동기화, 병합, 재오픈, 닫힘 등의 이벤트에 대해 Discord로 알림을 전송합니다.

🌿 브랜치 이벤트 알림

브랜치 생성 및 삭제 이벤트 발생 시, Discord에서 알림을 확인할 수 있습니다.

❗ 이슈 알림

새로운 이슈가 열리거나 닫힐 때, Discord로 알림이 전송됩니다.

🚀 푸시 알림

새로운 커밋이 발생할 때마다, 해당 커밋 정보가 Discord로 알림이 전송됩니다.

🌍 한국어/영어 지원

한국어와 영어 두 가지 언어로 알림 메시지를 설정할 수 있습니다.

🎨 사용자 정의 메시지 지원

사용자가 메시지 템플릿을 자유롭게 설정할 수 있습니다.


📦 주요 구성 요소:

action.yml: GitHub Actions의 핵심 설정 파일로, Action의 입력 변수, 실행 스크립트, 그리고 알림 메시지 전송에 필요한 단계들을 정의합니다.
messages.json: 각 이벤트에 대한 알림 메시지의 언어별 템플릿을 포함하는 파일로, 프로젝트의 메시지 커스터마이징을 지원합니다.


💡 참고 사항:

필수 입력값: Discord 웹훅 URL (discord-webhook-url)
선택 입력값:

  1. 알림 메시지의 언어 설정(language, 기본값은 korean)
  2. 사용자 정의 메시지 사용 여부(custom, 기본값은 false)