[Chore]: 리뷰어 선정 시 슬랙 알림 workflow 적용

[minseong0324]

관련 이슈

close #3

변경 사항

리뷰어 선정 시 슬랙에 알림이 갈 수 있도록 workflow를 적용했어요.

추후 PR 내에서 달리는 코멘트 등을 리뷰어 선정 시 첫 슬랙 알림의 스레드로 이어지게끔 개선할 예정이에요.

레퍼런스

Summary by CodeRabbit

• 새로운 기능

  • GitHub Actions 워크플로우를 통해 PR 리뷰어에게 Slack 알림을 자동으로 보내는 기능 추가
  • PR 리뷰 요청 및 댓글에 대한 자동 알림 시스템 구현

• 구성

  • 리뷰어 매핑 JSON 파일 생성
  • Slack 알림을 위한 워크플로우 설정

[coderabbitai]

Walkthrough

새로운 GitHub Actions 워크플로우가 도입되어 풀 리퀘스트 리뷰 요청을 관리합니다. 워크플로우는 review_requested 이벤트에 의해 트리거되며, 리뷰어 목록을 가져와 Slack 채널로 알림을 보냅니다. JSON 파일을 사용하여 GitHub 사용자 이름과 Slack 사용자 ID를 매핑하고, PR 제목, 리뷰어 목록, PR 링크를 포함한 한국어로 된 알림을 전송합니다.

Changes

파일	변경 요약
.github/workflows/pr-reviewer-noti.yml	새로운 PR 리뷰어 알림 워크플로우 추가
.github/workflows/reviewers.json	리뷰어 GitHub 사용자 이름과 Slack 사용자 ID 매핑 추가

Assessment against linked issues

