Skip to content
play

GitHub Action

Pull Request Reminder Bot

v1.0.1 Latest version

Pull Request Reminder Bot

play

Pull Request Reminder Bot

Send slack or discord messages to remind reviewing pull requests

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Pull Request Reminder Bot

uses: rrgks6221/[email protected]

Learn more about this action in rrgks6221/pr-notification-bot

Choose a version

Github Pull Request Reminder Bot

PR 알림을 위한 Bot 입니다.

./.github/workflows/sendPrRemind.yml 의 cron 식에 따라 리뷰해야할 PR 을 Remind 해줍니다.


지원되는 Messenger Tool

  • Discord
  • Slack

image

How To Use Custom

  1. git clone https://github.com/rrgks6221/pr-notification-bot.git

  2. .env.sample 파일과 같은 형식으로 .env 를 만든 뒤 값을 채워주세요.

  3. message format customizing

    • discord, slack 사용 시 Message 의 각 메서드를 수정해주세요.
    • 다른 Messenger 를 사용한다면 해당 webhook interface 에 맞게 Message 의 새로운 메서드를 추가해주세요
  4. npm i

  5. npm run start 를 통해 채널에 메시지가 잘 오는지 확인해주세요.

  6. ./.github/workflows/sendPrRemind.yml 을 custom 해주세요.

  7. github action 상 추가 방법

    1. 본인 repository
    2. Settings
    3. Secret and variables - actions
    4. 사진처럼 값을 채워주세요.image

Contributors


License

Git Hub Pull Request Reminder Bot is MIT licensed.