Alfex4936/kakaotalk-ci-action

카카오톡 Github Action for CI

카카오톡 CI

Github Action을 이용한 카카오톡 CI 봇

function_name에는 send_to_me_custom (나한테 보내기)나 send_to_groups_custom (친구들에게 보내기)를 사용할 수 있습니다. (템플릿 이용한 버전)

! send_to_groups 에서는 with: 에 receiver_uuids를 ["uuid1", "uuid2"] 형식으로 지정해 넘겨야 합니다.

Usage

name: Example CI

on:
  push:
    branches:
      - main

jobs:
  build-and-notify:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Send KakaoTalk notification
        uses: Alfex4936/kakaotalk-ci-action@main
        with:
          kakao_access_token: ${{ secrets.KAKAO_ACCESS_TOKEN }}
          function_name: send_to_me_custom
          template_id: "93112"
          template_args: '{"title": "제목", "desc": "설명"}'

Setup

1. 카카오톡 채널 앱을 만든다. @링크

2. 카카오톡 로그인 메뉴를 활성화한다.

3. 동의항목에서 이러한 메뉴들을 설정해준다.

동의 목적은 아무거나 적어도 된다.

4. 팀원 관리

팀원 관리에서 메시지를 받을 팀원들 추가해준다. (EDITOR) 혼자 사용할 것이면 스킵

5. [옵션] 메시지 - 메시지 템플릿 바로가기에서 메시지를 디자인한다.

6. Github Secret 값을 추가한다.

KAKAO_ACCESS_TOKEN 을 @카카오 문서를 참고해서 얻는다.

또는 [도구] - [REST API 테스트] - 인증 앱 선택 후 ACCESS TOKEN을 발급

1. .github/workflows 폴더에 ci.yml Github Action 추가

예를 들어 아래와 같이 무조건 카카오톡으로 보낼 수 있다.

실패할 때만 보내려면 if: always() 를 추가하면 된다.

93112 template_id 는 title과 desc를 (제목과 설명)을 보낼 수 있습니다.

name: Example CI

on:
  push:
    branches:
      - main

jobs:
  build-and-notify:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Send KakaoTalk notification
        uses: Alfex4936/kakaotalk-ci-action@main
        # if: failure()
        with:
          kakao_access_token: ${{ secrets.KAKAO_ACCESS_TOKEN }}
          function_name: send_to_me_custom
          template_id: "93112"
          template_args: '{"title": "제목", "desc": "설명"}'

8. 결과