목표	해결 여부	설명
리뷰어 선정 시 슬랙 알림 워크플로우 적용 [#3]	✅

Poem

🐰 깃허브의 토끼가 노래해요
PR 리뷰 요청, 슬랙에 알려요
리뷰어들아 모여라
코드의 세계로 달려라
협업의 magic, 토끼가 전해요! 🚀

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ae78f93 and e3d3575.

📒 Files selected for processing (1)

• .github/workflows/pr-reviewer-noti.yml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• .github/workflows/pr-reviewer-noti.yml

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

🧹 Nitpick comments (2)

.github/workflows/pr-reviewer-noti.yml (2)

3-6: 워크플로우 트리거 설정을 개선하세요

PR 리뷰어 변경 사항을 더 포괄적으로 처리하기 위해 트리거 이벤트를 확장하는 것이 좋습니다.

 on:
   pull_request:
-    types: [review_requested]
+    types: [review_requested, review_request_removed, review_request_removed_user]

---

28-48: Slack 알림 설정을 개선하세요

1. 메시지 텍스트를 환경 변수나 설정 파일로 분리하는 것이 좋습니다
2. 시크릿 값이 없는 경우에 대한 오류 처리가 필요합니다

시크릿 값 검증을 위해 다음과 같은 단계를 추가하세요:

      - name: Validate Required Secrets
        run: |
          if [ -z "${{ secrets.PR_NOTI_CHANNEL }}" ] || [ -z "${{ secrets.PR_BOT_TOKEN }}" ]; then
            echo "Error: Required secrets are missing"
            exit 1
          fi

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9883d11 and 391d49e.

📒 Files selected for processing (2)

• .github/workflows/pr-reviewer-noti.yml (1 hunks)
• .github/workflows/reviewer.json (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• .github/workflows/reviewer.json

🧰 Additional context used

🪛 actionlint (1.7.4)

.github/workflows/pr-reviewer-noti.yml

11-11: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

---

15-15: the runner of "actions/github-script@v6" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

[coderabbitai]

Actionable comments posted: 2

♻️ Duplicate comments (1)

.github/workflows/pr-reviewer-noti.yml (1)

49-67: ⚠️ Potential issue

코멘트 알림 로직이 올바르지 않습니다

현재 구현은 review_requested 이벤트에서 코멘트 정보를 가져오려고 시도하고 있어 실패할 것입니다.

이 로직을 별도의 job으로 분리하고 조건부로 실행하도록 수정해야 합니다:

  notify_comment:
    if: |
      github.event_name == 'issue_comment' ||
      github.event_name == 'pull_request_review_comment'
    runs-on: ubuntu-latest
    steps:
      - name: Send to Slack
        uses: slackapi/[email protected]
        with:
          channel-id: ${{ secrets.PR_NOTI_CHANNEL }}
          payload: |
            {
              "text": "PR 코멘트 알림",
              "blocks": [
                {
                  "type": "section",
                  "text": {
                    "type": "mrkdwn",
                    "text": "| *작성자*: @${{ github.event.comment.user.login }}\n| *코멘트 내용*: _${{ github.event.comment.body }}_\n| *관련 PR*: <${{ github.event.issue.pull_request.html_url || github.event.pull_request.html_url }}|${{ github.event.issue.title || github.event.pull_request.title }}>"
                  }
                }
              ]
            }

🧹 Nitpick comments (1)

.github/workflows/pr-reviewer-noti.yml (1)

34-45: Slack 알림 포맷을 개선하면 좋겠습니다

PR에 대한 더 많은 정보를 제공하면 리뷰어들이 더 효율적으로 작업할 수 있습니다.

다음과 같이 수정해보세요:

             {
-                "text": "pr review request",
+                "text": "PR 리뷰 요청",
                 "blocks": [
                     {
                         "type": "section",
                         "text": {
                             "type": "mrkdwn",
-                            "text": "리뷰어로 할당되었습니다.\n • 제목: ${{ github.event.pull_request.title }}\n • 리뷰어: ${{ steps.reviewers.outputs.result }}\n • 링크: <${{ github.event.pull_request.html_url }}|리뷰하러 가기>"
+                            "text": "리뷰어로 할당되었습니다.\n • 제목: ${{ github.event.pull_request.title }}\n • 작성자: @${{ github.event.pull_request.user.login }}\n • 리뷰어: ${{ steps.reviewers.outputs.result }}\n • 변경사항: ${{ github.event.pull_request.changed_files }}개 파일 (+${{ github.event.pull_request.additions }}, -${{ github.event.pull_request.deletions }})\n • 링크: <${{ github.event.pull_request.html_url }}|리뷰하러 가기>"
                         }
                     }
                 ]
             }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 391d49e and 4d026cc.

📒 Files selected for processing (1)

• .github/workflows/pr-reviewer-noti.yml (1 hunks)

🧰 Additional context used

🪛 actionlint (1.7.4)

.github/workflows/pr-reviewer-noti.yml

11-11: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

---

15-15: the runner of "actions/github-script@v6" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

🔇 Additional comments (1)

.github/workflows/pr-reviewer-noti.yml (1)

18-25: ⚠️ Potential issue

리뷰어 목록 처리 로직을 개선해야 합니다

다음과 같은 문제점들이 있습니다:

1. JSON 파일 경로가 잘못되었습니다 (reviewers.json → reviewer.json)
2. 매핑되지 않은 사용자에 대한 처리가 불충분합니다

다음과 같이 수정하세요:

-            const workers = JSON.parse(fs.readFileSync('.github/workflows/reviewers.json'));
+            const workers = JSON.parse(fs.readFileSync('.github/workflows/reviewer.json'));
             const mention = context.payload.pull_request.requested_reviewers.map((user) => {
                 const login = user.login;
                 const mappedValue = workers[login];
-                return mappedValue ? `<@${mappedValue}>` : `No mapping found for ${login}`;
+                if (!mappedValue) {
+                    core.warning(`Slack 매핑을 찾을 수 없는 사용자: ${login}`);
+                    return `@${login}`;
+                }
+                return `<@${mappedValue}>`;
             });

Likely invalid or redundant comment.

[coderabbitai]

🛠️ Refactor suggestion

액션 버전을 최신으로 업데이트하세요

보안 및 성능 향상을 위해 최신 버전의 액션을 사용하는 것이 좋습니다.

-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7

Also applies to: 15-15

🧰 Tools

🪛 actionlint (1.7.4)

11-11: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

[kongnayeon]

요것만 한 번 확인해 주셔요!

[coderabbitai]

@kongnayeon 해당 버전 업데이트(actions/checkout@v4, actions/github-script@v7)으로 보안과 성능이 개선되니 적용하시면 좋을 것 같습니다. 추가 궁금한 사항 있으시면 언제든 말씀 부탁드립니다!

[kongnayeon]

슬랙 알림 잘 오네요! 너무 고생하셨습니다~